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

Create a new VIconButton #2697

Merged
merged 6 commits into from
Jul 27, 2023
Merged

Create a new VIconButton #2697

merged 6 commits into from
Jul 27, 2023

Conversation

obulat
Copy link
Contributor

@obulat obulat commented Jul 21, 2023

Fixes

Related to #460 by @fcoveram

Description

This PR adds a new VIconButton component using the updated styles in the Figma mockups

The old styles for VIconButton were used mainly in the popover/modal close buttons, audio controls and the buttons within the search bar. They will gradually be updated to use the new VIconButton.

Testing Instructions

Check out the new VIconButton story. It should have all of the styles from the Figma mockup. Old buttons (listed above) should also look the same.

Check the rendered Story: https://docs.openverse.org/_preview/2697/storybook/?path=/docs/components-viconbutton--default-story

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 self-assigned this Jul 21, 2023
@github-actions github-actions bot added 🧱 stack: documentation Related to Sphinx documentation 🧱 stack: frontend Related to the Nuxt frontend labels Jul 21, 2023
@obulat obulat force-pushed the add/new_icon_button branch from e258c38 to ee7863b Compare July 21, 2023 17:52
@openverse-bot openverse-bot added the 🚦 status: awaiting triage Has not been triaged & therefore, not ready for work label Jul 21, 2023
@github-actions
Copy link

github-actions bot commented Jul 21, 2023

Size Change: +1.4 kB (0%)

Total Size: 839 kB

