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

Refactor SearchTypePopover desktop header #1842

Merged
merged 5 commits into from
Sep 29, 2022
Merged

Conversation

obulat
Copy link
Contributor

@obulat obulat commented Sep 21, 2022

Fixes

Fixes #1836 by @obulat

Description

This PR creates a VHeaderDesktop component that will be used on widths above lg. It refactors the VSearchTypePopover to only open the popover (so, it removes the modal). It also refactors the desktop filters button to only open the sidebar.

This PR adds an IsMinScreenLg provide value in the default.vue layout that is set to true only after the layout was mounted. This enables us to have components rendered conditionally (with v-if) without getting the server and client mismatch on rendering.

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 21, 2022 09:39
@github-actions
Copy link

github-actions bot commented Sep 21, 2022

Storybook and Tailwind configuration previews: Ready

Storybook: https://wordpress.github.io/openverse-frontend/_preview/1842
Tailwind: https://wordpress.github.io/openverse-frontend/_preview/1842/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.

@obulat obulat added this to the Create new header and footer milestone Sep 21, 2022
@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 Sep 21, 2022
@github-actions
Copy link

github-actions bot commented Sep 21, 2022

Size Change: -185 B (0%)

Total Size: 814 kB

Filename Size Change
./.nuxt/dist/client/229.js 0 B -272 B (removed) 🏆
./.nuxt/dist/client/229.modern.js 0 B -277 B (removed) 🏆
./.nuxt/dist/client/230.js 0 B -1.85 kB (removed) 🏆
./.nuxt/dist/client/app.js 127 kB -187 B (0%)
./.nuxt/dist/client/app.modern.js 119 kB +36 B (0%)
./.nuxt/dist/client/components/v-sources-table.js 15.1 kB +16 B (0%)
./.nuxt/dist/client/components/v-sources-table.modern.js 15.1 kB +14 B (0%)
./.nuxt/dist/client/runtime.js 2.65 kB -51 B (-2%)
./.nuxt/dist/client/runtime.modern.js 2.65 kB -51 B (-2%)
./.nuxt/dist/client/vendors/app.js 47.9 kB +77 B (0%)
./.nuxt/dist/client/vendors/app.modern.js 47 kB -10 B (0%)
./.nuxt/dist/client/219.js 272 B +272 B (new file) 🆕
./.nuxt/dist/client/219.modern.js 277 B +277 B (new file) 🆕
./.nuxt/dist/client/220.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 +2 B (0%)
./.nuxt/dist/client/components/loading-icon.js 746 B +1 B (0%)
./.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 512 B -1 B (0%)
./.nuxt/dist/client/components/v-all-results-grid.js 2.77 kB +1 B (0%)
./.nuxt/dist/client/components/v-all-results-grid.modern.js 2.75 kB +1 B (0%)
./.nuxt/dist/client/components/v-all-results-grid/pages/search/audio/pages/search/index.js 3.02 kB +1 B (0%)
./.nuxt/dist/client/components/v-all-results-grid/pages/search/audio/pages/search/index.modern.js 2.92 kB -2 B (0%)
./.nuxt/dist/client/components/v-audio-cell.js 357 B +1 B (0%)
./.nuxt/dist/client/components/v-audio-cell.modern.js 359 B -2 B (-1%)
./.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 -2 B (0%)
./.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 -1 B (0%)
./.nuxt/dist/client/components/v-audio-track.js 5.12 kB +1 B (0%)
./.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 570 B +1 B (0%)
./.nuxt/dist/client/components/v-back-to-search-results-link.modern.js 573 B -1 B (0%)
./.nuxt/dist/client/components/v-bone.js 684 B 0 B
./.nuxt/dist/client/components/v-bone.modern.js 688 B -1 B (0%)
./.nuxt/dist/client/components/v-box-layout.js 1.2 kB +1 B (0%)
./.nuxt/dist/client/components/v-box-layout.modern.js 1.2 kB -1 B (0%)
./.nuxt/dist/client/components/v-content-link.js 1.13 kB 0 B
./.nuxt/dist/client/components/v-content-link.modern.js 1.11 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 772 B -1 B (0%)
./.nuxt/dist/client/components/v-content-report-form.js 3.77 kB -5 B (0%)
./.nuxt/dist/client/components/v-content-report-form.modern.js 3.58 kB -1 B (0%)
./.nuxt/dist/client/components/v-content-report-popover.js 4.45 kB -4 B (0%)
./.nuxt/dist/client/components/v-content-report-popover.modern.js 4.26 kB +5 B (0%)
./.nuxt/dist/client/components/v-content-settings-button.js 689 B -1 B (0%)
./.nuxt/dist/client/components/v-content-settings-button.modern.js 694 B 0 B
./.nuxt/dist/client/components/v-copy-button.js 3.97 kB -2 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.95 kB +1 B (0%)
./.nuxt/dist/client/components/v-copy-license.modern.js 2.93 kB -2 B (0%)
./.nuxt/dist/client/components/v-copy-license/components/v-error-image/components/v-media-reuse/components/v-search-grid/09090664.js 9.68 kB +4 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.66 kB -2 B (0%)
./.nuxt/dist/client/components/v-dmca-notice.js 749 B 0 B
./.nuxt/dist/client/components/v-dmca-notice.modern.js 750 B +1 B (0%)
./.nuxt/dist/client/components/v-error-image.js 1.69 kB -2 B (0%)
./.nuxt/dist/client/components/v-error-image.modern.js 1.68 kB -1 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-full-layout.js 1.48 kB 0 B
./.nuxt/dist/client/components/v-full-layout.modern.js 1.48 kB +2 B (0%)
./.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 -2 B (0%)
./.nuxt/dist/client/components/v-image-cell-square.js 1.01 kB -2 B (0%)
./.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.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 -1 B (0%)
./.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 -3 B (0%)
./.nuxt/dist/client/components/v-image-grid.modern.js 2.42 kB -1 B (0%)
./.nuxt/dist/client/components/v-license-tab-panel.js 923 B +2 B (0%)
./.nuxt/dist/client/components/v-license-tab-panel.modern.js 919 B +1 B (0%)
./.nuxt/dist/client/components/v-load-more.js 787 B 0 B
./.nuxt/dist/client/components/v-load-more.modern.js 684 B -1 B (0%)
./.nuxt/dist/client/components/v-media-license.js 798 B 0 B
./.nuxt/dist/client/components/v-media-license.modern.js 808 B +1 B (0%)
./.nuxt/dist/client/components/v-media-reuse.js 1.08 kB +1 B (0%)
./.nuxt/dist/client/components/v-media-reuse.modern.js 1.08 kB +1 B (0%)
./.nuxt/dist/client/components/v-media-reuse/pages/image/_id.js 2.95 kB +1 B (0%)
./.nuxt/dist/client/components/v-media-reuse/pages/image/_id.modern.js 2.93 kB -2 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-meta-search-form.js 3.1 kB 0 B
./.nuxt/dist/client/components/v-meta-search-form.modern.js 3.07 kB +1 B (0%)
./.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 +3 B (0%)
./.nuxt/dist/client/components/v-no-results.js 2.76 kB -1 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 +2 B (0%)
./.nuxt/dist/client/components/v-radio.modern.js 1.47 kB 0 B
./.nuxt/dist/client/components/v-related-audio.js 1.23 kB +1 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 -3 B (0%)
./.nuxt/dist/client/components/v-related-images.modern.js 2.98 kB -1 B (0%)
./.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 +2 B (0%)
./.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.44 kB -3 B (0%)
./.nuxt/dist/client/components/v-search-grid.modern.js 5.39 kB +3 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 0 B
./.nuxt/dist/client/components/v-search-type-radio.js 830 B -1 B (0%)
./.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 894 B +1 B (0%)
./.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-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 -1 B (0%)
./.nuxt/dist/client/components/v-tab.modern.js 1.71 kB -5 B (0%)
./.nuxt/dist/client/components/v-tabs.js 780 B +1 B (0%)
./.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.05 kB 0 B
./.nuxt/dist/client/pages/about.modern.js 1.06 kB 0 B
./.nuxt/dist/client/pages/audio/_id.js 6.62 kB -1 B (0%)
./.nuxt/dist/client/pages/audio/_id.modern.js 6.45 kB -5 B (0%)
./.nuxt/dist/client/pages/feedback.js 3.23 kB -2 B (0%)
./.nuxt/dist/client/pages/feedback.modern.js 3.21 kB -1 B (0%)
./.nuxt/dist/client/pages/image/_id.js 6.99 kB -6 B (0%)
./.nuxt/dist/client/pages/image/_id.modern.js 6.77 kB +3 B (0%)
./.nuxt/dist/client/pages/index.js 5.05 kB -2 B (0%)
./.nuxt/dist/client/pages/index.modern.js 4.94 kB 0 B
./.nuxt/dist/client/pages/meta-search.js 1.67 kB -2 B (0%)
./.nuxt/dist/client/pages/meta-search.modern.js 1.67 kB +2 B (0%)
./.nuxt/dist/client/pages/preferences.js 1.21 kB 0 B
./.nuxt/dist/client/pages/preferences.modern.js 1.21 kB -2 B (0%)
./.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 0 B
./.nuxt/dist/client/pages/search.modern.js 2.58 kB +1 B (0%)
./.nuxt/dist/client/pages/search/audio.js 1.19 kB +2 B (0%)
./.nuxt/dist/client/pages/search/audio.modern.js 1.19 kB +2 B (0%)
./.nuxt/dist/client/pages/search/image.js 2.78 kB -3 B (0%)
./.nuxt/dist/client/pages/search/image.modern.js 2.67 kB -1 B (0%)
./.nuxt/dist/client/pages/search/index.js 2.99 kB 0 B
./.nuxt/dist/client/pages/search/index.modern.js 2.96 kB -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 0 B
./.nuxt/dist/client/pages/search/search-page.types.modern.js 270 B 0 B
./.nuxt/dist/client/pages/search/video.js 240 B +1 B (0%)
./.nuxt/dist/client/pages/search/video.modern.js 244 B +1 B (0%)
./.nuxt/dist/client/pages/sources.js 1.44 kB -1 B (0%)
./.nuxt/dist/client/pages/sources.modern.js 1.45 kB 0 B

