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

Update logo nav component in header #2136

Merged
merged 2 commits into from
May 24, 2023
Merged

Update logo nav component in header #2136

merged 2 commits into from
May 24, 2023

Conversation

obulat
Copy link
Contributor

@obulat obulat commented May 19, 2023

Fixes

Related to #476 by @fcoveram

Description

This PR updates the VHomeLink component and the VLogoButton component to match the Figma mockups. It cleans up the components from unused props and adds the Storybook stories.

This PR is necessary for replacing the svg dependencies in #2135, which, in turn, is required for Nuxt 3 migration. This is the reason for "high" priority label.

Because this PR changes the spacing of the header logo, there are a lot of snapshot changes.

Testing Instructions

Check the home links in the internal header (the one with the page links, as on the homepage, content pages such as "about" page and the single result pages). The logo should be 18px high, as in the mockups, and the link itself should be 48px high. On hover on white pages, the background becomes yellow. When focused, it should have a pink focus ring.
A special case is a pages modal on mobile width screen. You can open it if you open the site on a narrow screen and click on the "hamburger" menu button. The modal background is black, so the logo becomes white. The focus ring is yellow instead of pink.

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 added the 🟧 priority: high Stalls work on the project or its dependents label May 19, 2023
@obulat obulat self-assigned this May 19, 2023
@obulat obulat changed the title Fix/header home link Update logo nav component in header May 19, 2023
@github-actions github-actions bot added the 🧱 stack: frontend Related to the Nuxt frontend label May 19, 2023
@github-actions
Copy link

github-actions bot commented May 19, 2023

Size Change: +3.53 kB (0%)

Total Size: 850 kB

