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

Convert VButton, tabs and item group components to script setup #4796

Merged
merged 2 commits into from
Aug 26, 2024

Conversation

obulat
Copy link
Contributor

@obulat obulat commented Aug 21, 2024

Fixes

Related to #4678 by @obulat

Description

This PR converts components such as VButton, VItemGroup (including search types popover), tabs, and brand in the header/footer to script setup.

The following conversions are done:

  • remove defineComponent and returns
  • convert props to defineProps with withDefaults if necessary
  • script setup does not set options.name anymore, so useComponentName doesn't return anything. We could either add useOptions({ name: componentName }) to the components that need the name in the analytics, or send the component name when initializing the useSearchType. I decided to do the latter, to explicitly pass the component name, instead of adding options.name to only a handful of components that need it and making the codebase inconsistent, or adding an unnecessary options to all components.

It also adds a ZIndex type to replace the Vue runtime validators.
LoadingIcon wasn't used, so it was removed.

Testing Instructions

The CI should pass.
Also, the components affected should work correctly:

  • Search types popover
  • Pages menu popover
  • Openverse logo links in the header and the footer
  • Tabs for the attribution
  • Content settings modal tabs
  • Button should work both when it's a button (as in the header content switcher, filter button) and a link (e.g., the Openverse logo link in the header)

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.

@obulat obulat requested a review from a team as a code owner August 21, 2024 17:48
@obulat obulat changed the title Convert more components to script setup Convert more components to script setup (13) Aug 21, 2024
@openverse-bot openverse-bot added 🧱 stack: frontend Related to the Nuxt frontend 🚦 status: awaiting triage Has not been triaged & therefore, not ready for work 🏷 status: label work required Needs proper labelling before it can be worked on labels Aug 21, 2024
@obulat obulat added 🟨 priority: medium Not blocking but should be addressed soon 💻 aspect: code Concerns the software code in the repository 🧰 goal: internal improvement Improvement that benefits maintainers, not users and removed 🏷 status: label work required Needs proper labelling before it can be worked on 🚦 status: awaiting triage Has not been triaged & therefore, not ready for work labels Aug 21, 2024
@obulat obulat self-assigned this Aug 21, 2024
@obulat obulat marked this pull request as draft August 21, 2024 18:11
@obulat obulat force-pushed the script-setup/other-components branch 3 times, most recently from 74dc793 to 783492e Compare August 21, 2024 19:00
@obulat obulat marked this pull request as ready for review August 21, 2024 19:00
@obulat obulat changed the title Convert more components to script setup (13) Convert more components to script setup Aug 21, 2024
@obulat obulat force-pushed the script-setup/other-components branch 2 times, most recently from 1dbfd05 to 49ace42 Compare August 22, 2024 04:27
@obulat obulat changed the title Convert more components to script setup Convert VButton, tabs and item group components to script setup Aug 22, 2024
@obulat obulat force-pushed the script-setup/other-components branch 2 times, most recently from 260b217 to 0fff962 Compare August 22, 2024 08:22
@obulat obulat force-pushed the script-setup/other-components branch from 9e84890 to 4196d75 Compare August 26, 2024 11:03
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.

Nice work! LGTM.

@obulat obulat merged commit d1bcd64 into main Aug 26, 2024
45 checks passed
@obulat obulat deleted the script-setup/other-components branch August 26, 2024 14:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
💻 aspect: code Concerns the software code in the repository 🧰 goal: internal improvement Improvement that benefits maintainers, not users 🟨 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.

3 participants