Summary

Add a JavaScript hook for extending the File Attachment thumbnail container UI.

Review Request #12951 — Created April 19, 2023 and submitted May 23, 2023, 12:36 p.m.

Information

Owner

maubin

Repository

Review Board

Branch

release-6.x

Bugs

Depends On

Reviewers

Groups

reviewboard

People

Description

This adds a JavaScript hook for extending the File Attachment thumbnail
container UI. The hook can be used to display additional content on
file attachment thumbnails and in the file attachment actions menu.

This also adds a method to the File Attachment thumbnail view that allows
callers to add an action to the file attachment actions menu.

Testing Done


Ran JS unit tests.
Ran unit tests.
Manually tested with the new "Download as PDF" action that's being added in

  in Power Pack.
Manually tested with a simple extension and view, the one in the example

  in the docs.
Built the docs and made sure they look ok.

Commits

Summary	ID
Add a JavaScript hook for extending the File Attachment thumbnail UI.	6f449b1cf964645cc794bcf7207e5da520f664b7

Issues

Description	From	Last Updated
Missing semicolon. Column: 11 Error code: W033	reviewbot	April 19, 2023, 2:48 p.m.
Missing semicolon. Column: 12 Error code: W033	reviewbot	April 19, 2023, 2:48 p.m.
Missing semicolon. Column: 34 Error code: W033	reviewbot	April 19, 2023, 2:48 p.m.
line too long (87 > 79 characters) Column: 80 Error code: E501	reviewbot	April 19, 2023, 2:48 p.m.
I think it would be nicer to use a template literal here instead of +	david	May 5, 2023, 2:24 p.m.
Let's call this $appendItem. It would also be nicer to use a template literal here instead of +	david	May 5, 2023, 2:27 p.m.
line too long (87 > 79 characters) Column: 80 Error code: E501	reviewbot	April 19, 2023, 2:49 p.m.
'$appendItem' is defined but never used. Column: 15 Error code: W098	reviewbot	May 5, 2023, 5:03 p.m.
line too long (87 > 79 characters) Column: 80 Error code: E501	reviewbot	May 5, 2023, 5:02 p.m.
The ==== lines should be the same width as the name	david	May 10, 2023, 9:48 a.m.
Let's sort these alphabetically.	david	May 10, 2023, 9:49 a.m.
Sort alphabetically.	david	May 10, 2023, 9:49 a.m.
Sort alphabetically.	david	May 10, 2023, 9:54 a.m.
Sort alphabetically.	david	May 10, 2023, 9:55 a.m.
line too long (87 > 79 characters) Column: 80 Error code: E501	reviewbot	May 5, 2023, 5:05 p.m.
line too long (87 > 79 characters) Column: 80 Error code: E501	reviewbot	May 11, 2023, 3:21 p.m.

flake8 failed.

JSHint failed.

flake8

reviewboard/staticbundles.py (Diff revision 1)
The issue has been dropped. Show all issues
```
line too long (87 > 79 characters)

Column: 80
Error code: E501
```

JSHint

reviewboard/static/rb/js/views/fileAttachmentThumbnailView.es6.js (Diff revision 1)
The issue has been resolved. Show all issues
```
Missing semicolon.

Column: 11
Error code: W033
```
reviewboard/static/rb/js/views/fileAttachmentThumbnailView.es6.js (Diff revision 1)
The issue has been resolved. Show all issues
```
Missing semicolon.

Column: 12
Error code: W033
```
reviewboard/static/rb/js/views/fileAttachmentThumbnailView.es6.js (Diff revision 1)
The issue has been resolved. Show all issues
```
Missing semicolon.

Column: 34
Error code: W033
```

Change Summary:

Added some missing semicolons.

Commits:

	Summary	ID
	Add a JavaScript hook for extending the File Attachment thumbnail UI.	125d1de81d3f009bd96ff33d557faec2d83e7ab1
	Add a JavaScript hook for extending the File Attachment thumbnail UI.	76c0ca916355428e4bd5e055520acb99c835f664

Diff:

Revision 2 (+676 -2)

Show changes

	docs/manual/extending/index.rst
	docs/manual/extending/extensions/js-hooks/file-attachment-thumbnail-container-hook.rst
	docs/manual/extending/extensions/js-hooks/index.rst
	reviewboard/staticbundles.py
	reviewboard/static/rb/css/pages/reviews.less
	reviewboard/static/rb/js/extensions/models/fileAttachmentThumbnailContainerHookModel.es6.js
	reviewboard/static/rb/js/views/fileAttachmentThumbnailView.es6.js
	reviewboard/static/rb/js/views/tests/fileAttachmentThumbnailViewTests.es6.js

Checks run (1 failed, 1 succeeded)

flake8 failed.

JSHint passed.

flake8

reviewboard/staticbundles.py (Diff revision 2)
The issue has been dropped. Show all issues
```
line too long (87 > 79 characters)

Column: 80
Error code: E501
```

reviewboard/static/rb/js/views/fileAttachmentThumbnailView.es6.js (Diff revision 2)
The issue has been resolved. Show all issues
```
I think it would be nicer to use a template literal here instead of +
```
reviewboard/static/rb/js/views/fileAttachmentThumbnailView.es6.js (Diff revision 2)
The issue has been resolved. Show all issues
```
Let's call this $appendItem. It would also be nicer to use a template literal here instead of +
```