Filename Size Change
./frontend/.nuxt/dist/client/app.js 129 kB +1.82 kB (+1%)
./frontend/.nuxt/dist/client/app.modern.js 120 kB +1.8 kB (+2%)
./frontend/.nuxt/dist/client/commons/app.modern.js 78.6 kB -99 B (0%)
./frontend/.nuxt/dist/client/components/v-sources-table.js 15.3 kB -14 B (0%)
./frontend/.nuxt/dist/client/components/v-sources-table.modern.js 15.3 kB -16 B (0%)
./frontend/.nuxt/dist/client/vendors/app.js 64.6 kB -16 B (0%)
ℹ️ View Unchanged
Filename Size Change
./frontend/.nuxt/dist/client/234.js 272 B 0 B
./frontend/.nuxt/dist/client/234.modern.js 277 B 0 B
./frontend/.nuxt/dist/client/235.js 1.85 kB 0 B
./frontend/.nuxt/dist/client/commons/app.js 90.4 kB -3 B (0%)
./frontend/.nuxt/dist/client/commons/components/v-search-grid/pages/search.js 5.17 kB -2 B (0%)
./frontend/.nuxt/dist/client/commons/components/v-search-grid/pages/search.modern.js 5.61 kB -2 B (0%)
./frontend/.nuxt/dist/client/components/loading-icon.js 766 B 0 B
./frontend/.nuxt/dist/client/components/loading-icon.modern.js 768 B 0 B
./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-all-results-grid.js 5.75 kB +1 B (0%)
./frontend/.nuxt/dist/client/components/v-all-results-grid.modern.js 5.62 kB -2 B (0%)
./frontend/.nuxt/dist/client/components/v-audio-cell.js 392 B 0 B
./frontend/.nuxt/dist/client/components/v-audio-cell.modern.js 397 B 0 B
./frontend/.nuxt/dist/client/components/v-audio-details.js 2.34 kB 0 B
./frontend/.nuxt/dist/client/components/v-audio-details.modern.js 1.77 kB -1 B (0%)
./frontend/.nuxt/dist/client/components/v-audio-track-skeleton.js 1.02 kB +2 B (0%)
./frontend/.nuxt/dist/client/components/v-audio-track-skeleton.modern.js 1.02 kB 0 B
./frontend/.nuxt/dist/client/components/v-audio-track.js 5.27 kB +3 B (0%)
./frontend/.nuxt/dist/client/components/v-audio-track.modern.js 5.22 kB -1 B (0%)
./frontend/.nuxt/dist/client/components/v-back-to-search-results-link.js 637 B +1 B (0%)
./frontend/.nuxt/dist/client/components/v-back-to-search-results-link.modern.js 641 B -1 B (0%)
./frontend/.nuxt/dist/client/components/v-bone.js 687 B +1 B (0%)
./frontend/.nuxt/dist/client/components/v-bone.modern.js 693 B +1 B (0%)
./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 0 B
./frontend/.nuxt/dist/client/components/v-content-link.js 1.05 kB +1 B (0%)
./frontend/.nuxt/dist/client/components/v-content-link.modern.js 1.04 kB 0 B
./frontend/.nuxt/dist/client/components/v-content-page.js 524 B 0 B
./frontend/.nuxt/dist/client/components/v-content-page.modern.js 529 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 496 B -1 B (0%)
./frontend/.nuxt/dist/client/components/v-content-report-form.js 3.86 kB +4 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 +1 B (0%)
./frontend/.nuxt/dist/client/components/v-content-report-popover.modern.js 4.15 kB +4 B (0%)
./frontend/.nuxt/dist/client/components/v-copy-button.js 4 kB -1 B (0%)
./frontend/.nuxt/dist/client/components/v-copy-button.modern.js 4 kB -2 B (0%)
./frontend/.nuxt/dist/client/components/v-copy-license.js 2.09 kB +1 B (0%)
./frontend/.nuxt/dist/client/components/v-copy-license.modern.js 2.06 kB -1 B (0%)
./frontend/.nuxt/dist/client/components/v-dmca-notice.js 791 B 0 B
./frontend/.nuxt/dist/client/components/v-dmca-notice.modern.js 800 B +2 B (0%)
./frontend/.nuxt/dist/client/components/v-error-image.js 2.61 kB +4 B (0%)
./frontend/.nuxt/dist/client/components/v-error-image.modern.js 2.57 kB +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 -2 B (-1%)
./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 0 B
./frontend/.nuxt/dist/client/components/v-external-source-list.js 892 B +1 B (0%)
./frontend/.nuxt/dist/client/components/v-external-source-list.modern.js 895 B +1 B (0%)
./frontend/.nuxt/dist/client/components/v-full-layout.js 1.55 kB +1 B (0%)
./frontend/.nuxt/dist/client/components/v-full-layout.modern.js 1.55 kB 0 B
./frontend/.nuxt/dist/client/components/v-grid-skeleton.js 1.61 kB 0 B
./frontend/.nuxt/dist/client/components/v-grid-skeleton.modern.js 1.62 kB +2 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 -2 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 +2 B (0%)
./frontend/.nuxt/dist/client/components/v-image-carousel.js 4.73 kB +1 B (0%)
./frontend/.nuxt/dist/client/components/v-image-carousel.modern.js 4.7 kB 0 B
./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 0 B
./frontend/.nuxt/dist/client/components/v-image-details.modern.js 1.41 kB 0 B
./frontend/.nuxt/dist/client/components/v-image-grid.js 3.91 kB -2 B (0%)
./frontend/.nuxt/dist/client/components/v-image-grid.modern.js 3.79 kB +1 B (0%)
./frontend/.nuxt/dist/client/components/v-license-tab-panel.js 642 B 0 B
./frontend/.nuxt/dist/client/components/v-license-tab-panel.modern.js 648 B 0 B
./frontend/.nuxt/dist/client/components/v-load-more.js 846 B 0 B
./frontend/.nuxt/dist/client/components/v-load-more.modern.js 740 B +1 B (0%)
./frontend/.nuxt/dist/client/components/v-media-license.js 828 B +1 B (0%)
./frontend/.nuxt/dist/client/components/v-media-license.modern.js 836 B +1 B (0%)
./frontend/.nuxt/dist/client/components/v-media-reuse.js 2.69 kB +1 B (0%)
./frontend/.nuxt/dist/client/components/v-media-reuse.modern.js 2.65 kB 0 B
./frontend/.nuxt/dist/client/components/v-media-tag.js 416 B 0 B
./frontend/.nuxt/dist/client/components/v-media-tag.modern.js 420 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 -1 B (0%)
./frontend/.nuxt/dist/client/components/v-no-results.js 816 B +2 B (0%)
./frontend/.nuxt/dist/client/components/v-no-results.modern.js 818 B +3 B (0%)
./frontend/.nuxt/dist/client/components/v-radio.js 1.54 kB +1 B (0%)
./frontend/.nuxt/dist/client/components/v-radio.modern.js 1.5 kB +1 B (0%)
./frontend/.nuxt/dist/client/components/v-related-audio.js 1.29 kB -1 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 0 B
./frontend/.nuxt/dist/client/components/v-report-desc-form.modern.js 981 B +1 B (0%)
./frontend/.nuxt/dist/client/components/v-row-layout.js 1.68 kB +1 B (0%)
./frontend/.nuxt/dist/client/components/v-row-layout.modern.js 1.68 kB +1 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-grid.js 6.82 kB +5 B (0%)
./frontend/.nuxt/dist/client/components/v-search-grid.modern.js 6.17 kB -4 B (0%)
./frontend/.nuxt/dist/client/components/v-search-results-title.js 620 B +1 B (0%)
./frontend/.nuxt/dist/client/components/v-search-results-title.modern.js 621 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 -1 B (0%)
./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 -3 B (0%)
./frontend/.nuxt/dist/client/components/v-snackbar.modern.js 1.17 kB -1 B (0%)
./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.4 kB 0 B
./frontend/.nuxt/dist/client/pages/about.modern.js 1.4 kB 0 B
./frontend/.nuxt/dist/client/pages/audio/_id/index.js 6.52 kB +2 B (0%)
./frontend/.nuxt/dist/client/pages/audio/_id/index.modern.js 5.89 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 +2 B (0%)
./frontend/.nuxt/dist/client/pages/feedback.modern.js 1.34 kB +1 B (0%)
./frontend/.nuxt/dist/client/pages/image/_id/index.js 7.46 kB +2 B (0%)
./frontend/.nuxt/dist/client/pages/image/_id/index.modern.js 6.76 kB 0 B
./frontend/.nuxt/dist/client/pages/image/_id/report.js 2.23 kB +1 B (0%)
./frontend/.nuxt/dist/client/pages/image/_id/report.modern.js 5.22 kB -1 B (0%)
./frontend/.nuxt/dist/client/pages/index.js 7.04 kB +5 B (0%)
./frontend/.nuxt/dist/client/pages/index.modern.js 6.96 kB +3 B (0%)
./frontend/.nuxt/dist/client/pages/preferences.js 1.3 kB +2 B (0%)
./frontend/.nuxt/dist/client/pages/preferences.modern.js 1.3 kB -1 B (0%)
./frontend/.nuxt/dist/client/pages/privacy.js 1.23 kB +2 B (0%)
./frontend/.nuxt/dist/client/pages/privacy.modern.js 1.24 kB +4 B (0%)
./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 +1 B (0%)
./frontend/.nuxt/dist/client/pages/search.js 2.19 kB -1 B (0%)
./frontend/.nuxt/dist/client/pages/search.modern.js 2.04 kB 0 B
./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 +1 B (0%)
./frontend/.nuxt/dist/client/pages/search/image.modern.js 548 B 0 B
./frontend/.nuxt/dist/client/pages/search/index.js 442 B -1 B (0%)
./frontend/.nuxt/dist/client/pages/search/index.modern.js 448 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 +1 B (0%)
./frontend/.nuxt/dist/client/pages/sources.modern.js 1.52 kB +1 B (0%)
./frontend/.nuxt/dist/client/runtime.js 2.71 kB 0 B
./frontend/.nuxt/dist/client/runtime.modern.js 2.72 kB 0 B
./frontend/.nuxt/dist/client/vendors/app.modern.js 63.9 kB -2 B (0%)

