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

Remove span from VLink #1841

Merged
merged 4 commits into from
Oct 4, 2022
Merged

Remove span from VLink #1841

merged 4 commits into from
Oct 4, 2022

Conversation

obulat
Copy link
Contributor

@obulat obulat commented Sep 20, 2022

Fixes

Fixes #1840 by @obulat

Description

This PR removes span as the fallback element that was rendered by VLink if the href prop wasn't provided.
It also adds checks for href in all components that use a dynamic href prop, and adds a wrapper to the VContentLink to make the disabled component render a div instead of an a link without an href.

Testing Instructions

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 September 20, 2022 19:42
@github-actions
Copy link

github-actions bot commented Sep 20, 2022

Storybook and Tailwind configuration previews: Ready

Storybook: https://wordpress.github.io/openverse-frontend/_preview/1841
Tailwind: https://wordpress.github.io/openverse-frontend/_preview/1841/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 ✨ goal: improvement Improvement to an existing user-facing feature 💻 aspect: code Concerns the software code in the repository 🟨 priority: medium Not blocking but should be addressed soon labels Sep 20, 2022
Comment on lines -41 to -47
<slot /><VIcon
v-if="showExternalIcon && !isInternal"
:icon-path="externalLinkIcon"
class="inline-block"
:size="4"
rtl-flip
/>
Copy link
Member

Choose a reason for hiding this comment

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

Is the removal of <VIcon/> accidental or intentional?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Only the Icon inside the span I'd removed, and NuxtLink still have it.

@github-actions
Copy link

github-actions bot commented Sep 20, 2022

Size Change: -3.68 kB (0%)

Total Size: 811 kB

