Skip to content
This repository has been archived by the owner on Feb 22, 2023. It is now read-only.

Fix popover not closing on Escape or click outside #2036

Merged
merged 2 commits into from
Dec 11, 2022

Conversation

obulat
Copy link
Contributor

@obulat obulat commented Dec 8, 2022

Fixes

Fixes #2033 by @zackkrida

Description

The change that moved the focus trap from the VModal component into the useDialog composable failed to account for the fact that Popovers also use it, and don't need a focus trap.

This PR only activates/deactivates the focus trap if the trapFocus prop is set to true, and sets trapFocus to false for VPopover component.

It also adds an e2e test for closing the popover on click outside and pressing Escape to the homepage e2e test (that's the simplest place where we can open a popover).

Testing Instructions

Try running the app on desktop. Open the popovers (content switcher on the homepage, pages menu or content switcher in the header) and check that pressing Escape or clicking outside closes them.

Checklist

  • My pull request has a descriptive title (not a vague title like Update index.md).
  • My pull request targets the default branch of the repository (main) or a parent feature branch.
  • My commit messages follow best practices.
  • My code follows the established code style of the repository.
  • I added or updated tests for the changes I made (if applicable).
  • I added or updated documentation (if applicable).
  • I tried running the project locally and verified that there are no visible errors.

Developer Certificate of Origin

Developer Certificate of Origin
Developer Certificate of Origin
Version 1.1

Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
1 Letterman Drive
Suite D4700
San Francisco, CA, 94129

Everyone is permitted to copy and distribute verbatim copies of this
license document, but changing it is not allowed.


Developer's Certificate of Origin 1.1

By making a contribution to this project, I certify that:

(a) The contribution was created in whole or in part by me and I
    have the right to submit it under the open source license
    indicated in the file; or

(b) The contribution is based upon previous work that, to the best
    of my knowledge, is covered under an appropriate open source
    license and I have the right under that license to submit that
    work with modifications, whether created in whole or in part
    by me, under the same open source license (unless I am
    permitted to submit under a different license), as indicated
    in the file; or

(c) The contribution was provided directly to me by some other
    person who certified (a), (b) or (c) and I have not modified
    it.

(d) I understand and agree that this project and the contribution
    are public and that a record of the contribution (including all
    personal information I submit with it, including my sign-off) is
    maintained indefinitely and may be redistributed consistent with
    this project or the open source license(s) involved.

@obulat obulat requested a review from a team as a code owner December 8, 2022 13:18
@obulat obulat requested review from zackkrida and dhruvkb December 8, 2022 13:18
@github-actions
Copy link

github-actions bot commented Dec 8, 2022

Storybook and Tailwind configuration previews: Ready

Storybook: https://wordpress.github.io/openverse-frontend/_preview/2036
Tailwind: https://wordpress.github.io/openverse-frontend/_preview/2036/tailwind

Please note that GitHub pages takes a little time to deploy newly pushed code, if the links above don't work or you see old versions, wait 5 minutes and try again.

You can check the GitHub pages deployment action list to see the current status of the deployments.

@obulat obulat changed the title Fix/focus trap on dialog only Fix popover not closing on Escape or click outside Dec 8, 2022
@openverse-bot openverse-bot added ♿️ aspect: a11y Concerns related to the project's accessibility 🛠 goal: fix Bug fix 🟧 priority: high Stalls work on the project or its dependents labels Dec 8, 2022
@github-actions
Copy link

github-actions bot commented Dec 8, 2022

Size Change: -7.11 kB (-1%)

Total Size: 852 kB

Filename Size Change
./.nuxt/dist/client/184.js 0 B -273 B (removed) 🏆
./.nuxt/dist/client/184.modern.js 0 B -277 B (removed) 🏆
./.nuxt/dist/client/185.js 0 B -1.85 kB (removed) 🏆
./.nuxt/dist/client/app.js 142 kB -3.36 kB (-2%)
./.nuxt/dist/client/app.modern.js 113 kB -3.45 kB (-3%)
./.nuxt/dist/client/runtime.js 2.31 kB -143 B (-6%)
./.nuxt/dist/client/runtime.modern.js 2.32 kB -139 B (-6%)
./.nuxt/dist/client/157.js 273 B +273 B (new file) 🆕
./.nuxt/dist/client/157.modern.js 277 B +277 B (new file) 🆕
./.nuxt/dist/client/158.js 1.85 kB +1.85 kB (new file) 🆕
ℹ️ View Unchanged
Filename Size Change
./.nuxt/dist/client/commons/app.js 86.7 kB 0 B
./.nuxt/dist/client/commons/app.modern.js 77.5 kB 0 B
./.nuxt/dist/client/components/loading-icon.js 746 B 0 B
./.nuxt/dist/client/components/loading-icon.modern.js 750 B 0 B
./.nuxt/dist/client/components/table-sort-icon.js 508 B 0 B
./.nuxt/dist/client/components/table-sort-icon.modern.js 513 B 0 B
./.nuxt/dist/client/components/v-all-results-grid.js 7.48 kB 0 B
./.nuxt/dist/client/components/v-all-results-grid.modern.js 5.02 kB 0 B
./.nuxt/dist/client/components/v-audio-cell.js 356 B 0 B
./.nuxt/dist/client/components/v-audio-cell.modern.js 360 B 0 B
./.nuxt/dist/client/components/v-audio-details.js 2.53 kB 0 B
./.nuxt/dist/client/components/v-audio-details.modern.js 1.78 kB 0 B
./.nuxt/dist/client/components/v-audio-track-skeleton.js 1.01 kB 0 B
./.nuxt/dist/client/components/v-audio-track-skeleton.modern.js 1.01 kB 0 B
./.nuxt/dist/client/components/v-audio-track.js 5.22 kB 0 B
./.nuxt/dist/client/components/v-audio-track.modern.js 5.16 kB 0 B
./.nuxt/dist/client/components/v-back-to-search-results-link.js 539 B 0 B
./.nuxt/dist/client/components/v-back-to-search-results-link.modern.js 543 B 0 B
./.nuxt/dist/client/components/v-bone.js 684 B 0 B
./.nuxt/dist/client/components/v-bone.modern.js 689 B 0 B
./.nuxt/dist/client/components/v-box-layout.js 1.2 kB 0 B
./.nuxt/dist/client/components/v-box-layout.modern.js 1.2 kB 0 B
./.nuxt/dist/client/components/v-content-link.js 1.11 kB 0 B
./.nuxt/dist/client/components/v-content-link.modern.js 1.09 kB 0 B
./.nuxt/dist/client/components/v-content-page.js 467 B 0 B
./.nuxt/dist/client/components/v-content-page.modern.js 471 B 0 B
./.nuxt/dist/client/components/v-content-report-button.js 778 B 0 B
./.nuxt/dist/client/components/v-content-report-button.modern.js 783 B 0 B
./.nuxt/dist/client/components/v-content-report-form.js 6.08 kB 0 B
./.nuxt/dist/client/components/v-content-report-form.modern.js 3.57 kB 0 B
./.nuxt/dist/client/components/v-content-report-popover.js 1.22 kB 0 B
./.nuxt/dist/client/components/v-content-report-popover.modern.js 4.22 kB 0 B
./.nuxt/dist/client/components/v-copy-button.js 3.99 kB 0 B
./.nuxt/dist/client/components/v-copy-button.modern.js 4 kB 0 B
./.nuxt/dist/client/components/v-copy-license.js 1 kB 0 B
./.nuxt/dist/client/components/v-copy-license.modern.js 1 kB 0 B
./.nuxt/dist/client/components/v-copy-license/components/v-error-image/components/v-media-reuse/components/v-search-grid/09090664.js 9.86 kB 0 B
./.nuxt/dist/client/components/v-copy-license/components/v-error-image/components/v-media-reuse/components/v-search-grid/09090664.modern.js 9.83 kB 0 B
./.nuxt/dist/client/components/v-dmca-notice.js 743 B 0 B
./.nuxt/dist/client/components/v-dmca-notice.modern.js 753 B 0 B
./.nuxt/dist/client/components/v-error-image.js 1.69 kB 0 B
./.nuxt/dist/client/components/v-error-image.modern.js 1.68 kB 0 B
./.nuxt/dist/client/components/v-error-section.js 372 B 0 B
./.nuxt/dist/client/components/v-error-section.modern.js 376 B 0 B
./.nuxt/dist/client/components/v-external-search-form.js 3.09 kB 0 B
./.nuxt/dist/client/components/v-external-search-form.modern.js 3.06 kB 0 B
./.nuxt/dist/client/components/v-external-source-list.js 2.55 kB 0 B
./.nuxt/dist/client/components/v-external-source-list.modern.js 2.52 kB 0 B
./.nuxt/dist/client/components/v-full-layout.js 1.59 kB 0 B
./.nuxt/dist/client/components/v-full-layout.modern.js 1.59 kB 0 B
./.nuxt/dist/client/components/v-grid-skeleton.js 1.61 kB 0 B
./.nuxt/dist/client/components/v-grid-skeleton.modern.js 1.61 kB 0 B
./.nuxt/dist/client/components/v-image-cell-square.js 1.01 kB 0 B
./.nuxt/dist/client/components/v-image-cell-square.modern.js 1.02 kB 0 B
./.nuxt/dist/client/components/v-image-cell.js 1.43 kB 0 B
./.nuxt/dist/client/components/v-image-cell.modern.js 1.42 kB 0 B
./.nuxt/dist/client/components/v-image-details.js 2.14 kB 0 B
./.nuxt/dist/client/components/v-image-details.modern.js 1.43 kB 0 B
./.nuxt/dist/client/components/v-image-grid.js 4.88 kB 0 B
./.nuxt/dist/client/components/v-image-grid.modern.js 2.42 kB 0 B
./.nuxt/dist/client/components/v-license-tab-panel.js 522 B 0 B
./.nuxt/dist/client/components/v-license-tab-panel.modern.js 524 B 0 B
./.nuxt/dist/client/components/v-load-more.js 3.16 kB 0 B
./.nuxt/dist/client/components/v-load-more.modern.js 684 B 0 B
./.nuxt/dist/client/components/v-media-license.js 819 B 0 B
./.nuxt/dist/client/components/v-media-license.modern.js 828 B 0 B
./.nuxt/dist/client/components/v-media-reuse.js 1.62 kB 0 B
./.nuxt/dist/client/components/v-media-reuse.modern.js 1.62 kB 0 B
./.nuxt/dist/client/components/v-media-tag.js 430 B 0 B
./.nuxt/dist/client/components/v-media-tag.modern.js 434 B 0 B
./.nuxt/dist/client/components/v-no-results.js 2.75 kB 0 B
./.nuxt/dist/client/components/v-no-results.modern.js 2.72 kB 0 B
./.nuxt/dist/client/components/v-radio.js 1.51 kB 0 B
./.nuxt/dist/client/components/v-radio.modern.js 1.47 kB 0 B
./.nuxt/dist/client/components/v-related-audio.js 1.25 kB 0 B
./.nuxt/dist/client/components/v-related-audio.modern.js 1.25 kB 0 B
./.nuxt/dist/client/components/v-related-images.js 1.05 kB 0 B
./.nuxt/dist/client/components/v-related-images.modern.js 2.98 kB 0 B
./.nuxt/dist/client/components/v-report-desc-form.js 964 B 0 B
./.nuxt/dist/client/components/v-report-desc-form.modern.js 967 B 0 B
./.nuxt/dist/client/components/v-row-layout.js 1.7 kB 0 B
./.nuxt/dist/client/components/v-row-layout.modern.js 1.71 kB 0 B
./.nuxt/dist/client/components/v-scroll-button.js 813 B 0 B
./.nuxt/dist/client/components/v-scroll-button.modern.js 818 B 0 B
./.nuxt/dist/client/components/v-search-grid.js 5.43 kB 0 B
./.nuxt/dist/client/components/v-search-grid.modern.js 5.39 kB 0 B
./.nuxt/dist/client/components/v-search-results-title.js 659 B 0 B
./.nuxt/dist/client/components/v-search-results-title.modern.js 656 B 0 B
./.nuxt/dist/client/components/v-search-type-radio.js 794 B 0 B
./.nuxt/dist/client/components/v-search-type-radio.modern.js 773 B 0 B
./.nuxt/dist/client/components/v-server-timeout.js 298 B 0 B
./.nuxt/dist/client/components/v-server-timeout.modern.js 302 B -1 B (0%)
./.nuxt/dist/client/components/v-sketch-fab-viewer.js 3.37 kB 0 B
./.nuxt/dist/client/components/v-sketch-fab-viewer.modern.js 894 B 0 B
./.nuxt/dist/client/components/v-skip-to-content-container.js 888 B 0 B
./.nuxt/dist/client/components/v-skip-to-content-container.modern.js 894 B 0 B
./.nuxt/dist/client/components/v-snackbar.js 1.18 kB 0 B
./.nuxt/dist/client/components/v-snackbar.modern.js 1.19 kB 0 B
./.nuxt/dist/client/components/v-sources-table.js 16 kB 0 B
./.nuxt/dist/client/components/v-sources-table.modern.js 16 kB 0 B
./.nuxt/dist/client/components/v-warning-suppressor.js 298 B 0 B
./.nuxt/dist/client/components/v-warning-suppressor.modern.js 303 B 0 B
./.nuxt/dist/client/pages/about.js 1.51 kB 0 B
./.nuxt/dist/client/pages/about.modern.js 1.51 kB -1 B (0%)
./.nuxt/dist/client/pages/audio/_id.js 7.96 kB 0 B
./.nuxt/dist/client/pages/audio/_id.modern.js 4.79 kB 0 B
./.nuxt/dist/client/pages/external-sources.js 1.52 kB +1 B (0%)
./.nuxt/dist/client/pages/external-sources.modern.js 1.53 kB -1 B (0%)
./.nuxt/dist/client/pages/feedback.js 1.31 kB -1 B (0%)
./.nuxt/dist/client/pages/feedback.modern.js 1.31 kB -1 B (0%)
./.nuxt/dist/client/pages/image/_id.js 9.25 kB 0 B
./.nuxt/dist/client/pages/image/_id.modern.js 7.34 kB 0 B
./.nuxt/dist/client/pages/index.js 7.47 kB -2 B (0%)
./.nuxt/dist/client/pages/index.modern.js 5 kB +1 B (0%)
./.nuxt/dist/client/pages/preferences.js 1.21 kB +1 B (0%)
./.nuxt/dist/client/pages/preferences.modern.js 1.2 kB -1 B (0%)
./.nuxt/dist/client/pages/privacy.js 979 B 0 B
./.nuxt/dist/client/pages/privacy.modern.js 982 B 0 B
./.nuxt/dist/client/pages/search-help.js 1.61 kB -1 B (0%)
./.nuxt/dist/client/pages/search-help.modern.js 1.61 kB -1 B (0%)
./.nuxt/dist/client/pages/search.js 5.06 kB -1 B (0%)
./.nuxt/dist/client/pages/search.modern.js 2.56 kB 0 B
./.nuxt/dist/client/pages/search/audio.js 6.12 kB +2 B (0%)
./.nuxt/dist/client/pages/search/audio.modern.js 3.65 kB -1 B (0%)
./.nuxt/dist/client/pages/search/image.js 656 B -1 B (0%)
./.nuxt/dist/client/pages/search/image.modern.js 2.73 kB -2 B (0%)
./.nuxt/dist/client/pages/search/index.js 542 B 0 B
./.nuxt/dist/client/pages/search/index.modern.js 548 B 0 B
./.nuxt/dist/client/pages/search/model-3d.js 243 B 0 B
./.nuxt/dist/client/pages/search/model-3d.modern.js 246 B -1 B (0%)
./.nuxt/dist/client/pages/search/search-page.types.js 266 B 0 B
./.nuxt/dist/client/pages/search/search-page.types.modern.js 271 B 0 B
./.nuxt/dist/client/pages/search/video.js 240 B +1 B (0%)
./.nuxt/dist/client/pages/search/video.modern.js 244 B 0 B
./.nuxt/dist/client/pages/sources.js 1.51 kB 0 B
./.nuxt/dist/client/pages/sources.modern.js 1.51 kB -2 B (0%)
./.nuxt/dist/client/vendors/app.js 63.7 kB 0 B
./.nuxt/dist/client/vendors/app.modern.js 63.1 kB 0 B

compressed-size-action

@github-actions
Copy link

github-actions bot commented Dec 8, 2022

Playwright Failure Test Results

It looks like some of the Playwright tests failed. You can download the Playwright trace
output for both Storybook and Nuxt Playwright tests that have failed at the bottom of this
page, under the "Artifacts" section:

https://github.com/WordPress/openverse-frontend/actions/runs/3648644886

Read more about how to use this artifact here: https://github.com/WordPress/openverse-frontend/blob/main/test/playwright/README.md#debugging

Copy link
Member

@zackkrida zackkrida left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I like the implementation, the new tests are lovely as well. LGTM.

@WordPress WordPress deleted a comment from github-actions bot Dec 9, 2022
@obulat obulat merged commit c945f2f into main Dec 11, 2022
@obulat obulat deleted the fix/focus_trap_on_dialog_only branch December 11, 2022 08:59
github-actions bot pushed a commit that referenced this pull request Dec 11, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
♿️ aspect: a11y Concerns related to the project's accessibility 🛠 goal: fix Bug fix 🟧 priority: high Stalls work on the project or its dependents
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Staging: Popovers aren't closed by outside or trigger click anymore
4 participants