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

Enable audio interactions on the audio track component #1593

Merged
merged 65 commits into from
Sep 2, 2022

Conversation

dhruvkb
Copy link
Member

@dhruvkb dhruvkb commented Jul 29, 2022

Fixes

Fixes #1297 by @sarayourfriend

Description

This PR builds upon work done by @sarayourfriend. It enables audio track controls using the keyboard when the audio track is focused and makes the subcomponents non-focusable to provide accessible navigation in the search results.

Testing Instructions

  1. Check out the PR and run the dev server.
  2. Search for any given term and switch to the audio-only results.
  3. Navigate using the Tab key. The focus should move from one result track to the next and not go inside the component.
  4. Manipulate playback by seeking (with arrows and ) and toggling (with the Space) key.
  5. Try to access the same functionality with the mouse by clicking the buttons and dragging the seekbar etc. Existing functionality should continue to work.

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.

@github-actions
Copy link

github-actions bot commented Jul 29, 2022

Storybook and Tailwind configuration previews: Ready

Storybook: https://wordpress.github.io/openverse-frontend/_preview/1593
Tailwind: https://wordpress.github.io/openverse-frontend/_preview/1593/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: a11y Concerns related to the project's accessibility ✨ goal: improvement Improvement to an existing user-facing feature 🟨 priority: medium Not blocking but should be addressed soon labels Jul 29, 2022
@github-actions
Copy link

github-actions bot commented Jul 29, 2022

Size Change: +6.72 kB (+1%)

Total Size: 778 kB