Filename Size Change
./.nuxt/dist/client/230.js 0 B -272 B (removed) 🏆
./.nuxt/dist/client/230.modern.js 0 B -277 B (removed) 🏆
./.nuxt/dist/client/231.js 0 B -1.85 kB (removed) 🏆
./.nuxt/dist/client/app.js 126 kB -1.74 kB (-1%)
./.nuxt/dist/client/app.modern.js 118 kB -1.68 kB (-1%)
./.nuxt/dist/client/components/v-all-results-grid.js 2.75 kB -20 B (-1%)
./.nuxt/dist/client/components/v-all-results-grid.modern.js 2.73 kB -22 B (-1%)
./.nuxt/dist/client/components/v-content-link.js 1.11 kB -20 B (-2%)
./.nuxt/dist/client/components/v-content-link.modern.js 1.09 kB -19 B (-2%)
./.nuxt/dist/client/pages/search/index.js 2.97 kB -20 B (-1%)
./.nuxt/dist/client/pages/search/index.modern.js 2.94 kB -23 B (-1%)
./.nuxt/dist/client/runtime.js 2.63 kB -72 B (-3%)
./.nuxt/dist/client/runtime.modern.js 2.64 kB -73 B (-3%)
./.nuxt/dist/client/216.js 272 B +272 B (new file) 🆕
./.nuxt/dist/client/216.modern.js 277 B +277 B (new file) 🆕
./.nuxt/dist/client/217.js 1.85 kB +1.85 kB (new file) 🆕
ℹ️ View Unchanged
Filename Size Change
./.nuxt/dist/client/commons/app.js 88.2 kB 0 B
./.nuxt/dist/client/commons/app.modern.js 77.1 kB 0 B
./.nuxt/dist/client/components/loading-icon.js 745 B 0 B
./.nuxt/dist/client/components/loading-icon.modern.js 753 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/pages/search/audio/pages/search/index.js 3.02 kB 0 B
./.nuxt/dist/client/components/v-all-results-grid/pages/search/audio/pages/search/index.modern.js 2.92 kB 0 B
./.nuxt/dist/client/components/v-audio-cell.js 356 B 0 B
./.nuxt/dist/client/components/v-audio-cell.modern.js 361 B 0 B
./.nuxt/dist/client/components/v-audio-details.js 1.82 kB 0 B
./.nuxt/dist/client/components/v-audio-details.modern.js 1.79 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.02 kB 0 B
./.nuxt/dist/client/components/v-audio-track.js 5.11 kB 0 B
./.nuxt/dist/client/components/v-audio-track.modern.js 5.05 kB 0 B
./.nuxt/dist/client/components/v-back-to-search-results-link.js 569 B 0 B
./.nuxt/dist/client/components/v-back-to-search-results-link.modern.js 574 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-page.js 466 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 765 B 0 B
./.nuxt/dist/client/components/v-content-report-button.modern.js 773 B 0 B
./.nuxt/dist/client/components/v-content-report-form.js 3.78 kB 0 B
./.nuxt/dist/client/components/v-content-report-form.modern.js 3.58 kB 0 B
./.nuxt/dist/client/components/v-content-report-popover.js 4.45 kB 0 B
./.nuxt/dist/client/components/v-content-report-popover.modern.js 4.26 kB 0 B
./.nuxt/dist/client/components/v-content-settings-button.js 691 B 0 B
./.nuxt/dist/client/components/v-content-settings-button.modern.js 694 B -1 B (0%)
./.nuxt/dist/client/components/v-copy-button.js 3.97 kB 0 B
./.nuxt/dist/client/components/v-copy-button.modern.js 3.98 kB 0 B
./.nuxt/dist/client/components/v-copy-license.js 2.95 kB 0 B
./.nuxt/dist/client/components/v-copy-license.modern.js 2.93 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.68 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.66 kB 0 B
./.nuxt/dist/client/components/v-dmca-notice.js 749 B 0 B
./.nuxt/dist/client/components/v-dmca-notice.modern.js 749 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 375 B 0 B
./.nuxt/dist/client/components/v-full-layout.js 1.48 kB 0 B
./.nuxt/dist/client/components/v-full-layout.modern.js 1.48 kB 0 B
./.nuxt/dist/client/components/v-grid-skeleton.js 1.6 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.42 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.53 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 921 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 787 B 0 B
./.nuxt/dist/client/components/v-load-more.modern.js 685 B 0 B
./.nuxt/dist/client/components/v-media-license.js 798 B 0 B
./.nuxt/dist/client/components/v-media-license.modern.js 807 B 0 B
./.nuxt/dist/client/components/v-media-reuse.js 1.08 kB 0 B
./.nuxt/dist/client/components/v-media-reuse.modern.js 1.08 kB 0 B
./.nuxt/dist/client/components/v-media-reuse/pages/image/_id.js 2.95 kB 0 B
./.nuxt/dist/client/components/v-media-reuse/pages/image/_id.modern.js 2.93 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-meta-search-form.js 3.1 kB 0 B
./.nuxt/dist/client/components/v-meta-search-form.modern.js 3.07 kB 0 B
./.nuxt/dist/client/components/v-meta-source-list.js 2.56 kB 0 B
./.nuxt/dist/client/components/v-meta-source-list.modern.js 2.54 kB 0 B
./.nuxt/dist/client/components/v-no-results.js 2.77 kB 0 B
./.nuxt/dist/client/components/v-no-results.modern.js 2.74 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.23 kB 0 B
./.nuxt/dist/client/components/v-related-audio.modern.js 1.24 kB 0 B
./.nuxt/dist/client/components/v-related-images.js 3.09 kB 0 B
./.nuxt/dist/client/components/v-related-images.modern.js 2.99 kB 0 B
./.nuxt/dist/client/components/v-report-desc-form.js 966 B 0 B
./.nuxt/dist/client/components/v-report-desc-form.modern.js 965 B 0 B
./.nuxt/dist/client/components/v-row-layout.js 1.68 kB 0 B
./.nuxt/dist/client/components/v-row-layout.modern.js 1.69 kB 0 B
./.nuxt/dist/client/components/v-scroll-button.js 813 B 0 B
./.nuxt/dist/client/components/v-scroll-button.modern.js 819 B 0 B
./.nuxt/dist/client/components/v-search-grid.js 5.45 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 658 B 0 B
./.nuxt/dist/client/components/v-search-results-title.modern.js 652 B 0 B
./.nuxt/dist/client/components/v-search-type-radio.js 831 B 0 B
./.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 995 B 0 B
./.nuxt/dist/client/components/v-sketch-fab-viewer.modern.js 893 B 0 B
./.nuxt/dist/client/components/v-skip-to-content-container.js 887 B 0 B
./.nuxt/dist/client/components/v-skip-to-content-container.modern.js 895 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 15 kB 0 B
./.nuxt/dist/client/components/v-sources-table.modern.js 15.1 kB 0 B
./.nuxt/dist/client/components/v-tab-panel.js 688 B 0 B
./.nuxt/dist/client/components/v-tab-panel.modern.js 684 B 0 B
./.nuxt/dist/client/components/v-tab.js 1.73 kB 0 B
./.nuxt/dist/client/components/v-tab.modern.js 1.72 kB 0 B
./.nuxt/dist/client/components/v-tabs.js 779 B 0 B
./.nuxt/dist/client/components/v-tabs.modern.js 765 B 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.06 kB +1 B (0%)
./.nuxt/dist/client/pages/about.modern.js 1.06 kB +1 B (0%)
./.nuxt/dist/client/pages/audio/_id.js 6.63 kB +1 B (0%)
./.nuxt/dist/client/pages/audio/_id.modern.js 6.46 kB +2 B (0%)
./.nuxt/dist/client/pages/feedback.js 3.23 kB -1 B (0%)
./.nuxt/dist/client/pages/feedback.modern.js 3.21 kB 0 B
./.nuxt/dist/client/pages/image/_id.js 7 kB 0 B
./.nuxt/dist/client/pages/image/_id.modern.js 6.77 kB -1 B (0%)
./.nuxt/dist/client/pages/index.js 5.05 kB 0 B
./.nuxt/dist/client/pages/index.modern.js 4.94 kB +1 B (0%)
./.nuxt/dist/client/pages/meta-search.js 1.67 kB +4 B (0%)
./.nuxt/dist/client/pages/meta-search.modern.js 1.67 kB 0 B
./.nuxt/dist/client/pages/preferences.js 1.21 kB 0 B
./.nuxt/dist/client/pages/preferences.modern.js 1.21 kB 0 B
./.nuxt/dist/client/pages/search-help.js 1.54 kB 0 B
./.nuxt/dist/client/pages/search-help.modern.js 1.55 kB +1 B (0%)
./.nuxt/dist/client/pages/search.js 2.73 kB -1 B (0%)
./.nuxt/dist/client/pages/search.modern.js 2.58 kB -1 B (0%)
./.nuxt/dist/client/pages/search/audio.js 1.19 kB -1 B (0%)
./.nuxt/dist/client/pages/search/audio.modern.js 1.19 kB +1 B (0%)
./.nuxt/dist/client/pages/search/image.js 2.79 kB +1 B (0%)
./.nuxt/dist/client/pages/search/image.modern.js 2.68 kB 0 B
./.nuxt/dist/client/pages/search/model-3d.js 242 B 0 B
./.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 269 B -1 B (0%)
./.nuxt/dist/client/pages/search/video.js 239 B 0 B
./.nuxt/dist/client/pages/search/video.modern.js 243 B 0 B
./.nuxt/dist/client/pages/sources.js 1.44 kB 0 B
./.nuxt/dist/client/pages/sources.modern.js 1.45 kB 0 B
./.nuxt/dist/client/vendors/app.js 47.8 kB 0 B
./.nuxt/dist/client/vendors/app.modern.js 47.1 kB 0 B

