Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updated content link #2102

Merged
merged 11 commits into from
May 18, 2023
Merged

Updated content link #2102

merged 11 commits into from
May 18, 2023

Conversation

obulat
Copy link
Contributor

@obulat obulat commented May 15, 2023

Fixes

Related to #2078 by @fcoveram
Fixes #2083 by @fcoveram

Description

This PR updates the VContentLink component to match the styles in the linked issue.
Content link is always enabled, even if there are no results (as per #2083).

I also added the aria-label to the button to improve the screen reader experience. Currently, it lacks a period between "See all images" and "... results", so it's not easy to understand. The new labels for images are:

 zero: "No images found for {query}. Try an external search source.",
count: "See {localeCount} image found for {query}|See {localeCount} images found for {query}",
countMore: "See over {localeCount} images found for {query}",

There are similar labels for audio.
I am a bit worried that having two content links at the top might make screen reader users think that all of the results consist of these two links, and not try to navigate on to the mixed view.

Testing Instructions

Check that the content link on the All results view matches the mockups.

Checklist

  • My pull request has a descriptive title (not a vague title likeUpdate 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.
  • I ran the DAG documentation generator (if applicable).

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 May 15, 2023 15:09
@github-actions github-actions bot added the 🧱 stack: frontend Related to the Nuxt frontend label May 15, 2023
@obulat obulat added 🟨 priority: medium Not blocking but should be addressed soon ✨ goal: improvement Improvement to an existing user-facing feature 🕹 aspect: interface Concerns end-users' experience with the software labels May 15, 2023
@obulat obulat requested review from fcoveram and zackkrida and removed request for sarayourfriend and AetherUnbound May 15, 2023 15:10
@github-actions
Copy link

github-actions bot commented May 15, 2023

Size Change: -7.52 kB (-1%)

Total Size: 832 kB

Filename Size Change
./frontend/.nuxt/dist/client/234.js 1.85 kB +1.58 kB (+581%) 🆘
./frontend/.nuxt/dist/client/234.modern.js 0 B -277 B (removed) 🏆
./frontend/.nuxt/dist/client/235.js 0 B -1.85 kB (removed) 🏆
./frontend/.nuxt/dist/client/app.js 126 kB +144 B (0%)
./frontend/.nuxt/dist/client/app.modern.js 117 kB +121 B (0%)
./frontend/.nuxt/dist/client/components/v-all-results-grid.js 5.75 kB -68 B (-1%)
./frontend/.nuxt/dist/client/components/v-all-results-grid.modern.js 5.62 kB -71 B (-1%)
./frontend/.nuxt/dist/client/components/v-content-link.js 1.04 kB -51 B (-5%)
./frontend/.nuxt/dist/client/components/v-content-link.modern.js 1.04 kB -56 B (-5%)
./frontend/.nuxt/dist/client/components/v-copy-license.js 2.09 kB +960 B (+85%) 🆘
./frontend/.nuxt/dist/client/components/v-copy-license.modern.js 2.06 kB +926 B (+82%) 🆘
./frontend/.nuxt/dist/client/components/v-copy-license/components/v-error-image/components/v-media-reuse/components/v-search-grid/d219393b.js 0 B -10 kB (removed) 🏆
./frontend/.nuxt/dist/client/components/v-copy-license/components/v-error-image/components/v-media-reuse/components/v-search-grid/d219393b.modern.js 0 B -10 kB (removed) 🏆
./frontend/.nuxt/dist/client/components/v-error-image.js 2.6 kB +910 B (+54%) 🆘
./frontend/.nuxt/dist/client/components/v-error-image.modern.js 2.57 kB +882 B (+52%) 🆘
./frontend/.nuxt/dist/client/components/v-media-reuse.js 2.69 kB +951 B (+55%) 🆘
./frontend/.nuxt/dist/client/components/v-media-reuse.modern.js 2.65 kB +913 B (+53%) 🆘
./frontend/.nuxt/dist/client/components/v-search-grid.js 6.55 kB +877 B (+15%) ⚠️
./frontend/.nuxt/dist/client/components/v-search-grid.modern.js 6.46 kB +850 B (+15%) ⚠️
./frontend/.nuxt/dist/client/components/v-sources-table.js 15.2 kB +12 B (0%)
./frontend/.nuxt/dist/client/components/v-sources-table.modern.js 15.2 kB +16 B (0%)
./frontend/.nuxt/dist/client/pages/audio/_id/index.js 6.52 kB +890 B (+16%) ⚠️
./frontend/.nuxt/dist/client/pages/audio/_id/index.modern.js 5.9 kB +860 B (+17%) ⚠️
./frontend/.nuxt/dist/client/pages/image/_id/index.js 7.46 kB +885 B (+13%) ⚠️
./frontend/.nuxt/dist/client/pages/image/_id/index.modern.js 6.77 kB +847 B (+14%) ⚠️
./frontend/.nuxt/dist/client/pages/image/_id/report.js 2.23 kB +967 B (+77%) 🆘
./frontend/.nuxt/dist/client/pages/image/_id/report.modern.js 5.21 kB +861 B (+20%) 🚨
./frontend/.nuxt/dist/client/runtime.js 2.69 kB -30 B (-1%)
./frontend/.nuxt/dist/client/runtime.modern.js 2.69 kB -31 B (-1%)
./frontend/.nuxt/dist/client/233.js 272 B +272 B (new file) 🆕
./frontend/.nuxt/dist/client/233.modern.js 277 B +277 B (new file) 🆕
ℹ️ View Unchanged
Filename Size Change
./frontend/.nuxt/dist/client/commons/app.js 90.4 kB -8 B (0%)
./frontend/.nuxt/dist/client/commons/app.modern.js 78.5 kB 0 B
./frontend/.nuxt/dist/client/components/loading-icon.js 766 B +1 B (0%)
./frontend/.nuxt/dist/client/components/loading-icon.modern.js 769 B +1 B (0%)
./frontend/.nuxt/dist/client/components/table-sort-icon.js 514 B 0 B
./frontend/.nuxt/dist/client/components/table-sort-icon.modern.js 519 B 0 B
./frontend/.nuxt/dist/client/components/v-audio-cell.js 392 B +2 B (+1%)
./frontend/.nuxt/dist/client/components/v-audio-cell.modern.js 396 B -1 B (0%)
./frontend/.nuxt/dist/client/components/v-audio-details.js 2.35 kB +1 B (0%)
./frontend/.nuxt/dist/client/components/v-audio-details.modern.js 1.77 kB -2 B (0%)
./frontend/.nuxt/dist/client/components/v-audio-track-skeleton.js 1.01 kB -2 B (0%)
./frontend/.nuxt/dist/client/components/v-audio-track-skeleton.modern.js 1.02 kB +1 B (0%)
./frontend/.nuxt/dist/client/components/v-audio-track.js 5.26 kB 0 B
./frontend/.nuxt/dist/client/components/v-audio-track.modern.js 5.21 kB -1 B (0%)
./frontend/.nuxt/dist/client/components/v-back-to-search-results-link.js 636 B 0 B
./frontend/.nuxt/dist/client/components/v-back-to-search-results-link.modern.js 642 B 0 B
./frontend/.nuxt/dist/client/components/v-bone.js 688 B +1 B (0%)
./frontend/.nuxt/dist/client/components/v-bone.modern.js 692 B 0 B
./frontend/.nuxt/dist/client/components/v-box-layout.js 1.28 kB -1 B (0%)
./frontend/.nuxt/dist/client/components/v-box-layout.modern.js 1.27 kB -1 B (0%)
./frontend/.nuxt/dist/client/components/v-content-page.js 524 B 0 B
./frontend/.nuxt/dist/client/components/v-content-page.modern.js 528 B 0 B
./frontend/.nuxt/dist/client/components/v-content-report-button.js 493 B 0 B
./frontend/.nuxt/dist/client/components/v-content-report-button.modern.js 497 B 0 B
./frontend/.nuxt/dist/client/components/v-content-report-form.js 3.86 kB +3 B (0%)
./frontend/.nuxt/dist/client/components/v-content-report-form.modern.js 3.69 kB +1 B (0%)
./frontend/.nuxt/dist/client/components/v-content-report-popover.js 913 B 0 B
./frontend/.nuxt/dist/client/components/v-content-report-popover.modern.js 4.15 kB +2 B (0%)
./frontend/.nuxt/dist/client/components/v-copy-button.js 4 kB 0 B
./frontend/.nuxt/dist/client/components/v-copy-button.modern.js 4 kB 0 B
./frontend/.nuxt/dist/client/components/v-dmca-notice.js 791 B 0 B
./frontend/.nuxt/dist/client/components/v-dmca-notice.modern.js 799 B +1 B (0%)
./frontend/.nuxt/dist/client/components/v-error-section.js 372 B 0 B
./frontend/.nuxt/dist/client/components/v-error-section.modern.js 375 B 0 B
./frontend/.nuxt/dist/client/components/v-external-search-form.js 1.88 kB -1 B (0%)
./frontend/.nuxt/dist/client/components/v-external-search-form.modern.js 1.87 kB -1 B (0%)
./frontend/.nuxt/dist/client/components/v-external-source-list.js 893 B -1 B (0%)
./frontend/.nuxt/dist/client/components/v-external-source-list.modern.js 896 B 0 B
./frontend/.nuxt/dist/client/components/v-full-layout.js 1.56 kB -2 B (0%)
./frontend/.nuxt/dist/client/components/v-full-layout.modern.js 1.55 kB +1 B (0%)
./frontend/.nuxt/dist/client/components/v-grid-skeleton.js 1.61 kB -3 B (0%)
./frontend/.nuxt/dist/client/components/v-grid-skeleton.modern.js 1.62 kB -1 B (0%)
./frontend/.nuxt/dist/client/components/v-home-gallery.js 4.92 kB -3 B (0%)
./frontend/.nuxt/dist/client/components/v-home-gallery.modern.js 4.9 kB -1 B (0%)
./frontend/.nuxt/dist/client/components/v-homepage-content.js 1.77 kB -1 B (0%)
./frontend/.nuxt/dist/client/components/v-homepage-content.modern.js 1.74 kB 0 B
./frontend/.nuxt/dist/client/components/v-image-carousel.js 4.74 kB 0 B
./frontend/.nuxt/dist/client/components/v-image-carousel.modern.js 4.7 kB -1 B (0%)
./frontend/.nuxt/dist/client/components/v-image-cell.js 1.68 kB 0 B
./frontend/.nuxt/dist/client/components/v-image-cell.modern.js 1.67 kB +1 B (0%)
./frontend/.nuxt/dist/client/components/v-image-details.js 1.96 kB +1 B (0%)
./frontend/.nuxt/dist/client/components/v-image-details.modern.js 1.41 kB +2 B (0%)
./frontend/.nuxt/dist/client/components/v-image-grid.js 3.91 kB -4 B (0%)
./frontend/.nuxt/dist/client/components/v-image-grid.modern.js 3.79 kB 0 B
./frontend/.nuxt/dist/client/components/v-license-tab-panel.js 641 B +1 B (0%)
./frontend/.nuxt/dist/client/components/v-license-tab-panel.modern.js 649 B 0 B
./frontend/.nuxt/dist/client/components/v-load-more.js 844 B 0 B
./frontend/.nuxt/dist/client/components/v-load-more.modern.js 741 B -1 B (0%)
./frontend/.nuxt/dist/client/components/v-media-license.js 828 B 0 B
./frontend/.nuxt/dist/client/components/v-media-license.modern.js 836 B -1 B (0%)
./frontend/.nuxt/dist/client/components/v-media-tag.js 416 B 0 B
./frontend/.nuxt/dist/client/components/v-media-tag.modern.js 421 B 0 B
./frontend/.nuxt/dist/client/components/v-modal.js 1.01 kB 0 B
./frontend/.nuxt/dist/client/components/v-modal.modern.js 995 B 0 B
./frontend/.nuxt/dist/client/components/v-no-results.js 821 B -3 B (0%)
./frontend/.nuxt/dist/client/components/v-no-results.modern.js 825 B 0 B
./frontend/.nuxt/dist/client/components/v-radio.js 1.54 kB 0 B
./frontend/.nuxt/dist/client/components/v-radio.modern.js 1.5 kB 0 B
./frontend/.nuxt/dist/client/components/v-related-audio.js 1.29 kB +2 B (0%)
./frontend/.nuxt/dist/client/components/v-related-audio.modern.js 1.29 kB 0 B
./frontend/.nuxt/dist/client/components/v-related-images.js 1.1 kB +1 B (0%)
./frontend/.nuxt/dist/client/components/v-related-images.modern.js 1.1 kB 0 B
./frontend/.nuxt/dist/client/components/v-report-desc-form.js 977 B +1 B (0%)
./frontend/.nuxt/dist/client/components/v-report-desc-form.modern.js 979 B 0 B
./frontend/.nuxt/dist/client/components/v-row-layout.js 1.68 kB 0 B
./frontend/.nuxt/dist/client/components/v-row-layout.modern.js 1.68 kB -2 B (0%)
./frontend/.nuxt/dist/client/components/v-scroll-button.js 824 B 0 B
./frontend/.nuxt/dist/client/components/v-scroll-button.modern.js 829 B 0 B
./frontend/.nuxt/dist/client/components/v-search-results-title.js 618 B -1 B (0%)
./frontend/.nuxt/dist/client/components/v-search-results-title.modern.js 622 B 0 B
./frontend/.nuxt/dist/client/components/v-server-timeout.js 299 B 0 B
./frontend/.nuxt/dist/client/components/v-server-timeout.modern.js 303 B 0 B
./frontend/.nuxt/dist/client/components/v-sketch-fab-viewer.js 1.01 kB 0 B
./frontend/.nuxt/dist/client/components/v-sketch-fab-viewer.modern.js 912 B +1 B (0%)
./frontend/.nuxt/dist/client/components/v-snackbar.js 1.16 kB +1 B (0%)
./frontend/.nuxt/dist/client/components/v-snackbar.modern.js 1.17 kB 0 B
./frontend/.nuxt/dist/client/components/v-warning-suppressor.js 306 B 0 B
./frontend/.nuxt/dist/client/components/v-warning-suppressor.modern.js 311 B 0 B
./frontend/.nuxt/dist/client/pages/about.js 1.39 kB -1 B (0%)
./frontend/.nuxt/dist/client/pages/about.modern.js 1.4 kB 0 B
./frontend/.nuxt/dist/client/pages/external-sources.js 1.55 kB +1 B (0%)
./frontend/.nuxt/dist/client/pages/external-sources.modern.js 1.56 kB 0 B
./frontend/.nuxt/dist/client/pages/feedback.js 1.34 kB -3 B (0%)
./frontend/.nuxt/dist/client/pages/feedback.modern.js 1.34 kB 0 B
./frontend/.nuxt/dist/client/pages/index.js 7.04 kB -2 B (0%)
./frontend/.nuxt/dist/client/pages/index.modern.js 6.96 kB 0 B
./frontend/.nuxt/dist/client/pages/preferences.js 1.32 kB 0 B
./frontend/.nuxt/dist/client/pages/preferences.modern.js 1.32 kB -1 B (0%)
./frontend/.nuxt/dist/client/pages/privacy.js 1.01 kB 0 B
./frontend/.nuxt/dist/client/pages/privacy.modern.js 1.02 kB 0 B
./frontend/.nuxt/dist/client/pages/search-help.js 1.59 kB -1 B (0%)
./frontend/.nuxt/dist/client/pages/search-help.modern.js 1.58 kB 0 B
./frontend/.nuxt/dist/client/pages/search.js 2.2 kB 0 B
./frontend/.nuxt/dist/client/pages/search.modern.js 2.04 kB +1 B (0%)
./frontend/.nuxt/dist/client/pages/search/audio.js 3.69 kB +1 B (0%)
./frontend/.nuxt/dist/client/pages/search/audio.modern.js 3.58 kB +1 B (0%)
./frontend/.nuxt/dist/client/pages/search/image.js 545 B 0 B
./frontend/.nuxt/dist/client/pages/search/image.modern.js 550 B +2 B (0%)
./frontend/.nuxt/dist/client/pages/search/index.js 443 B +1 B (0%)
./frontend/.nuxt/dist/client/pages/search/index.modern.js 446 B -2 B (0%)
./frontend/.nuxt/dist/client/pages/search/model-3d.js 243 B +1 B (0%)
./frontend/.nuxt/dist/client/pages/search/model-3d.modern.js 246 B 0 B
./frontend/.nuxt/dist/client/pages/search/search-page.types.js 266 B 0 B
./frontend/.nuxt/dist/client/pages/search/search-page.types.modern.js 271 B 0 B
./frontend/.nuxt/dist/client/pages/search/video.js 240 B 0 B
./frontend/.nuxt/dist/client/pages/search/video.modern.js 243 B 0 B
./frontend/.nuxt/dist/client/pages/sources.js 1.51 kB 0 B
./frontend/.nuxt/dist/client/pages/sources.modern.js 1.51 kB 0 B
./frontend/.nuxt/dist/client/vendors/app.js 64.6 kB -2 B (0%)
./frontend/.nuxt/dist/client/vendors/app.modern.js 63.7 kB -1 B (0%)

compressed-size-action

@obulat obulat force-pushed the add/updated_content_link branch from 1263c82 to cb23096 Compare May 15, 2023 15:56
Copy link
Collaborator

@AetherUnbound AetherUnbound left a comment

Choose a reason for hiding this comment

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

Confirmed that I can see the changes to the VContentLink locally! (The term john de mark gives me image results but not audio ones, for others who may want to test the non-disabling buttons).

@obulat obulat force-pushed the add/updated_content_link branch from cb23096 to a3da08b Compare May 16, 2023 04:52
@obulat obulat marked this pull request as draft May 16, 2023 06:43
@obulat obulat marked this pull request as ready for review May 16, 2023 09:44
Copy link
Contributor

@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.

I notice the following visual errors:

  • The large variant of component should be 72px height
  • From sm and beyond the component should be large. Here are mockups for all breakpoints.
  • In small variant, space between media type and results labels should be 4px
  • In hover and focus, results label changes from "dark charcoal 70" to "dark charcoal"

Regarding the aria-label script, I'm not sure about the "Try an external search source." sentence. The metasearch action is far from the navigation and, in my overall understanding, labels should aim to provide the same information to all users, and this content is not visually conveyed. I might be wrong in this last point

@obulat
Copy link
Contributor Author

obulat commented May 16, 2023

Regarding the aria-label script, I'm not sure about the "Try an external search source." sentence. The metasearch action is far from the navigation and, in my overall understanding, labels should aim to provide the same information to all users, and this content is not visually conveyed. I might be wrong in this last point

This makes a lot of sense, you're right. I'll remove that part of the sentence.

@obulat obulat force-pushed the add/updated_content_link branch 2 times, most recently from 4a9598b to 43b2eae Compare May 16, 2023 15:15
@obulat obulat requested a review from fcoveram May 16, 2023 15:18
@obulat obulat self-assigned this May 17, 2023
@obulat obulat force-pushed the add/updated_content_link branch 2 times, most recently from 38a03ae to dfbd2eb Compare May 17, 2023 14:24
Copy link
Contributor

@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.

All styles look correct ✨ 🚀

I just noticed that header cuts out the focus ring in xs and sm. Not sure if it belongs to this PR's scope so feel free to dismiss it.

keyboard navigation from header to content area in mobile device. Focus ring is visible

@obulat obulat force-pushed the add/updated_content_link branch from dfbd2eb to 023430b Compare May 18, 2023 08:53
@obulat
Copy link
Contributor Author

obulat commented May 18, 2023

I just noticed that header cuts out the focus ring in xs and sm. Not sure if it belongs to this PR's scope so feel free to dismiss it.

We have removed the top padding (from the h1 element) in the header spacing improvements PR, and the header has a z-index of 40 (which it has to do because the header should be "higher" than the lower part of the site). To solve this we could add a small padding to the top of the main content. I'm not sure if we should prioritize this, though, because not many users would use small screen with a keyboard.

@fcoveram
Copy link
Contributor

I understand. It makes sense

To solve this we could add a small padding to the top of the main content.

We can add a top margin of 8px in the search result area. I tried it in Chrome inspector and it looks good.

Screenshot of openverse results on mobile. Search area is highlighted with a top margin section

I'm not sure if we should prioritize this, though, because not many users would use small screen with a keyboard.

I think we should. The paradigm of small views only for small devices is not necessarily true. Having multiple windows in different sizes on the screen is a real use case. Something that Arc browser embraces with a built-in feature. Here is a quick screenshot from a sample browsing.

Screenshot of Arc browser showing Rest of World and Openverse sites side by side

@obulat obulat requested a review from fcoveram May 18, 2023 09:34
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!

Copy link
Contributor

@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.

It looks great 🚀

@obulat obulat merged commit 62f84ab into main May 18, 2023
@obulat obulat deleted the add/updated_content_link branch May 18, 2023 14:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🕹 aspect: interface Concerns end-users' experience with the software ✨ goal: improvement Improvement to an existing user-facing feature 🟨 priority: medium Not blocking but should be addressed soon 🧱 stack: frontend Related to the Nuxt frontend
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

Enable content link for no results and add pill in switcher popover item
4 participants