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

Fix "Back to results" link and remove grey background from single results page #1977

Merged
merged 10 commits into from
Nov 22, 2022

Conversation

dhruvkb
Copy link
Member

@dhruvkb dhruvkb commented Nov 16, 2022

Fixes

Fixes #1974 by @zackkrida

Description

This PR

  • simplifies the code of the "Back to results" button
  • adds a story for the "Back to results" button
  • removes the grey background from single image and audio when new header is enabled
  • avoids any major UI change when new header is disabled

Testing Instructions

See that the issue #1974 has been resolved, without tampering the old header UI.

  1. Compare the single audio and single image results against the mockups.
  2. Enable the new header
  3. Compare the single audio and single image results against the new header mockups.

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 Nov 16, 2022

Storybook and Tailwind configuration previews: Ready

Storybook: https://wordpress.github.io/openverse-frontend/_preview/1977
Tailwind: https://wordpress.github.io/openverse-frontend/_preview/1977/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: interface Concerns end-users' experience with the software 🟧 priority: high Stalls work on the project or its dependents labels Nov 16, 2022
@github-actions
Copy link

github-actions bot commented Nov 16, 2022

Size Change: -2.15 kB (0%)

Total Size: 820 kB

Filename Size Change
./.nuxt/dist/client/227.js 0 B -273 B (removed) 🏆
./.nuxt/dist/client/227.modern.js 0 B -277 B (removed) 🏆
./.nuxt/dist/client/228.js 0 B -1.85 kB (removed) 🏆
./.nuxt/dist/client/app.js 129 kB -1.14 kB (-1%)
./.nuxt/dist/client/app.modern.js 120 kB -1.16 kB (-1%)
./.nuxt/dist/client/commons/app.js 88.1 kB -236 B (0%)
./.nuxt/dist/client/commons/app.modern.js 76.9 kB -138 B (0%)
./.nuxt/dist/client/components/v-audio-track.js 5.22 kB +87 B (+2%)
./.nuxt/dist/client/components/v-audio-track.modern.js 5.16 kB +92 B (+2%)
./.nuxt/dist/client/components/v-full-layout.js 1.59 kB +101 B (+7%) 🔍
./.nuxt/dist/client/components/v-full-layout.modern.js 1.59 kB +103 B (+7%) 🔍
./.nuxt/dist/client/components/v-sources-table.js 15.7 kB -21 B (0%)
./.nuxt/dist/client/components/v-sources-table.modern.js 15.8 kB -19 B (0%)
./.nuxt/dist/client/pages/audio/_id.js 4.96 kB +59 B (+1%)
./.nuxt/dist/client/pages/audio/_id.modern.js 4.79 kB +72 B (+2%)
./.nuxt/dist/client/pages/image/_id.js 5.34 kB +35 B (+1%)
./.nuxt/dist/client/pages/image/_id.modern.js 7.34 kB +89 B (+1%)
./.nuxt/dist/client/pages/preferences.js 1.21 kB -10 B (-1%)
./.nuxt/dist/client/pages/search/audio.js 3.82 kB +18 B (0%)
./.nuxt/dist/client/runtime.js 2.63 kB -46 B (-2%)
./.nuxt/dist/client/runtime.modern.js 2.63 kB -46 B (-2%)
./.nuxt/dist/client/vendors/app.js 62.2 kB -20 B (0%)
./.nuxt/dist/client/217.js 273 B +273 B (new file) 🆕
./.nuxt/dist/client/217.modern.js 277 B +277 B (new file) 🆕
./.nuxt/dist/client/218.js 1.85 kB +1.85 kB (new file) 🆕
ℹ️ View Unchanged
Filename Size Change
./.nuxt/dist/client/components/loading-icon.js 745 B -1 B (0%)
./.nuxt/dist/client/components/loading-icon.modern.js 750 B 0 B
./.nuxt/dist/client/components/table-sort-icon.js 509 B 0 B
./.nuxt/dist/client/components/table-sort-icon.modern.js 513 B 0 B
./.nuxt/dist/client/components/v-all-results-grid.js 5.15 kB +8 B (0%)
./.nuxt/dist/client/components/v-all-results-grid.modern.js 5.01 kB +2 B (0%)
./.nuxt/dist/client/components/v-audio-cell.js 357 B 0 B
./.nuxt/dist/client/components/v-audio-cell.modern.js 360 B 0 B
./.nuxt/dist/client/components/v-audio-details.js 1.81 kB -1 B (0%)
./.nuxt/dist/client/components/v-audio-details.modern.js 1.79 kB -2 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 0 B
./.nuxt/dist/client/components/v-back-to-search-results-link.js 539 B +2 B (0%)
./.nuxt/dist/client/components/v-back-to-search-results-link.modern.js 543 B +1 B (0%)
./.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 +2 B (0%)
./.nuxt/dist/client/components/v-content-link.js 1.11 kB 0 B
./.nuxt/dist/client/components/v-content-link.modern.js 1.09 kB 0 B
./.nuxt/dist/client/components/v-content-page.js 467 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 778 B 0 B
./.nuxt/dist/client/components/v-content-report-button.modern.js 785 B +3 B (0%)
./.nuxt/dist/client/components/v-content-report-form.js 3.75 kB -2 B (0%)
./.nuxt/dist/client/components/v-content-report-form.modern.js 3.56 kB 0 B
./.nuxt/dist/client/components/v-content-report-popover.js 4.41 kB -1 B (0%)
./.nuxt/dist/client/components/v-content-report-popover.modern.js 4.22 kB 0 B
./.nuxt/dist/client/components/v-copy-button.js 3.98 kB -3 B (0%)
./.nuxt/dist/client/components/v-copy-button.modern.js 4 kB -1 B (0%)
./.nuxt/dist/client/components/v-copy-license.js 999 B 0 B
./.nuxt/dist/client/components/v-copy-license.modern.js 1 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.5 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.47 kB +2 B (0%)
./.nuxt/dist/client/components/v-dmca-notice.js 747 B 0 B
./.nuxt/dist/client/components/v-dmca-notice.modern.js 753 B -1 B (0%)
./.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 0 B
./.nuxt/dist/client/components/v-error-section.js 372 B 0 B
./.nuxt/dist/client/components/v-error-section.modern.js 376 B 0 B
./.nuxt/dist/client/components/v-external-search-form.js 3.09 kB +1 B (0%)
./.nuxt/dist/client/components/v-external-search-form.modern.js 3.06 kB 0 B
./.nuxt/dist/client/components/v-external-source-list.js 2.54 kB 0 B
./.nuxt/dist/client/components/v-external-source-list.modern.js 2.52 kB 0 B
./.nuxt/dist/client/components/v-grid-skeleton.js 1.61 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.02 kB 0 B
./.nuxt/dist/client/components/v-image-cell-square.modern.js 1.02 kB +1 B (0%)
./.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 +1 B (0%)
./.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.54 kB 0 B
./.nuxt/dist/client/components/v-image-grid.modern.js 2.42 kB +3 B (0%)
./.nuxt/dist/client/components/v-license-tab-panel.js 521 B 0 B
./.nuxt/dist/client/components/v-license-tab-panel.modern.js 525 B 0 B
./.nuxt/dist/client/components/v-load-more.js 790 B 0 B
./.nuxt/dist/client/components/v-load-more.modern.js 682 B 0 B
./.nuxt/dist/client/components/v-media-license.js 800 B 0 B
./.nuxt/dist/client/components/v-media-license.modern.js 808 B 0 B
./.nuxt/dist/client/components/v-media-reuse.js 1.62 kB +2 B (0%)
./.nuxt/dist/client/components/v-media-reuse.modern.js 1.61 kB +1 B (0%)
./.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-no-results.js 2.75 kB 0 B
./.nuxt/dist/client/components/v-no-results.modern.js 2.72 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 +2 B (0%)
./.nuxt/dist/client/components/v-related-audio.js 1.23 kB +3 B (0%)
./.nuxt/dist/client/components/v-related-audio.modern.js 1.23 kB +1 B (0%)
./.nuxt/dist/client/components/v-related-images.js 3.09 kB -4 B (0%)
./.nuxt/dist/client/components/v-related-images.modern.js 2.98 kB +2 B (0%)
./.nuxt/dist/client/components/v-report-desc-form.js 965 B -1 B (0%)
./.nuxt/dist/client/components/v-report-desc-form.modern.js 964 B +1 B (0%)
./.nuxt/dist/client/components/v-row-layout.js 1.7 kB +1 B (0%)
./.nuxt/dist/client/components/v-row-layout.modern.js 1.71 kB +1 B (0%)
./.nuxt/dist/client/components/v-scroll-button.js 813 B +1 B (0%)
./.nuxt/dist/client/components/v-scroll-button.modern.js 818 B -1 B (0%)
./.nuxt/dist/client/components/v-search-grid.js 5.43 kB -2 B (0%)
./.nuxt/dist/client/components/v-search-grid.modern.js 5.38 kB +2 B (0%)
./.nuxt/dist/client/components/v-search-results-title.js 656 B -2 B (0%)
./.nuxt/dist/client/components/v-search-results-title.modern.js 652 B -1 B (0%)
./.nuxt/dist/client/components/v-search-type-radio.js 793 B -1 B (0%)
./.nuxt/dist/client/components/v-search-type-radio.modern.js 771 B 0 B
./.nuxt/dist/client/components/v-server-timeout.js 298 B -1 B (0%)
./.nuxt/dist/client/components/v-server-timeout.modern.js 303 B +1 B (0%)
./.nuxt/dist/client/components/v-sidebar-target.js 317 B -1 B (0%)
./.nuxt/dist/client/components/v-sidebar-target.modern.js 321 B 0 B
./.nuxt/dist/client/components/v-sketch-fab-viewer.js 996 B 0 B
./.nuxt/dist/client/components/v-sketch-fab-viewer.modern.js 894 B -1 B (0%)
./.nuxt/dist/client/components/v-skip-to-content-container.js 888 B +1 B (0%)
./.nuxt/dist/client/components/v-skip-to-content-container.modern.js 894 B 0 B
./.nuxt/dist/client/components/v-snackbar.js 1.18 kB +2 B (0%)
./.nuxt/dist/client/components/v-snackbar.modern.js 1.19 kB -2 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 0 B
./.nuxt/dist/client/pages/about.js 1.14 kB 0 B
./.nuxt/dist/client/pages/about.modern.js 1.14 kB 0 B
./.nuxt/dist/client/pages/external-sources.js 1.52 kB +1 B (0%)
./.nuxt/dist/client/pages/external-sources.modern.js 1.53 kB -2 B (0%)
./.nuxt/dist/client/pages/feedback.js 1.31 kB +2 B (0%)
./.nuxt/dist/client/pages/feedback.modern.js 1.31 kB 0 B
./.nuxt/dist/client/pages/index.js 5.06 kB 0 B
./.nuxt/dist/client/pages/index.modern.js 4.93 kB +3 B (0%)
./.nuxt/dist/client/pages/preferences.modern.js 1.2 kB +1 B (0%)
./.nuxt/dist/client/pages/search-help.js 1.62 kB -2 B (0%)
./.nuxt/dist/client/pages/search-help.modern.js 1.62 kB +1 B (0%)
./.nuxt/dist/client/pages/search.js 2.72 kB 0 B
./.nuxt/dist/client/pages/search.modern.js 2.57 kB -1 B (0%)
./.nuxt/dist/client/pages/search/audio.modern.js 3.7 kB -2 B (0%)
./.nuxt/dist/client/pages/search/image.js 2.85 kB +9 B (0%)
./.nuxt/dist/client/pages/search/image.modern.js 2.73 kB +3 B (0%)
./.nuxt/dist/client/pages/search/index.js 543 B +2 B (0%)
./.nuxt/dist/client/pages/search/index.modern.js 548 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 246 B 0 B
./.nuxt/dist/client/pages/search/search-page.types.js 266 B +1 B (0%)
./.nuxt/dist/client/pages/search/search-page.types.modern.js 270 B 0 B
./.nuxt/dist/client/pages/search/video.js 239 B -1 B (0%)
./.nuxt/dist/client/pages/search/video.modern.js 243 B 0 B
./.nuxt/dist/client/pages/sources.js 1.51 kB -7 B (0%)
./.nuxt/dist/client/pages/sources.modern.js 1.51 kB +1 B (0%)
./.nuxt/dist/client/vendors/app.modern.js 61.9 kB -6 B (0%)