Filename Size Change
./.nuxt/dist/client/234.js 0 B -273 B (removed) 🏆
./.nuxt/dist/client/234.modern.js 0 B -277 B (removed) 🏆
./.nuxt/dist/client/235.js 0 B -1.85 kB (removed) 🏆
./.nuxt/dist/client/app.js 110 kB -496 B (0%)
./.nuxt/dist/client/app.modern.js 102 kB -407 B (0%)
./.nuxt/dist/client/commons/app.js 88.1 kB +265 B (0%)
./.nuxt/dist/client/commons/app.modern.js 77 kB +328 B (0%)
./.nuxt/dist/client/components/v-all-results-grid.js 2.71 kB -1.43 kB (-35%) 🎉
./.nuxt/dist/client/components/v-all-results-grid.modern.js 2.68 kB -1.33 kB (-33%) 🎉
./.nuxt/dist/client/components/v-audio-cell.js 357 B +13 B (+4%)
./.nuxt/dist/client/components/v-audio-cell.modern.js 361 B +12 B (+3%)
./.nuxt/dist/client/components/v-audio-track.js 4.99 kB +435 B (+10%) ⚠️
./.nuxt/dist/client/components/v-audio-track.modern.js 4.93 kB +422 B (+9%) 🔍
./.nuxt/dist/client/components/v-box-layout.js 1.2 kB +10 B (+1%)
./.nuxt/dist/client/components/v-box-layout.modern.js 1.2 kB +12 B (+1%)
./.nuxt/dist/client/components/v-copy-license/components/v-error-image/components/v-media-reuse/components/v-search-grid/09090664.js 9.36 kB +117 B (+1%)
./.nuxt/dist/client/components/v-copy-license/components/v-error-image/components/v-media-reuse/components/v-search-grid/09090664.modern.js 9.34 kB +114 B (+1%)
./.nuxt/dist/client/components/v-full-layout.js 1.48 kB -72 B (-5%)
./.nuxt/dist/client/components/v-full-layout.modern.js 1.48 kB -74 B (-5%)
./.nuxt/dist/client/components/v-grid-skeleton.modern.js 1.61 kB -13 B (-1%)
./.nuxt/dist/client/components/v-row-layout.js 1.68 kB -43 B (-2%)
./.nuxt/dist/client/components/v-row-layout.modern.js 1.69 kB -40 B (-2%)
./.nuxt/dist/client/components/v-snackbar.js 1.17 kB +193 B (+20%) 🚨
./.nuxt/dist/client/components/v-snackbar.modern.js 1.18 kB +195 B (+20%) 🚨
./.nuxt/dist/client/components/v-sources-table.js 14.7 kB +290 B (+2%)
./.nuxt/dist/client/components/v-sources-table.modern.js 14.7 kB +293 B (+2%)
./.nuxt/dist/client/pages/search/audio.js 1.49 kB -1.38 kB (-48%) 🎉
./.nuxt/dist/client/pages/search/audio.modern.js 1.39 kB -1.36 kB (-49%) 🎉
./.nuxt/dist/client/pages/search/index.js 3.18 kB +2.37 kB (+290%) 🆘
./.nuxt/dist/client/pages/search/index.modern.js 3.07 kB +2.34 kB (+320%) 🆘
./.nuxt/dist/client/runtime.js 2.67 kB -28 B (-1%)
./.nuxt/dist/client/runtime.modern.js 2.68 kB -29 B (-1%)
./.nuxt/dist/client/vendors/app.modern.js 47.2 kB +21 B (0%)
./.nuxt/dist/client/224.js 272 B +272 B (new file) 🆕
./.nuxt/dist/client/224.modern.js 276 B +276 B (new file) 🆕
./.nuxt/dist/client/225.js 1.85 kB +1.85 kB (new file) 🆕
./.nuxt/dist/client/components/v-all-results-grid/pages/search/audio/pages/search/index.js 3.03 kB +3.03 kB (new file) 🆕
./.nuxt/dist/client/components/v-all-results-grid/pages/search/audio/pages/search/index.modern.js 2.93 kB +2.93 kB (new file) 🆕
ℹ️ View Unchanged
Filename Size Change
./.nuxt/dist/client/components/loading-icon.js 747 B +1 B (0%)
./.nuxt/dist/client/components/loading-icon.modern.js 751 B 0 B
./.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-audio-details.js 1.66 kB 0 B
./.nuxt/dist/client/components/v-audio-details.modern.js 1.65 kB -1 B (0%)
./.nuxt/dist/client/components/v-audio-track-skeleton.js 1.01 kB +1 B (0%)
./.nuxt/dist/client/components/v-audio-track-skeleton.modern.js 1.01 kB -1 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 574 B -1 B (0%)
./.nuxt/dist/client/components/v-bone.js 686 B +1 B (0%)
./.nuxt/dist/client/components/v-bone.modern.js 691 B +1 B (0%)
./.nuxt/dist/client/components/v-content-link.js 1.06 kB -4 B (0%)
./.nuxt/dist/client/components/v-content-link.modern.js 1.04 kB 0 B
./.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 765 B +2 B (0%)
./.nuxt/dist/client/components/v-content-report-button.modern.js 771 B -2 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 -1 B (0%)
./.nuxt/dist/client/components/v-content-report-popover.js 4.45 kB +5 B (0%)
./.nuxt/dist/client/components/v-content-report-popover.modern.js 4.26 kB +1 B (0%)
./.nuxt/dist/client/components/v-copy-button.js 3.96 kB -4 B (0%)
./.nuxt/dist/client/components/v-copy-button.modern.js 3.98 kB +1 B (0%)
./.nuxt/dist/client/components/v-copy-license.js 2.94 kB 0 B
./.nuxt/dist/client/components/v-copy-license.modern.js 2.92 kB +5 B (0%)
./.nuxt/dist/client/components/v-dmca-notice.js 744 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 -1 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 376 B +1 B (0%)
./.nuxt/dist/client/components/v-grid-skeleton.js 1.61 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.42 kB -1 B (0%)
./.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 -2 B (0%)
./.nuxt/dist/client/components/v-image-details.modern.js 1.44 kB +1 B (0%)
./.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 -7 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 917 B -1 B (0%)
./.nuxt/dist/client/components/v-load-more.js 816 B +1 B (0%)
./.nuxt/dist/client/components/v-load-more.modern.js 713 B -1 B (0%)
./.nuxt/dist/client/components/v-media-license.js 802 B +1 B (0%)
./.nuxt/dist/client/components/v-media-license.modern.js 810 B +1 B (0%)
./.nuxt/dist/client/components/v-media-reuse.js 1.03 kB +1 B (0%)
./.nuxt/dist/client/components/v-media-reuse.modern.js 1.04 kB +1 B (0%)
./.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.92 kB +5 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 3.11 kB +3 B (0%)
./.nuxt/dist/client/components/v-meta-search-form.modern.js 3.08 kB +5 B (0%)
./.nuxt/dist/client/components/v-meta-source-list.js 2.59 kB +3 B (0%)
./.nuxt/dist/client/components/v-meta-source-list.modern.js 2.56 kB +1 B (0%)
./.nuxt/dist/client/components/v-modal.js 875 B 0 B
./.nuxt/dist/client/components/v-modal.modern.js 879 B +2 B (0%)
./.nuxt/dist/client/components/v-no-results.js 2.77 kB +4 B (0%)
./.nuxt/dist/client/components/v-no-results.modern.js 2.74 kB 0 B
./.nuxt/dist/client/components/v-radio.js 1.51 kB +5 B (0%)
./.nuxt/dist/client/components/v-radio.modern.js 1.47 kB -3 B (0%)
./.nuxt/dist/client/components/v-related-audio.js 1.23 kB +2 B (0%)
./.nuxt/dist/client/components/v-related-audio.modern.js 1.24 kB 0 B
./.nuxt/dist/client/components/v-related-images.js 3.14 kB -1 B (0%)
./.nuxt/dist/client/components/v-related-images.modern.js 3.02 kB -5 B (0%)
./.nuxt/dist/client/components/v-report-desc-form.js 967 B +2 B (0%)
./.nuxt/dist/client/components/v-report-desc-form.modern.js 965 B +1 B (0%)
./.nuxt/dist/client/components/v-scroll-button.js 804 B 0 B
./.nuxt/dist/client/components/v-scroll-button.modern.js 810 B +1 B (0%)
./.nuxt/dist/client/components/v-search-grid.js 5.46 kB +1 B (0%)
./.nuxt/dist/client/components/v-search-grid.modern.js 5.41 kB +6 B (0%)
./.nuxt/dist/client/components/v-search-results-title.js 672 B -1 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 821 B +2 B (0%)
./.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 994 B +3 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 +1 B (0%)
./.nuxt/dist/client/components/v-skip-to-content-container.modern.js 893 B +2 B (0%)
./.nuxt/dist/client/components/v-tab-panel.js 687 B -2 B (0%)
./.nuxt/dist/client/components/v-tab-panel.modern.js 683 B 0 B
./.nuxt/dist/client/components/v-tab.js 1.73 kB +1 B (0%)
./.nuxt/dist/client/components/v-tab.modern.js 1.71 kB +3 B (0%)
./.nuxt/dist/client/components/v-tabs.js 780 B +1 B (0%)
./.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 302 B 0 B
./.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.41 kB -5 B (0%)
./.nuxt/dist/client/pages/audio/_id.modern.js 6.27 kB +7 B (0%)
./.nuxt/dist/client/pages/feedback.js 3.23 kB -1 B (0%)
./.nuxt/dist/client/pages/feedback.modern.js 3.21 kB +2 B (0%)
./.nuxt/dist/client/pages/image/_id.js 7.05 kB -1 B (0%)
./.nuxt/dist/client/pages/image/_id.modern.js 6.83 kB +5 B (0%)
./.nuxt/dist/client/pages/index.js 5.09 kB -2 B (0%)
./.nuxt/dist/client/pages/index.modern.js 4.97 kB +4 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 0 B
./.nuxt/dist/client/pages/preferences.js 1.27 kB -2 B (0%)
./.nuxt/dist/client/pages/preferences.modern.js 1.27 kB -1 B (0%)
./.nuxt/dist/client/pages/search-help.js 1.55 kB 0 B
./.nuxt/dist/client/pages/search-help.modern.js 1.55 kB +2 B (0%)
./.nuxt/dist/client/pages/search.js 2.72 kB -2 B (0%)
./.nuxt/dist/client/pages/search.modern.js 2.56 kB -2 B (0%)
./.nuxt/dist/client/pages/search/image.js 2.96 kB -2 B (0%)
./.nuxt/dist/client/pages/search/image.modern.js 2.82 kB -9 B (0%)
./.nuxt/dist/client/pages/search/model-3d.js 242 B -1 B (0%)
./.nuxt/dist/client/pages/search/model-3d.modern.js 246 B 0 B
./.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 239 B 0 B
./.nuxt/dist/client/pages/search/video.modern.js 243 B -1 B (0%)
./.nuxt/dist/client/pages/sources.js 1.44 kB +3 B (0%)
./.nuxt/dist/client/pages/sources.modern.js 1.45 kB +1 B (0%)
./.nuxt/dist/client/vendors/app.js 47.8 kB +1 B (0%)