compressed-size-action

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.

The logo in frontend/test/playwright/visual-regression/components/filters.spec.ts-snapshots/filters-modal-filters-selected-ltr-png-xs-linux.png seems to be animating. Can we pause the animation for VRT, I suspect it will cause flakiness otherwise?

@obulat obulat force-pushed the fix/header_home_link branch from 5c966c1 to a7982c5 Compare May 19, 2023 12:57
@obulat obulat added ✨ goal: improvement Improvement to an existing user-facing feature 🕹 aspect: interface Concerns end-users' experience with the software labels May 19, 2023
@obulat
Copy link
Contributor Author

obulat commented May 19, 2023

The logo in frontend/test/playwright/visual-regression/components/filters.spec.ts-snapshots/filters-modal-filters-selected-ltr-png-xs-linux.png seems to be animating. Can we pause the animation for VRT, I suspect it will cause flakiness otherwise?

That was a locally-generated snapshot that I've updated later. I think we don't need to pause animation, but if the tests do fail again, I'll investigate if we need to adjust the wait. I've replaced the snapshot with a correct one.

@obulat obulat marked this pull request as ready for review May 19, 2023 13:36
@obulat obulat requested a review from a team as a code owner May 19, 2023 13:36
@obulat obulat force-pushed the fix/header_home_link branch 2 times, most recently from e87d12f to ca6191e Compare May 19, 2023 14:45
@obulat obulat requested review from zackkrida and removed request for sarayourfriend May 19, 2023 16:11
@obulat obulat force-pushed the fix/header_home_link branch 2 times, most recently from 5c774f5 to 5a0ec34 Compare May 22, 2023 14:18
@zackkrida
Copy link
Member

