Annotation deletion popup (bug 1899731) #18900
Conversation
ryzokuken
force-pushed
the
popup-undo-annotation
branch
from
ebf8d04
to
ae79bee
Compare
There was a problem hiding this comment.
This will need tests in the various editors, in https://github.com/mozilla/pdf.js/tree/master/test/integration, or maybe its own new test file that tests that the toast is properly shown in the various cases.
There was a problem hiding this comment.
Is this perhaps related to https://bugzilla.mozilla.org/show_bug.cgi?id=1899731, since there seems to be no mention of that bug here?
Please note that we'll need a "full" design specification before implementing this, and given its current state the code will also require a fair amount of work here (as far as I can tell).
marco-c
changed the title
marco-c
changed the title
I added a link to the Figma specs in the bug. It should be accessible to all of you (let me know if you don't have access, and I'll get you added). |
|
@calixteman @Snuffleupagus Please wait to review until when this PR is marked as ready -- I am giving some feedback to @ryzokuken to make sure that it matches correctly what is defined in the figma doc :) |
This is a temporary commit on this branch that aims to address some of the review comments from the PR at mozilla#18900.
|
First off, thanks everyone for all the comments it's nice to have a stronger sense of direction as to where I need to take this patch. I addressed some of the comments y'all made and marked the appropriate suggestions as "resolved" although please feel free to re-raise anything. To respond to the questions:
Yes it is! Thanks @marco-c for the clarification and sharing the spec. Regarding the code, I hope the bigger pain points have either already been addressed or I'd be hacking on them shortly. |
There was a problem hiding this comment.
Based on looking at the code, I believe that there's various cases where the notification won't be closed immediately as I believe is intended when:
- Restoring the editor with Ctrl+Z (i.e. using the keyboard).
- Toggling editing-mode off.
- The entire editorLayer is being destroyed (i.e. when closing the current PDF document).
Apologies, I misunderstood your comment at first. Applied the fix that you'd ultimately suggested. I've marked a number of your comments as resolved, please take a look and let me know if I missed something from my latest commit while I work on addressing the remaining issues. Thanks again for your patience. |
|
@Snuffleupagus thanks for the last slew of suggestions especially, it taught me a lot about the code and fixed the l10n bug. The code should ideally look much more manageable now. While I make more improvements and add tests, please let me know if you have any further comments. |
There was a problem hiding this comment.
Another thing that I think should be supported is closing the undo-bar with the Esc key, and the easiest solution would be to (after implementing the comments below) also add the following code just after this existing code:
if (this.editorUndoBar?.isOpen) {
this.editorUndoBar.hide();
handled = true;
}
|
I added the ESC key dismiss thingie but note that it's not part of the Figma spec which says:
Maybe we should get the ESC key condition added there. |
Note also the other cases mentioned previously in #18900 (review), maybe those should be added to that list as well? |
|
Absolutely, I'll mention this to the UX folks. |
|
Good point, I cleaned up the class fields and simplified the constructor a bit. |
ryzokuken
force-pushed
the
popup-undo-annotation
branch
from
a4130d0
to
13d7c53
Compare
|
@Snuffleupagus @nicolo-ribaudo PTAL I fixed both issues, the first commit should now no longer have any lint errors. |
ryzokuken
force-pushed
the
popup-undo-annotation
branch
from
9beddd5
to
14c9371
Compare
|
Changed the position of the popup from the bottom to the top of the document (right below the toolbar) in order to match the latest feedback from the design systems team. |
|
/botio-linux preview |
From: Bot.io (Linux m4)ReceivedCommand cmd_preview from @calixteman received. Current queue size: 0 Live output at: http://54.241.84.105:8877/93ff346a4b7544d/output.txt |
From: Bot.io (Linux m4)SuccessFull output at http://54.241.84.105:8877/93ff346a4b7544d/output.txt Total script time: 0.96 mins Published |
|
On Windows, when the toast appears, NVDA is reading "Toolbar Undo button" which means that the description and the close button are missed: they probably needs to have some aria attributes. |
ryzokuken
force-pushed
the
popup-undo-annotation
branch
from
14c9371
to
8fb9cab
Compare
|
@calixteman fixed the ARIA issue and tested on VO, will test on NVDA tomorrow. We had to add a setTimeout for the focus in order to get VO to switch to that instead of just repeating the document title. |
|
@Snuffleupagus thanks for your comments again, I just addressed them, hopefully it should be good to go now. @calixteman I just tested the screen reader on Windows and it works as expected! |
ryzokuken
force-pushed
the
popup-undo-annotation
branch
from
8fb9cab
to
4ca3443
Compare
Move .messageBar out of .dialog into its own standalone class in order to reuse as much of it for the upcoming feature for an undo message for annotations.
When a user deletes any number of annotations, they are notified of the action by a popup message with an undo button. Besides that, this change reuses the existing messageBar CSS class from the new alt-text dialog as much as possible.
ryzokuken
force-pushed
the
popup-undo-annotation
branch
from
4ca3443
to
aad4978
Compare
|
@Snuffleupagus how does it look now? |
|
/botio-linux preview |
From: Bot.io (Linux m4)ReceivedCommand cmd_preview from @calixteman received. Current queue size: 1 Live output at: http://54.241.84.105:8877/a89f9f5cd81ab10/output.txt |
| const rect = await getRect(page, ".annotationEditorLayer"); | ||
| const data = "Hello PDF.js World !!"; | ||
| await page.mouse.click(rect.x + 100, rect.y + 100); | ||
| await page.waitForSelector(getEditorSelector(0), { |
There was a problem hiding this comment.
nit: just set a variable const editorSelector = getEditorSelector(0); and use it elsewhere in the test (the same comment applies for the other tests).
From: Bot.io (Linux m4)SuccessFull output at http://54.241.84.105:8877/a89f9f5cd81ab10/output.txt Total script time: 0.97 mins Published |
|
It's not possible to use the keyboard to "click" on the Undo-button, since tabbing to it and then pressing either Enter or Space doesn't work (the undo-bar is hidden, but the editor isn't restored). |
|
@ryzokuken could you fix the bug mentioned in #18900 (comment) ? and add a test (just for one kind of editor) to check that "clicking" on undo with the keyboard is working as expected. Thank you. |
This PR adds a simple popup/snackbar setup and wires it up for annotation removal, so when a user deletes any number of annotations, they get a message about it alongside an undo button that allows them to quickly undo the deletion.