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

Fix content switcher in the search page header #4933

Merged
merged 1 commit into from
Sep 16, 2024
Merged

Conversation

obulat
Copy link
Contributor

@obulat obulat commented Sep 16, 2024

Fixes

Fixes #4925 by @obulat

Description

This PR fixes the bug where the content switcher would keep opening and closing once you click on it.

The cause of this bug is interesting. The VHeaderDesktop set the placement prop to VSearchTypePopover to header or searchbar to compute whether we should use links or buttons for the different search types. Then, in #4841, the prop was removed from the child VSearchTypePopover component as unnecessary. However, it wasn't removed from the parent, VHeaderDesktop. This means, that the parent was still passing the placement, but now as an attr. And in Vue3, an attr will override the prop set in the child component 1. The child component was using the same name, placement, for the prop to pass to the floating-ui library to position the search type popover. The overriden value, header, was, however, invalid for the floating-ui, so it was causing the constant repositioning of the popover.

Testing Instructions

Go to staging, https://staging.openverse.org/search?q=cat and try to open the content switcher in the header. You will see the flickering from the related issue.
Run the app in this branch, and open the content switcher. It will open and close correctly.

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 (ov just catalog/generate-docs for catalog
    PRs) or the media properties generator (ov just catalog/generate-docs media-props
    for the catalog or ov just api/generate-docs for the API) where 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.

Footnotes

  1. https://github.com/vuejs/core/issues/9039

@obulat obulat marked this pull request as ready for review September 16, 2024 09:03
@obulat obulat requested a review from a team as a code owner September 16, 2024 09:03
@openverse-bot openverse-bot added 🧱 stack: frontend Related to the Nuxt frontend 🟥 priority: critical Must be addressed ASAP 🛠 goal: fix Bug fix 🕹 aspect: interface Concerns end-users' experience with the software labels Sep 16, 2024
@obulat obulat merged commit 849a493 into main Sep 16, 2024
72 of 76 checks passed
@obulat obulat deleted the fix/search-type-popover branch September 16, 2024 09:18
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: fix Bug fix 🟥 priority: critical Must be addressed ASAP 🧱 stack: frontend Related to the Nuxt frontend
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

The content switcher in the header is broken
3 participants