compressed-size-action

src/locales/en.json Outdated Show resolved Hide resolved
@dhruvkb dhruvkb marked this pull request as ready for review August 1, 2022 08:50
@dhruvkb dhruvkb requested a review from a team as a code owner August 1, 2022 08:50
@dhruvkb dhruvkb requested review from krysal and obulat August 1, 2022 08:50
Copy link

@fcoveram fcoveram left a comment

Choose a reason for hiding this comment

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

The interaction feels great and smooth. Excellent 🌟

Although I am still seeing the following:

  • The snackbar has a left and right padding of 32px instead of 24px.
  • I am still seeing the "JetBrains Mono" font for the keyboard action words.
  • On smaller breakpoints
    • Snackbar message is not visible.
    • The audio component's focus ring is bigger than the mockups due to padding values.

@dhruvkb dhruvkb force-pushed the add/audio-track-composite-layout branch from 861fa06 to 72c81d4 Compare September 1, 2022 16:08
@dhruvkb dhruvkb requested review from fcoveram and obulat September 1, 2022 19:51
@dhruvkb
Copy link
Member Author

dhruvkb commented Sep 1, 2022

The last Playwright failure (2 failing tests) is from a regression on main, so I will not be attempting to fix that in this PR.

@obulat
Copy link
Contributor

obulat commented Sep 2, 2022

The last Playwright failure (2 failing tests) is from a regression on main, so I will not be attempting to fix that in this PR.

I've disabled them by adding .skip in #1646, and opened an issue to fix and re-enable them.
The lock file also needs updating.

@zackkrida zackkrida dismissed fcoveram’s stale review September 2, 2022 18:31

Requested changes were made

@zackkrida zackkrida merged commit 56d8f87 into main Sep 2, 2022
@zackkrida zackkrida deleted the add/audio-track-composite-layout branch September 2, 2022 18:31
github-actions bot pushed a commit that referenced this pull request Sep 2, 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: improvement Improvement to an existing user-facing feature 🟨 priority: medium Not blocking but should be addressed soon
Projects
None yet
7 participants