compressed-size-action

@dhruvkb dhruvkb marked this pull request as ready for review November 17, 2022 01:27
@dhruvkb dhruvkb requested a review from a team as a code owner November 17, 2022 01:27
@dhruvkb dhruvkb requested review from zackkrida and obulat November 17, 2022 01:27
Copy link
Contributor

@obulat obulat left a comment

Choose a reason for hiding this comment

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

When I checked out this PR, and ran Playwright tests without running pnpm dev first, I get errors locally because the en.json5 was updated, but en.json wasn't.
If we add pnpm run i18n:get-translations --en-only to playwright.sh, we'll always update the generated json file before running the tests.

Copy link
Contributor

@obulat obulat left a comment

Choose a reason for hiding this comment

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

I think it would make sense to remove the px-6 padding from the Nuxt component as it will simplify layout.
Also, could you please add a VR test for the single result pages (ideally, for both old and new header, but even only new header would be great)?

src/pages/audio/_id.vue Outdated Show resolved Hide resolved
@dhruvkb dhruvkb requested a review from obulat November 21, 2022 05:11
@@ -1,10 +1,10 @@
<template>
<!-- @todo: Separate the absolute container from the link itself. -->
<VLink
class="flex flex-row items-center px-2 py-3 text-xs font-semibold text-dark-charcoal md:px-6 md:pt-4 md:pb-2 md:text-sr"
:href="path"
class="time inline-flex flex-row items-center gap-2 rounded-sm p-2 text-xs font-semibold text-dark-charcoal-70 pe-3 hover:text-dark-charcoal"
Copy link
Member