compressed-size-action

@zackkrida
Copy link
Member

My understanding was that a tags without an href attribute is a valid and encouraged way to disable a link, particularly paired with aria-disabled (and actually, now I'm seeing role=link should be used too):

@obulat
Copy link
Contributor Author

obulat commented Sep 21, 2022

My understanding was that a tags without an href attribute is a valid and encouraged way to disable a link, particularly paired with aria-disabled (and actually, now I'm seeing role=link should be used too):

Oh, this is interesting, thank you for links, Zack! I tried tabbing to the disabled content links on staging - and couldn't. Those links are skipped when using the Tab key. However, with VO, if you use Ctrl Shift arrow key - you do get to the disabled link!
With this, I realized that the keyboard access order when using the VoiceOver key with arrows and when using Tab key are different! And the change in tabbing order we implemented ( from the header to the sidebar ) doesn't work with the VO navigation keys 😞

@zackkrida
Copy link
Member

@obulat do you think we should remove the div then and replace with a, or a different approach?

@zackkrida zackkrida removed the request for review from sarayourfriend September 27, 2022 19:20
:size="4"
rtl-flip
/>
<slot />
Copy link
Contributor Author

Choose a reason for hiding this comment

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

I realized just now that a NuxtLink is only used for the internal links, so it cannot use the externalLinkIcon.

Copy link
Contributor

Choose a reason for hiding this comment

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

Interesting. How do we define an "external" link? When we've removed the iframe, will w.org links be "external"? If all links that don't use NuxtLink are external then we can remove the conditional showExternalIcon && !isInternal from VIcon. If it's only things that are not either (a) Openverse frontend links or (b) w.org links, then we could detect it and automatically add the icon without having to rely on the prop.

Probably an additional tightening up here and clarification around the iframe project and the idea of "externality". We typically concern ourselves with this (I think) due to differing privacy expectations on other websites. Given Openverse and WordPress.org follow the same privacy policies and are all controlled by WPF, we probably don't need the external icon for w.org links either. But again, something to clarify and probably something for another issue and to rope the w.org infrastructure folks in on.

@obulat
Copy link
Contributor Author

obulat commented Sep 28, 2022

@obulat do you think we should remove the div then and replace with a, or a different approach?

Based on the articles you've linked, I made the changes to render <a role="link" aria-disabled="true">, without the href attribute, when the VLink's href prop is undefined.
Tested on VoiceOver, you cannot Tab to the link, but you can see it if you 'navigate by links' using VO Key + U. A disabled link is there in the list of all links from the page.

@obulat obulat added 🟧 priority: high Stalls work on the project or its dependents and removed 🟨 priority: medium Not blocking but should be addressed soon labels Sep 28, 2022
@obulat obulat self-assigned this Sep 28, 2022
@obulat obulat added 🟨 priority: medium Not blocking but should be addressed soon and removed 🟧 priority: high Stalls work on the project or its dependents labels Sep 28, 2022
@obulat
Copy link
Contributor Author

obulat commented Sep 29, 2022

@sarayourfriend, I would really appreciate your opinion on this approach for disabling links, and not having span as the VLink fallback.

@sarayourfriend
Copy link
Contributor

sarayourfriend commented Sep 29, 2022

If you're asking from an a11y perspective, I don't really know enough to comment, but I can speculate based on what I know an my small experience using screen readers.

In my opinion, the behaviour you're seeing with VO is fine, correct, consistent, and expected. Tab is only used to move between actionable items (buttons, form elements, links) so it naturally skips over disabled ones. The VO text navigation on the other hand is used to read each element of the page one by one. Tab navigation is probably more likely used by a sighted keyboard user who will have the visual context to see that a link is disabled. Maybe some style elements would need to show this if it's anything beyond a loading state so that all sighted users who are not relying on a screen reader that will relay the aria attribute context to them will understand why something that appears to be a link is not clickable.

These are all problems that already exist if we use a span fallback, so I don't think they need to be solved or debated too much here. I haven't tested the code here so I won't stick an approval on it, but as long as other folks have tested and find it functional, I don't see any a11y reason not to merge this. There is no regression from the previous behaviour and in fact screen readers will now have more context than they did before with the span approach.

@obulat obulat requested a review from dhruvkb October 3, 2022 15:36
Copy link
Member

@dhruvkb dhruvkb left a comment

Choose a reason for hiding this comment

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

I'm not a 100% clear on the nuances of a11y for this change, but I tested the following and they work.

  • navigation with keyboard
  • announcements by VoiceOver

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.

LGTM!

@obulat obulat merged commit 82aea7d into main Oct 4, 2022
@obulat obulat deleted the remove_span_from_vlink branch October 4, 2022 14:06
github-actions bot pushed a commit that referenced this pull request Oct 4, 2022
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: improvement Improvement to an existing user-facing feature 🟨 priority: medium Not blocking but should be addressed soon
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Audit all the VLinks to make sure all have href and make it required
5 participants