compressed-size-action

@WordPress WordPress deleted a comment from github-actions bot Sep 22, 2022
@obulat obulat requested a review from dhruvkb September 22, 2022 05:35
@obulat obulat self-assigned this Sep 22, 2022
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 search bar in VHeaderDesktop appears to fill all available space; is that the correct behavior or is it meant to have a max-width?
  • I don't think it matters since this will be replaced, but there's a slight alignment problem in a medium breakpoint:

CleanShot 2022-09-22 at 14 20 20@2x

- It occurred to me that I don't think we even need JavaScript to switch between the different headers. A naive CSS approach seems to work fine and avoid the whole hydration mismatch, forced re-render problem.
<div class="hidden lg:block">
  <VHeaderDesktop />
</div>
<div class="block lg:hidden">
  <VHeader />
</div>

@obulat
Copy link
Contributor Author

obulat commented Sep 23, 2022

  • The search bar in VHeaderDesktop appears to fill all available space; is that the correct behavior or is it meant to have a max-width?

    • I don't think it matters since this will be replaced, but there's a slight alignment problem in a medium breakpoint:

The main goal of this PR is to get rid of the components that have duplicate names, and to separate the two header components (mobile and desktop). The styling changes will be fixed in later PRs. Otherwise, this PR will probably be too big.

  • It occurred to me that I don't think we even need JavaScript to switch between the different headers. A naive CSS approach seems to work fine and avoid the whole hydration mismatch, forced re-render problem.