Choose a reason for hiding this comment

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

What is the "time" CSS class?

Copy link
Member Author

Choose a reason for hiding this comment

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

That's the name of the font styled used by @panchovm in the Figma mockups. If I had to guess, it started as the font-style used in the audio timestamps but then found use in other places without updating the name.

Choose a reason for hiding this comment

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

I think you are referring to the Time pill component. I am seeing the Design Library and that is the only component named like that and used in all audio component's variants.

CleanShot 2022-11-22 at 10 12 20@2x

Copy link
Member Author

Choose a reason for hiding this comment

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

I was referring to this:
Screenshot 2022-11-22 at 8 01 29 PM

Choose a reason for hiding this comment

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

Oh, I got it. And yes, it was named time as it was created for the time pill.

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.

The snapshots look good. I really like these new styles and the alignment of the button.

I did notice one small bug; when the new header is disabled and there's no back to search link the image is missing 48px of top padding:

CleanShot 2022-11-21 at 13 28 58

@dhruvkb dhruvkb requested a review from zackkrida November 22, 2022 11:37
@obulat
Copy link
Contributor

obulat commented Nov 22, 2022

Snapshots are great! I can see a couple of problems on the pages:

  1. 'Audio information' and 'Realated Audio' headings are not bold(test/playwright/visual-regression/pages/pages-single-result.spec.ts-snapshots/audio-ltr-from-search-results-lg-linux.png). It would be best to add the same classes as on the image page, replacing this:

    with this:
    <h2 class="heading-6 md:heading-5">

Although we should select a single threshold breakpoint instead of using lg on one page and md on the other.
2. The padding are uneven: Related audio section's horizontal padding are smaller than the padding of other page parts: test/playwright/visual-regression/pages/pages-single-result.spec.ts-snapshots/audio-ltr-from-search-results-sm-linux.png

I'm not sure if it's best to fix here, or to open separate issues, though.

Copy link
Contributor

@obulat obulat left a comment

Choose a reason for hiding this comment

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

Looks great, and it's nice to see the changes in the snapshots!

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.

Works great now. LGTM.

@dhruvkb dhruvkb merged commit fb0ee0e into main Nov 22, 2022
@dhruvkb dhruvkb deleted the white_bg branch November 22, 2022 16:03
github-actions bot pushed a commit that referenced this pull request Nov 22, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Remove grey background behind single result media when the new header is enabled
5 participants