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

Replace focus-trap-vue with Vueuse implementation #1758

Closed

Conversation

obulat
Copy link
Contributor

@obulat obulat commented Aug 30, 2022

Fixes

Fixes #1752 by @ramadanomar

Description

This PR copies VueUse integrations/useFocusTrap/component implementation to use the latest version of the upstream dependency, focus-trap.

It is clear that focus-trap-vue is not going to update the Vue-2 branch to add the fix for the linked issue. I wanted to use the useFocusTrap component from VueUse at first, but I couldn't solve the Nuxt 2 import issue, so I vendored in the UseFocusTrap component. VueUse library is using MIT license, so it should be OK. Hopefully, after we move on to Vue 3, we can use the VueUse library instead of vendoring in the implementation.

Testing Instructions

Run the app with pnpm dev, and on mobile screen, open the menu and filters modals. There should be no errors/warnings regarding the initial focus node in the console, and the focus should be handled correctly. When opening the modal, the first tabbable element should be focused. When you close the modal, you should be able to tab away from the modal trigger.

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 August 30, 2022 08:43
@obulat obulat requested a review from dhruvkb August 30, 2022 08:43
@openverse-bot openverse-bot added this to Needs review in Openverse PRs Aug 30, 2022
@github-actions
Copy link

github-actions bot commented Aug 30, 2022

Storybook and Tailwind configuration previews: Ready

Storybook: https://wordpress.github.io/openverse-frontend/_preview/1758
Tailwind: https://wordpress.github.io/openverse-frontend/_preview/1758/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.

@openverse-bot openverse-bot added 💻 aspect: code Concerns the software code in the repository 🛠 goal: fix Bug fix 🟨 priority: medium Not blocking but should be addressed soon labels Aug 30, 2022
@github-actions
Copy link

github-actions bot commented Aug 30, 2022

Size Change: +983 B (0%)

Total Size: 769 kB