Commits:

	Summary	ID
	Add a JavaScript hook for extending the File Attachment thumbnail UI.	76c0ca916355428e4bd5e055520acb99c835f664
	Add a JavaScript hook for extending the File Attachment thumbnail UI.	4f098d5199967e715297e5abe70bb0ac4891f2d6

Diff:

Revision 3 (+678 -2)

Show changes

	docs/manual/extending/index.rst
	docs/manual/extending/extensions/js-hooks/file-attachment-thumbnail-container-hook.rst
	docs/manual/extending/extensions/js-hooks/index.rst
	reviewboard/staticbundles.py
	reviewboard/static/rb/css/pages/reviews.less
	reviewboard/static/rb/js/extensions/models/fileAttachmentThumbnailContainerHookModel.es6.js
	reviewboard/static/rb/js/views/fileAttachmentThumbnailView.es6.js
	reviewboard/static/rb/js/views/tests/fileAttachmentThumbnailViewTests.es6.js

Checks run (2 failed)

flake8 failed.

JSHint failed.

flake8

reviewboard/staticbundles.py (Diff revision 3)
The issue has been dropped. Show all issues
```
line too long (87 > 79 characters)

Column: 80
Error code: E501
```

JSHint

reviewboard/static/rb/js/views/fileAttachmentThumbnailView.es6.js (Diff revision 3)
The issue has been resolved. Show all issues
```
'$appendItem' is defined but never used.

Column: 15
Error code: W098
```

Commits:

	Summary	ID
	Add a JavaScript hook for extending the File Attachment thumbnail UI.	4f098d5199967e715297e5abe70bb0ac4891f2d6
	Add a JavaScript hook for extending the File Attachment thumbnail UI.	ed0688ed38ca41b6429c57ead4bafb86f587f4a3

Diff:

Revision 4 (+678 -2)

Show changes

	docs/manual/extending/index.rst
	docs/manual/extending/extensions/js-hooks/file-attachment-thumbnail-container-hook.rst
	docs/manual/extending/extensions/js-hooks/index.rst
	reviewboard/staticbundles.py
	reviewboard/static/rb/css/pages/reviews.less
	reviewboard/static/rb/js/extensions/models/fileAttachmentThumbnailContainerHookModel.es6.js
	reviewboard/static/rb/js/views/fileAttachmentThumbnailView.es6.js
	reviewboard/static/rb/js/views/tests/fileAttachmentThumbnailViewTests.es6.js

Checks run (1 failed, 1 succeeded)

flake8 failed.

JSHint passed.

flake8

reviewboard/staticbundles.py (Diff revision 4)
The issue has been dropped. Show all issues
```
line too long (87 > 79 characters)

Column: 80
Error code: E501
```

docs/manual/extending/extensions/js-hooks/file-attachment-thumbnail-container-hook.rst (Diff revision 4)

The issue has been resolved. Show all issues

The ==== lines should be the same width as the name

reviewboard/static/rb/js/views/fileAttachmentThumbnailView.es6.js (Diff revision 4)
The issue has been resolved. Show all issues
```
Let's sort these alphabetically.
```
reviewboard/static/rb/js/views/fileAttachmentThumbnailView.es6.js (Diff revision 4)
The issue has been resolved. Show all issues
```
Sort alphabetically.
```

reviewboard/static/rb/js/views/tests/fileAttachmentThumbnailViewTests.es6.js (Diff revision 4)

The issue has been resolved. Show all issues

Sort alphabetically.

reviewboard/static/rb/js/views/tests/fileAttachmentThumbnailViewTests.es6.js (Diff revision 4)

The issue has been resolved. Show all issues

Sort alphabetically.

Commits:

	Summary	ID
	Add a JavaScript hook for extending the File Attachment thumbnail UI.	ed0688ed38ca41b6429c57ead4bafb86f587f4a3
	Add a JavaScript hook for extending the File Attachment thumbnail UI.	6f449b1cf964645cc794bcf7207e5da520f664b7

Diff:

Revision 5 (+700 -22)

Show changes

	docs/manual/extending/index.rst
	docs/manual/extending/extensions/js-hooks/file-attachment-thumbnail-container-hook.rst
	docs/manual/extending/extensions/js-hooks/index.rst
	reviewboard/staticbundles.py
	reviewboard/static/rb/css/pages/reviews.less
	reviewboard/static/rb/js/extensions/models/fileAttachmentThumbnailContainerHookModel.es6.js
	reviewboard/static/rb/js/views/fileAttachmentThumbnailView.es6.js
	reviewboard/static/rb/js/views/tests/fileAttachmentThumbnailViewTests.es6.js

Checks run (1 failed, 1 succeeded)

flake8 failed.

JSHint passed.

flake8

reviewboard/staticbundles.py (Diff revision 5)
The issue has been dropped. Show all issues
```
line too long (87 > 79 characters)

Column: 80
Error code: E501
```

Ship it!

```
Ship It!
```

Status: Closed (submitted)

Change Summary:

Pushed to release-6.x (44e44e7)