<div class="hidden lg:block">
  <VHeaderDesktop />
</div>
<div class="block lg:hidden">
  <VHeader />
</div>

The current solution has the following downsides:

There are a couple of downsides to this CSS solution:

  • On the mobile breakpoint, this will be downloading all of the components, both mobile and desktop, and will probably degrade the mobile performance.
  • For the search bar components, there will be id duplication, or we would have to set separate ids for mobile and desktop search inputs.

I was mainly trying to optimize for the mobile experience/performance because mobile usually has lower bandwidths. Do you think it's better to use CSS, @zackkrida, and reduce the need for JS hacks?

@zackkrida
Copy link
Member

@obulat I think we can follow your solution instead of a CSS approach. We can use the session cookie approach later to fix any visual flashes. Your point about the bundle size is a good one.

@zackkrida zackkrida self-requested a review September 26, 2022 18:43
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 and get those components removed.

@zackkrida zackkrida removed the request for review from sarayourfriend September 27, 2022 19:20
@obulat obulat force-pushed the add/desktop_content_settings branch from 12acc1e to 0ba8a51 Compare September 28, 2022 04:44
@obulat obulat changed the title Refactor SearchTypePopover and filter button for desktop header Refactor SearchTypePopover desktop header Sep 28, 2022
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.

LGTM!

}"
aria-hidden="true"
:data-prefers-reduced-motion="prefersReducedMotion"
data-testid="logo-loader"
class="inline-flex h-12 w-12 items-center justify-center rounded p-3 md:h-12 md:w-12"
class="inline-flex items-center justify-center rounded p-3 md:h-12 md:w-12"
Copy link
Member

Choose a reason for hiding this comment

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

Do the md: height and width classes not need to be moved?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Moved to the beginning of the class list? I think the prefixed classes are always at the end.

@obulat obulat merged commit 38acffa into main Sep 29, 2022
@obulat obulat deleted the add/desktop_content_settings branch September 29, 2022 07:32
github-actions bot pushed a commit that referenced this pull request Sep 29, 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.

Refactor the SearchType popover (desktop) for the new header
4 participants