Filename Size Change
./.nuxt/dist/client/app.js 110 kB +173 B (0%)
./.nuxt/dist/client/app.modern.js 103 kB +153 B (0%)
./.nuxt/dist/client/pages/image/_id.modern.js 6.74 kB -11 B (0%)
./.nuxt/dist/client/vendors/app.js 48.1 kB +357 B (+1%)
./.nuxt/dist/client/vendors/app.modern.js 47.5 kB +326 B (+1%)
ℹ️ View Unchanged
Filename Size Change
./.nuxt/dist/client/235.js 273 B 0 B
./.nuxt/dist/client/235.modern.js 278 B +1 B (0%)
./.nuxt/dist/client/236.js 1.85 kB 0 B
./.nuxt/dist/client/commons/app.js 87.8 kB -3 B (0%)
./.nuxt/dist/client/commons/app.modern.js 76.7 kB -7 B (0%)
./.nuxt/dist/client/components/loading-icon.js 746 B 0 B
./.nuxt/dist/client/components/loading-icon.modern.js 749 B -2 B (0%)
./.nuxt/dist/client/components/table-sort-icon.js 508 B 0 B
./.nuxt/dist/client/components/table-sort-icon.modern.js 512 B 0 B
./.nuxt/dist/client/components/v-all-results-grid.js 4.13 kB -3 B (0%)
./.nuxt/dist/client/components/v-all-results-grid.modern.js 4.01 kB -2 B (0%)
./.nuxt/dist/client/components/v-audio-cell.js 344 B 0 B
./.nuxt/dist/client/components/v-audio-cell.modern.js 348 B -1 B (0%)
./.nuxt/dist/client/components/v-audio-details.js 1.66 kB +2 B (0%)
./.nuxt/dist/client/components/v-audio-details.modern.js 1.65 kB +2 B (0%)
./.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.02 kB 0 B
./.nuxt/dist/client/components/v-audio-track.js 4.47 kB -3 B (0%)
./.nuxt/dist/client/components/v-audio-track.modern.js 4.42 kB -4 B (0%)
./.nuxt/dist/client/components/v-back-to-search-results-link.js 569 B -1 B (0%)
./.nuxt/dist/client/components/v-back-to-search-results-link.modern.js 575 B 0 B
./.nuxt/dist/client/components/v-bone.js 684 B -1 B (0%)
./.nuxt/dist/client/components/v-bone.modern.js 690 B 0 B
./.nuxt/dist/client/components/v-box-layout.js 1.2 kB +1 B (0%)
./.nuxt/dist/client/components/v-box-layout.modern.js 1.19 kB 0 B
./.nuxt/dist/client/components/v-content-link.js 1.06 kB -3 B (0%)
./.nuxt/dist/client/components/v-content-link.modern.js 1.04 kB +1 B (0%)
./.nuxt/dist/client/components/v-content-page.js 466 B -1 B (0%)
./.nuxt/dist/client/components/v-content-page.modern.js 470 B -1 B (0%)
./.nuxt/dist/client/components/v-content-report-button.js 766 B +3 B (0%)
./.nuxt/dist/client/components/v-content-report-button.modern.js 774 B +1 B (0%)
./.nuxt/dist/client/components/v-content-report-form.js 3.78 kB +3 B (0%)
./.nuxt/dist/client/components/v-content-report-form.modern.js 3.59 kB -2 B (0%)
./.nuxt/dist/client/components/v-content-report-popover.js 4.45 kB -1 B (0%)
./.nuxt/dist/client/components/v-content-report-popover.modern.js 4.26 kB -2 B (0%)
./.nuxt/dist/client/components/v-copy-button.js 3.97 kB +1 B (0%)
./.nuxt/dist/client/components/v-copy-button.modern.js 3.98 kB +2 B (0%)
./.nuxt/dist/client/components/v-copy-license.js 2.94 kB +2 B (0%)
./.nuxt/dist/client/components/v-copy-license.modern.js 2.91 kB +3 B (0%)
./.nuxt/dist/client/components/v-copy-license/components/v-error-image/components/v-media-reuse/components/v-search-grid/09090664.js 9.4 kB +1 B (0%)
./.nuxt/dist/client/components/v-copy-license/components/v-error-image/components/v-media-reuse/components/v-search-grid/09090664.modern.js 9.38 kB 0 B
./.nuxt/dist/client/components/v-dmca-notice.js 742 B -1 B (0%)
./.nuxt/dist/client/components/v-dmca-notice.modern.js 753 B 0 B
./.nuxt/dist/client/components/v-error-image.js 1.69 kB -3 B (0%)
./.nuxt/dist/client/components/v-error-image.modern.js 1.68 kB -3 B (0%)
./.nuxt/dist/client/components/v-error-section.js 372 B 0 B
./.nuxt/dist/client/components/v-error-section.modern.js 375 B 0 B
./.nuxt/dist/client/components/v-full-layout.js 1.46 kB 0 B
./.nuxt/dist/client/components/v-full-layout.modern.js 1.46 kB -1 B (0%)
./.nuxt/dist/client/components/v-grid-skeleton.js 1.61 kB 0 B
./.nuxt/dist/client/components/v-grid-skeleton.modern.js 1.62 kB -1 B (0%)
./.nuxt/dist/client/components/v-image-cell-square.js 1.01 kB +1 B (0%)
./.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 1.44 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 2.57 kB 0 B
./.nuxt/dist/client/components/v-image-grid.modern.js 2.46 kB -1 B (0%)
./.nuxt/dist/client/components/v-license-tab-panel.js 923 B 0 B
./.nuxt/dist/client/components/v-license-tab-panel.modern.js 918 B 0 B
./.nuxt/dist/client/components/v-load-more.js 815 B 0 B
./.nuxt/dist/client/components/v-load-more.modern.js 716 B +1 B (0%)
./.nuxt/dist/client/components/v-media-license.js 800 B -1 B (0%)
./.nuxt/dist/client/components/v-media-license.modern.js 809 B 0 B
./.nuxt/dist/client/components/v-media-reuse.js 1.03 kB 0 B
./.nuxt/dist/client/components/v-media-reuse.modern.js 1.03 kB 0 B
./.nuxt/dist/client/components/v-media-reuse/pages/image/_id.js 2.94 kB +1 B (0%)
./.nuxt/dist/client/components/v-media-reuse/pages/image/_id.modern.js 2.91 kB +4 B (0%)
./.nuxt/dist/client/components/v-media-tag.js 429 B 0 B
./.nuxt/dist/client/components/v-media-tag.modern.js 434 B +1 B (0%)
./.nuxt/dist/client/components/v-meta-search-form.js 2.7 kB +1 B (0%)
./.nuxt/dist/client/components/v-meta-search-form.modern.js 2.66 kB 0 B
./.nuxt/dist/client/components/v-meta-source-list.js 2.06 kB +1 B (0%)
./.nuxt/dist/client/components/v-meta-source-list.modern.js 2.02 kB 0 B
./.nuxt/dist/client/components/v-modal.js 875 B 0 B
./.nuxt/dist/client/components/v-modal.modern.js 876 B 0 B
./.nuxt/dist/client/components/v-no-results.js 2.27 kB +2 B (0%)
./.nuxt/dist/client/components/v-no-results.modern.js 2.23 kB +1 B (0%)
./.nuxt/dist/client/components/v-radio.js 1.51 kB +2 B (0%)
./.nuxt/dist/client/components/v-radio.modern.js 1.47 kB 0 B
./.nuxt/dist/client/components/v-related-audio.js 1.23 kB +1 B (0%)
./.nuxt/dist/client/components/v-related-audio.modern.js 1.23 kB -4 B (0%)
./.nuxt/dist/client/components/v-related-images.js 3.13 kB -2 B (0%)
./.nuxt/dist/client/components/v-related-images.modern.js 3.03 kB +1 B (0%)
./.nuxt/dist/client/components/v-report-desc-form.js 966 B +1 B (0%)
./.nuxt/dist/client/components/v-report-desc-form.modern.js 965 B +1 B (0%)
./.nuxt/dist/client/components/v-row-layout.js 1.72 kB -1 B (0%)
./.nuxt/dist/client/components/v-row-layout.modern.js 1.73 kB 0 B
./.nuxt/dist/client/components/v-scroll-button.js 804 B 0 B
./.nuxt/dist/client/components/v-scroll-button.modern.js 809 B 0 B
./.nuxt/dist/client/components/v-search-grid.js 5.06 kB +1 B (0%)
./.nuxt/dist/client/components/v-search-grid.modern.js 4.99 kB 0 B
./.nuxt/dist/client/components/v-search-results-title.js 671 B -2 B (0%)
./.nuxt/dist/client/components/v-search-results-title.modern.js 665 B -1 B (0%)
./.nuxt/dist/client/components/v-search-type-radio.js 830 B -1 B (0%)
./.nuxt/dist/client/components/v-search-type-radio.modern.js 820 B 0 B
./.nuxt/dist/client/components/v-server-timeout.js 298 B 0 B
./.nuxt/dist/client/components/v-server-timeout.modern.js 303 B 0 B
./.nuxt/dist/client/components/v-sketch-fab-viewer.js 992 B +1 B (0%)
./.nuxt/dist/client/components/v-sketch-fab-viewer.modern.js 892 B 0 B
./.nuxt/dist/client/components/v-skip-to-content-container.js 889 B 0 B
./.nuxt/dist/client/components/v-skip-to-content-container.modern.js 893 B 0 B
./.nuxt/dist/client/components/v-snackbar.js 977 B 0 B
./.nuxt/dist/client/components/v-snackbar.modern.js 982 B -1 B (0%)
./.nuxt/dist/client/components/v-sources-table.js 14.3 kB -2 B (0%)
./.nuxt/dist/client/components/v-sources-table.modern.js 14.3 kB +1 B (0%)
./.nuxt/dist/client/components/v-tab-panel.js 689 B 0 B
./.nuxt/dist/client/components/v-tab-panel.modern.js 685 B +2 B (0%)
./.nuxt/dist/client/components/v-tab.js 1.73 kB +3 B (0%)
./.nuxt/dist/client/components/v-tab.modern.js 1.71 kB +1 B (0%)
./.nuxt/dist/client/components/v-tabs.js 779 B 0 B
./.nuxt/dist/client/components/v-tabs.modern.js 765 B -1 B (0%)
./.nuxt/dist/client/components/v-warning-suppressor.js 298 B 0 B
./.nuxt/dist/client/components/v-warning-suppressor.modern.js 303 B +1 B (0%)
./.nuxt/dist/client/pages/about.js 1.05 kB 0 B
./.nuxt/dist/client/pages/about.modern.js 1.06 kB 0 B
./.nuxt/dist/client/pages/audio/_id.js 6.42 kB -2 B (0%)
./.nuxt/dist/client/pages/audio/_id.modern.js 6.27 kB +1 B (0%)
./.nuxt/dist/client/pages/feedback.js 3.23 kB -1 B (0%)
./.nuxt/dist/client/pages/feedback.modern.js 3.2 kB +1 B (0%)
./.nuxt/dist/client/pages/image/_id.js 6.98 kB -3 B (0%)
./.nuxt/dist/client/pages/index.js 5.09 kB +1 B (0%)
./.nuxt/dist/client/pages/index.modern.js 4.97 kB +1 B (0%)
./.nuxt/dist/client/pages/meta-search.js 1.67 kB +1 B (0%)
./.nuxt/dist/client/pages/meta-search.modern.js 1.67 kB -4 B (0%)
./.nuxt/dist/client/pages/preferences.js 1.28 kB +1 B (0%)
./.nuxt/dist/client/pages/preferences.modern.js 1.27 kB 0 B
./.nuxt/dist/client/pages/search-help.js 1.54 kB -1 B (0%)
./.nuxt/dist/client/pages/search-help.modern.js 1.55 kB 0 B
./.nuxt/dist/client/pages/search.js 2.72 kB -1 B (0%)
./.nuxt/dist/client/pages/search.modern.js 2.57 kB +3 B (0%)
./.nuxt/dist/client/pages/search/audio.js 2.87 kB +2 B (0%)
./.nuxt/dist/client/pages/search/audio.modern.js 2.75 kB 0 B
./.nuxt/dist/client/pages/search/image.js 2.96 kB -3 B (0%)
./.nuxt/dist/client/pages/search/image.modern.js 2.83 kB -2 B (0%)
./.nuxt/dist/client/pages/search/index.js 815 B 0 B
./.nuxt/dist/client/pages/search/index.modern.js 732 B -1 B (0%)
./.nuxt/dist/client/pages/search/model-3d.js 242 B 0 B
./.nuxt/dist/client/pages/search/model-3d.modern.js 247 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.44 kB +1 B (0%)
./.nuxt/dist/client/pages/sources.modern.js 1.45 kB 0 B
./.nuxt/dist/client/runtime.js 2.71 kB 0 B
./.nuxt/dist/client/runtime.modern.js 2.71 kB 0 B

compressed-size-action

@obulat obulat self-assigned this Aug 30, 2022
@obulat
Copy link
Contributor Author

obulat commented Aug 30, 2022

I'm going to close this issue because there's a type mismatch in the render function:
{ ref: target } as VNodeData is a quick hack I tried, but this is incorrect. In Vue 2.7, VNodeData's ref property is an optional string, and we are assigning the Ref<HTML> to it. There's an internal type also called VNodeData that does have a ref property that can be of the Ref type, but I don't know how to import it.

@obulat obulat closed this Aug 30, 2022
Openverse PRs automation moved this from Needs review to Closed Aug 30, 2022
github-actions bot pushed a commit that referenced this pull request Aug 30, 2022
@obulat obulat deleted the fix/replace_focus-trap-vue_with_vueuse_implementation branch December 16, 2022 05:58
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
💻 aspect: code Concerns the software code in the repository 🛠 goal: fix Bug fix 🟨 priority: medium Not blocking but should be addressed soon
Projects
No open projects
Openverse PRs
  
Closed
Development

Successfully merging this pull request may close these issues.

initialFocus did not return a node
2 participants