This looks excellent. Before approving I do want to clarify one thing with @fcoveram when he can look at it:

There's historically been, including in this PR, a small size and placement difference between the logo on the homepage and the logo on the site content pages. I attempted to make a video overlaying the two to show the issue:

https://share.cleanshot.com/TSbFf3kz

is this discrepancy present in Figma? Does it matter to fix this?

@obulat obulat force-pushed the fix/header_home_link branch from 5a0ec34 to 375c672 Compare May 23, 2023 12:48
@openverse-bot
Copy link
Collaborator

Based on the high urgency of this PR, the following reviewers are being gently reminded to review this PR:

@fcoveram
@zackkrida
@AetherUnbound
This reminder is being automatically generated due to the urgency configuration.

Excluding weekend1 days, this PR was ready for review 2 day(s) ago. PRs labelled with high urgency are expected to be reviewed within 2 weekday(s)2.

@obulat, if this PR is not ready for a review, please draft it to prevent reviewers from getting further unnecessary pings.

Footnotes

  1. Specifically, Saturday and Sunday.

  2. For the purpose of these reminders we treat Monday - Friday as weekdays. Please note that the operation that generates these reminders runs at midnight UTC on Monday - Friday. This means that depending on your timezone, you may be pinged outside of the expected range.

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.

Thanks for the great testing instructions, I was able to confirm each of the cases when running locally!

@fcoveram
Copy link
Contributor

is this discrepancy present in Figma? Does it matter to fix this?

As in the example shared, it's not present in Figma. If you go to the Logo nav component in the Design Library, you will see the following

Screenshot of Logo nav component with notes

Row 1 (size: small) is the logo for the content header in small breakpoints when it's part of the search bar. Row 2 (size: medium) is for the content header in bigger breakpoints. And Row 3 (size: large) is for the internal header in all breakpoints.

Row 2 and 3 share the same size for the symbol, but the latter adds the word "openverse" and has a 16px padding on left and right sides.

Medium and Large versions of Logo nav with spacing guides

So going back to your questions from the video:

  • Is this discrepancy present in Figma? The symbol size discrepancy is wrong. The only difference is the padding in row 3 (size: large)
  • Does it matter to fix this? It does. Especially in header content where logo looks bigger than mockups in all breakpoints. See the image below where I compared both headers in their two main variants.

Screenshot of big and small headers in small and big breakpoints

@obulat obulat force-pushed the fix/header_home_link branch from 375c672 to d91df61 Compare May 24, 2023 08:58
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 perfect ✨ 🚀

Since this PR addresses changes in Header internal, the component specs described here can be tackled in a different PR.

@obulat obulat force-pushed the fix/header_home_link branch from ae94e43 to b02047b Compare May 24, 2023 14:45
@obulat obulat merged commit 8513f26 into main May 24, 2023
@obulat obulat deleted the fix/header_home_link branch May 24, 2023 15:05
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: high Stalls work on the project or its dependents 🧱 stack: frontend Related to the Nuxt frontend
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

6 participants