Filename Size Change
./frontend/.nuxt/dist/client/232.js 0 B -273 B (removed) 🏆
./frontend/.nuxt/dist/client/232.modern.js 0 B -277 B (removed) 🏆
./frontend/.nuxt/dist/client/233.js 273 B -1.58 kB (-85%) 🏆
./frontend/.nuxt/dist/client/app.js 122 kB +196 B (0%)
./frontend/.nuxt/dist/client/app.modern.js 113 kB +122 B (0%)
./frontend/.nuxt/dist/client/runtime.js 2.7 kB +13 B (0%)
./frontend/.nuxt/dist/client/runtime.modern.js 2.71 kB +14 B (+1%)
./frontend/.nuxt/dist/client/233.modern.js 277 B +277 B (new file) 🆕
./frontend/.nuxt/dist/client/234.js 1.85 kB +1.85 kB (new file) 🆕
./frontend/.nuxt/dist/client/components/v-icon-button.js 523 B +523 B (new file) 🆕
./frontend/.nuxt/dist/client/components/v-icon-button.modern.js 527 B +527 B (new file) 🆕
ℹ️ View Unchanged
Filename Size Change
./frontend/.nuxt/dist/client/commons/app.js 90.2 kB -4 B (0%)
./frontend/.nuxt/dist/client/commons/app.modern.js 80.8 kB 0 B
./frontend/.nuxt/dist/client/commons/components/v-search-grid/pages/search.js 5.17 kB -1 B (0%)
./frontend/.nuxt/dist/client/commons/components/v-search-grid/pages/search.modern.js 5.61 kB 0 B
./frontend/.nuxt/dist/client/components/loading-icon.js 731 B 0 B
./frontend/.nuxt/dist/client/components/loading-icon.modern.js 733 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 518 B 0 B
./frontend/.nuxt/dist/client/components/v-all-results-grid.js 6.53 kB +1 B (0%)
./frontend/.nuxt/dist/client/components/v-all-results-grid.modern.js 6.36 kB 0 B
./frontend/.nuxt/dist/client/components/v-audio-cell.js 571 B 0 B
./frontend/.nuxt/dist/client/components/v-audio-cell.modern.js 576 B 0 B
./frontend/.nuxt/dist/client/components/v-audio-details.js 1.79 kB 0 B
./frontend/.nuxt/dist/client/components/v-audio-details.modern.js 1.77 kB 0 B
./frontend/.nuxt/dist/client/components/v-audio-track-skeleton.js 959 B 0 B
./frontend/.nuxt/dist/client/components/v-audio-track-skeleton.modern.js 961 B 0 B
./frontend/.nuxt/dist/client/components/v-audio-track.js 5.38 kB +4 B (0%)
./frontend/.nuxt/dist/client/components/v-audio-track.modern.js 5.35 kB +1 B (0%)
./frontend/.nuxt/dist/client/components/v-back-to-search-results-link.js 636 B 0 B
./frontend/.nuxt/dist/client/components/v-back-to-search-results-link.modern.js 641 B 0 B
./frontend/.nuxt/dist/client/components/v-bone.js 632 B 0 B
./frontend/.nuxt/dist/client/components/v-bone.modern.js 636 B 0 B
./frontend/.nuxt/dist/client/components/v-box-layout.js 1.33 kB 0 B
./frontend/.nuxt/dist/client/components/v-box-layout.modern.js 1.33 kB 0 B
./frontend/.nuxt/dist/client/components/v-content-link.js 1.06 kB 0 B
./frontend/.nuxt/dist/client/components/v-content-link.modern.js 1.06 kB 0 B
./frontend/.nuxt/dist/client/components/v-content-page.js 530 B 0 B
./frontend/.nuxt/dist/client/components/v-content-page.modern.js 536 B 0 B
./frontend/.nuxt/dist/client/components/v-content-report-button.js 492 B 0 B
./frontend/.nuxt/dist/client/components/v-content-report-button.modern.js 497 B 0 B
./frontend/.nuxt/dist/client/components/v-content-report-form.js 3.33 kB -2 B (0%)
./frontend/.nuxt/dist/client/components/v-content-report-form.modern.js 3.21 kB 0 B
./frontend/.nuxt/dist/client/components/v-content-report-popover.js 3.79 kB -1 B (0%)
./frontend/.nuxt/dist/client/components/v-content-report-popover.modern.js 3.67 kB 0 B
./frontend/.nuxt/dist/client/components/v-copy-button.js 3.99 kB 0 B
./frontend/.nuxt/dist/client/components/v-copy-button.modern.js 4 kB 0 B
./frontend/.nuxt/dist/client/components/v-copy-license.js 2.28 kB -2 B (0%)
./frontend/.nuxt/dist/client/components/v-copy-license.modern.js 2.25 kB 0 B
./frontend/.nuxt/dist/client/components/v-dmca-notice.js 791 B 0 B
./frontend/.nuxt/dist/client/components/v-dmca-notice.modern.js 797 B 0 B
./frontend/.nuxt/dist/client/components/v-error-image.js 2.41 kB -2 B (0%)
./frontend/.nuxt/dist/client/components/v-error-image.modern.js 2.39 kB 0 B
./frontend/.nuxt/dist/client/components/v-error-section.js 373 B 0 B
./frontend/.nuxt/dist/client/components/v-error-section.modern.js 376 B 0 B
./frontend/.nuxt/dist/client/components/v-external-search-form.js 2 kB +1 B (0%)
./frontend/.nuxt/dist/client/components/v-external-search-form.modern.js 1.99 kB 0 B
./frontend/.nuxt/dist/client/components/v-external-source-list.js 895 B +1 B (0%)
./frontend/.nuxt/dist/client/components/v-external-source-list.modern.js 896 B 0 B
./frontend/.nuxt/dist/client/components/v-full-layout.js 1.57 kB 0 B
./frontend/.nuxt/dist/client/components/v-full-layout.modern.js 1.58 kB 0 B
./frontend/.nuxt/dist/client/components/v-grid-skeleton.js 1.54 kB 0 B
./frontend/.nuxt/dist/client/components/v-grid-skeleton.modern.js 1.54 kB 0 B
./frontend/.nuxt/dist/client/components/v-home-gallery.js 4.28 kB 0 B
./frontend/.nuxt/dist/client/components/v-home-gallery.modern.js 4.26 kB 0 B
./frontend/.nuxt/dist/client/components/v-homepage-content.js 1.8 kB +2 B (0%)
./frontend/.nuxt/dist/client/components/v-homepage-content.modern.js 1.77 kB 0 B
./frontend/.nuxt/dist/client/components/v-image-cell.js 1.96 kB +2 B (0%)
./frontend/.nuxt/dist/client/components/v-image-cell.modern.js 1.94 kB +1 B (0%)
./frontend/.nuxt/dist/client/components/v-image-details.js 1.44 kB -1 B (0%)
./frontend/.nuxt/dist/client/components/v-image-details.modern.js 1.43 kB 0 B
./frontend/.nuxt/dist/client/components/v-image-grid.js 4.42 kB 0 B
./frontend/.nuxt/dist/client/components/v-image-grid.modern.js 4.29 kB 0 B
./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 649 B 0 B
./frontend/.nuxt/dist/client/components/v-load-more.js 1.17 kB 0 B
./frontend/.nuxt/dist/client/components/v-load-more.modern.js 1.06 kB 0 B
./frontend/.nuxt/dist/client/components/v-media-license.js 932 B 0 B
./frontend/.nuxt/dist/client/components/v-media-license.modern.js 939 B 0 B
./frontend/.nuxt/dist/client/components/v-media-reuse.js 2.93 kB -1 B (0%)
./frontend/.nuxt/dist/client/components/v-media-reuse.modern.js 2.91 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 996 B +1 B (0%)
./frontend/.nuxt/dist/client/components/v-no-results.js 855 B 0 B
./frontend/.nuxt/dist/client/components/v-no-results.modern.js 857 B 0 B
./frontend/.nuxt/dist/client/components/v-radio.js 1 kB 0 B
./frontend/.nuxt/dist/client/components/v-radio.modern.js 1.01 kB 0 B
./frontend/.nuxt/dist/client/components/v-related-audio.js 1.73 kB 0 B
./frontend/.nuxt/dist/client/components/v-related-audio.modern.js 1.64 kB 0 B
./frontend/.nuxt/dist/client/components/v-related-images.js 806 B 0 B
./frontend/.nuxt/dist/client/components/v-related-images.modern.js 718 B 0 B
./frontend/.nuxt/dist/client/components/v-report-desc-form.js 975 B -1 B (0%)
./frontend/.nuxt/dist/client/components/v-report-desc-form.modern.js 980 B 0 B
./frontend/.nuxt/dist/client/components/v-row-layout.js 1.72 kB -1 B (0%)
./frontend/.nuxt/dist/client/components/v-row-layout.modern.js 1.73 kB 0 B
./frontend/.nuxt/dist/client/components/v-scroll-button.js 891 B 0 B
./frontend/.nuxt/dist/client/components/v-scroll-button.modern.js 892 B 0 B
./frontend/.nuxt/dist/client/components/v-search-grid.js 6.82 kB -1 B (0%)
./frontend/.nuxt/dist/client/components/v-search-grid.modern.js 6.18 kB 0 B
./frontend/.nuxt/dist/client/components/v-search-results-title.js 618 B 0 B
./frontend/.nuxt/dist/client/components/v-search-results-title.modern.js 621 B 0 B
./frontend/.nuxt/dist/client/components/v-server-timeout.js 298 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 915 B 0 B
./frontend/.nuxt/dist/client/components/v-snackbar.js 1.06 kB 0 B
./frontend/.nuxt/dist/client/components/v-snackbar.modern.js 1.07 kB 0 B
./frontend/.nuxt/dist/client/components/v-sources-table.js 14.3 kB 0 B
./frontend/.nuxt/dist/client/components/v-sources-table.modern.js 14.4 kB 0 B
./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.42 kB 0 B
./frontend/.nuxt/dist/client/pages/about.modern.js 1.42 kB +1 B (0%)
./frontend/.nuxt/dist/client/pages/audio/_id/index.js 6.72 kB 0 B
./frontend/.nuxt/dist/client/pages/audio/_id/index.modern.js 6.57 kB +2 B (0%)
./frontend/.nuxt/dist/client/pages/feedback.js 1.36 kB -1 B (0%)
./frontend/.nuxt/dist/client/pages/feedback.modern.js 1.36 kB 0 B
./frontend/.nuxt/dist/client/pages/image/_id/index.js 7.04 kB +1 B (0%)
./frontend/.nuxt/dist/client/pages/image/_id/index.modern.js 6.87 kB 0 B
./frontend/.nuxt/dist/client/pages/image/_id/report.js 4.89 kB 0 B
./frontend/.nuxt/dist/client/pages/image/_id/report.modern.js 4.67 kB 0 B
./frontend/.nuxt/dist/client/pages/index.js 6.34 kB 0 B
./frontend/.nuxt/dist/client/pages/index.modern.js 6.3 kB 0 B
./frontend/.nuxt/dist/client/pages/preferences.js 1.32 kB 0 B
./frontend/.nuxt/dist/client/pages/preferences.modern.js 1.31 kB 0 B
./frontend/.nuxt/dist/client/pages/privacy.js 1.26 kB 0 B
./frontend/.nuxt/dist/client/pages/privacy.modern.js 1.26 kB 0 B
./frontend/.nuxt/dist/client/pages/search-help.js 1.62 kB 0 B
./frontend/.nuxt/dist/client/pages/search-help.modern.js 1.61 kB 0 B
./frontend/.nuxt/dist/client/pages/search.js 2.25 kB 0 B
./frontend/.nuxt/dist/client/pages/search.modern.js 2.06 kB 0 B
./frontend/.nuxt/dist/client/pages/search/audio.js 4.1 kB +1 B (0%)
./frontend/.nuxt/dist/client/pages/search/audio.modern.js 3.98 kB 0 B
./frontend/.nuxt/dist/client/pages/search/image.js 544 B 0 B
./frontend/.nuxt/dist/client/pages/search/image.modern.js 549 B 0 B
./frontend/.nuxt/dist/client/pages/search/index.js 441 B 0 B
./frontend/.nuxt/dist/client/pages/search/index.modern.js 448 B 0 B
./frontend/.nuxt/dist/client/pages/search/model-3d.js 243 B +1 B (0%)
./frontend/.nuxt/dist/client/pages/search/model-3d.modern.js 247 B +1 B (0%)
./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 244 B 0 B
./frontend/.nuxt/dist/client/pages/sources.js 1.53 kB -1 B (0%)
./frontend/.nuxt/dist/client/pages/sources.modern.js 1.54 kB 0 B
./frontend/.nuxt/dist/client/vendors/app.js 68.3 kB +1 B (0%)
./frontend/.nuxt/dist/client/vendors/app.modern.js 68.1 kB +1 B (0%)

compressed-size-action

@obulat obulat added 🟨 priority: medium Not blocking but should be addressed soon 🌟 goal: addition Addition of new feature 🕹 aspect: interface Concerns end-users' experience with the software and removed 🚦 status: awaiting triage Has not been triaged & therefore, not ready for work labels Jul 21, 2023
@github-actions
Copy link

Full-stack documentation: https://docs.openverse.org/_preview/2697

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 marked this pull request as ready for review July 21, 2023 19:16
@obulat obulat requested a review from a team as a code owner July 21, 2023 19:16
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.

LGTM! It seems like we're losing the tiny and extra-large sizes, is that intentional?

@@ -33,17 +38,20 @@ export const Template = (args) => ({
export const sizesTemplate = (args) => ({
template: `
<div class="flex gap-x-2">
<div v-for="size in ['tiny', 'small', 'medium', 'large', 'extra-large']" :key="size" class="flex flex-col items-center p-2">
<div v-for="size in args.baseButtonSizes" :key="size" class="flex flex-col items-center p-2">
Copy link
Collaborator

Choose a reason for hiding this comment

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

Nice!

@zackkrida
Copy link
Member

@obulat could you clarify the intention of this PR? It creates the new icon button, but doesn't actually implement it anywhere, right? Does that mean that the button styles do need to change in the app (which will require updating visual regression tests) and that we will do that in subsequent PR(s)?

I'm mostly curious about the approach taken and if it would make more sense to create the new VIconButton but backwards-compatible, with the old sizes included (to be deprecated later), rather than maintain two versions for a (likely brief) period.

@obulat obulat force-pushed the add/new_icon_button branch from b6c8276 to bca558e Compare July 26, 2023 12:08
@obulat
Copy link
Contributor Author

obulat commented Jul 26, 2023

LGTM! It seems like we're losing the tiny and extra-large sizes, is that intentional?

Yes! Those sizes were previously used for Audio controls. Now the designs have updated buttons with fewer sizes - that's why we are updating.

@obulat obulat force-pushed the add/new_icon_button branch from bca558e to d2d5df3 Compare July 26, 2023 12:35
@obulat obulat force-pushed the add/new_icon_button branch from d2d5df3 to 44328b2 Compare July 26, 2023 13:37
@obulat
Copy link
Contributor Author

obulat commented Jul 26, 2023

@obulat could you clarify the intention of this PR? It creates the new icon button, but doesn't actually implement it anywhere, right? Does that mean that the button styles do need to change in the app (which will require updating visual regression tests) and that we will do that in subsequent PR(s)?

The VIconButton component is currently used in three ways:

  • close buttons in popover/modals - the external sources popover close button is the use case that prompted this PR
  • VSearchBarButton - these button styles should not be changed, and they can be re-factored to use the new VIconButton because that will simplify the sizes and focus handling.
  • Audio controls - New styles in Audio control component #2602 updates them, but after the designs of the audio track are updated to match them.

The change in "close" buttons will cause changes in the visual regression snapshots.

I'm mostly curious about the approach taken and if it would make more sense to create the new VIconButton but backwards-compatible, with the old sizes included (to be deprecated later), rather than maintain two versions for a (likely brief) period.

Current component (VOldIconButton) has a very complicated sizes system: we have to set both the icon and the button size, and they are coupled together, so there are too many sizes and they are still not enough to match all of the buttons we use.
After the update to VSearchBarButton, we can audit the close buttons used throughout the app in one go (updating the snapshots), and then VOldIconButton will be completely removed in the PR that updates the Audio control.

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 great ✨ 🚀

I noticed two prop variants I wasn't aware of, but do not block the work made: filled-transparent and transparent-tx. The first one is also an oxymoron 😅

@obulat obulat merged commit 969f75b into main Jul 27, 2023
@obulat obulat deleted the add/new_icon_button branch July 27, 2023 09:08
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: addition Addition of new feature 🟨 priority: medium Not blocking but should be addressed soon 🧱 stack: documentation Related to Sphinx documentation 🧱 stack: frontend Related to the Nuxt frontend
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

5 participants