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

Audit VIconButton sizes and props #1928

Merged
merged 3 commits into from
Oct 27, 2022
Merged

Audit VIconButton sizes and props #1928

merged 3 commits into from
Oct 27, 2022

Conversation

obulat
Copy link
Contributor

@obulat obulat commented Oct 20, 2022

Fixes

Fixes #1894 by @obulat

Description

This PR is an alternative to #1895. It keeps using the size prop because otherwise, we would have to use classes like !w-4 to override the default icon size, or not have a default icon size and add size classes to every VIcon..

This PR audits all the VIconButtons:

  • The number of sizes is now down to 6:
  tiny: { icon: 6, button: 'w-6 h-6' },
  small: { icon: 6, button: 'w-10 h-10' },
  medium: { icon: 6, button: 'w-12 h-12' },
  larger: { icon: 8, button: 'w-14 h-14' },
  large: { icon: 12, button: 'w-20 h-20' },

There is a Storybook VR test for VIconButton sizes.

  • Unnecessary button-props declarations are re-written. There's no need to pass aria-label or variant="plain" to button-props because the first can be passed directly to the VIconButton, and the second is the default.

This PR also adds a Storybook story for VSearchBarButton; replaces VClearButton with a VSearchBarButton in the desktop search bar.

Testing Instructions

The CI should pass, including all the audio VR tests that use various sizes of VIconButton, and all of the Storybook tests.

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 October 20, 2022 10:48
@obulat obulat requested review from zackkrida and dhruvkb October 20, 2022 10:48
@github-actions
Copy link

github-actions bot commented Oct 20, 2022

Storybook and Tailwind configuration previews: Ready

Storybook: https://wordpress.github.io/openverse-frontend/_preview/1928
Tailwind: https://wordpress.github.io/openverse-frontend/_preview/1928/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 changed the title Re add size to vicon Add VSearchBarButton stories, tests, and additional sizes to VIcon Oct 20, 2022
@openverse-bot openverse-bot added ✨ goal: improvement Improvement to an existing user-facing feature 💻 aspect: code Concerns the software code in the repository 🟧 priority: high Stalls work on the project or its dependents labels Oct 20, 2022
@github-actions
Copy link

github-actions bot commented Oct 20, 2022

Size Change: -3.4 kB (0%)

Total Size: 811 kB

Filename Size Change
./.nuxt/dist/client/224.js 0 B -272 B (removed) 🏆
./.nuxt/dist/client/224.modern.js 0 B -277 B (removed) 🏆
./.nuxt/dist/client/225.js 0 B -1.85 kB (removed) 🏆
./.nuxt/dist/client/app.js 130 kB -1.37 kB (-1%)
./.nuxt/dist/client/app.modern.js 121 kB -1.57 kB (-1%)
./.nuxt/dist/client/commons/app.js 88.1 kB -50 B (0%)
./.nuxt/dist/client/commons/app.modern.js 77 kB -34 B (0%)
./.nuxt/dist/client/components/v-content-report-popover.js 4.41 kB -20 B (0%)
./.nuxt/dist/client/components/v-content-report-popover.modern.js 4.22 kB -17 B (0%)
./.nuxt/dist/client/components/v-external-search-form.js 3.08 kB -26 B (-1%)
./.nuxt/dist/client/components/v-external-search-form.modern.js 3.06 kB -22 B (-1%)
./.nuxt/dist/client/components/v-external-source-list.js 2.54 kB -23 B (-1%)
./.nuxt/dist/client/components/v-external-source-list.modern.js 2.52 kB -23 B (-1%)
./.nuxt/dist/client/components/v-no-results.js 2.75 kB -25 B (-1%)
./.nuxt/dist/client/components/v-no-results.modern.js 2.72 kB -22 B (-1%)
./.nuxt/dist/client/components/v-search-grid.js 5.42 kB -25 B (0%)
./.nuxt/dist/client/components/v-search-grid.modern.js 5.39 kB -21 B (0%)
./.nuxt/dist/client/components/v-sources-table.js 15.7 kB -20 B (0%)
./.nuxt/dist/client/components/v-sources-table.modern.js 15.7 kB -19 B (0%)
./.nuxt/dist/client/pages/image/_id.js 5.23 kB -52 B (-1%)
./.nuxt/dist/client/runtime.js 2.62 kB -49 B (-2%)
./.nuxt/dist/client/runtime.modern.js 2.63 kB -46 B (-2%)
./.nuxt/dist/client/vendors/app.js 57.2 kB +15 B (0%)
./.nuxt/dist/client/vendors/app.modern.js 56.5 kB -21 B (0%)
./.nuxt/dist/client/214.js 272 B +272 B (new file) 🆕
./.nuxt/dist/client/214.modern.js 277 B +277 B (new file) 🆕
./.nuxt/dist/client/215.js 1.85 kB +1.85 kB (new file) 🆕
ℹ️ View Unchanged
Filename Size Change
./.nuxt/dist/client/components/loading-icon.js 744 B -1 B (0%)
./.nuxt/dist/client/components/loading-icon.modern.js 751 B +1 B (0%)
./.nuxt/dist/client/components/table-sort-icon.js 509 B 0 B
./.nuxt/dist/client/components/table-sort-icon.modern.js 513 B +1 B (0%)
./.nuxt/dist/client/components/v-all-results-grid.js 2.76 kB +1 B (0%)
./.nuxt/dist/client/components/v-all-results-grid.modern.js 2.73 kB 0 B
./.nuxt/dist/client/components/v-all-results-grid/pages/search/audio/pages/search/index.js 3.02 kB -3 B (0%)
./.nuxt/dist/client/components/v-all-results-grid/pages/search/audio/pages/search/index.modern.js 2.92 kB -1 B (0%)
./.nuxt/dist/client/components/v-audio-cell.js 356 B -1 B (0%)
./.nuxt/dist/client/components/v-audio-cell.modern.js 359 B -1 B (0%)
./.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 -1 B (0%)
./.nuxt/dist/client/components/v-audio-track-skeleton.js 1.01 kB -2 B (0%)
./.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 +3 B (0%)
./.nuxt/dist/client/components/v-audio-track.modern.js 5.07 kB +5 B (0%)
./.nuxt/dist/client/components/v-back-to-search-results-link.js 537 B 0 B
./.nuxt/dist/client/components/v-back-to-search-results-link.modern.js 541 B 0 B
./.nuxt/dist/client/components/v-bone.js 685 B 0 B
./.nuxt/dist/client/components/v-bone.modern.js 690 B 0 B
./.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.11 kB 0 B
./.nuxt/dist/client/components/v-content-link.modern.js 1.09 kB -1 B (0%)
./.nuxt/dist/client/components/v-content-page.js 467 B +1 B (0%)
./.nuxt/dist/client/components/v-content-page.modern.js 471 B 0 B
./.nuxt/dist/client/components/v-content-report-button.js 776 B -2 B (0%)
./.nuxt/dist/client/components/v-content-report-button.modern.js 784 B +1 B (0%)
./.nuxt/dist/client/components/v-content-report-form.js 3.75 kB 0 B
./.nuxt/dist/client/components/v-content-report-form.modern.js 3.56 kB -1 B (0%)
./.nuxt/dist/client/components/v-copy-button.js 3.97 kB -4 B (0%)
./.nuxt/dist/client/components/v-copy-button.modern.js 3.99 kB 0 B
./.nuxt/dist/client/components/v-copy-license.js 999 B -2 B (0%)
./.nuxt/dist/client/components/v-copy-license.modern.js 1 kB +1 B (0%)
./.nuxt/dist/client/components/v-copy-license/components/v-error-image/components/v-media-reuse/components/v-search-grid/09090664.js 9.5 kB -2 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.48 kB 0 B
./.nuxt/dist/client/components/v-dmca-notice.js 748 B +4 B (+1%)
./.nuxt/dist/client/components/v-dmca-notice.modern.js 752 B -1 B (0%)
./.nuxt/dist/client/components/v-error-image.js 1.69 kB 0 B
./.nuxt/dist/client/components/v-error-image.modern.js 1.68 kB +3 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.49 kB -1 B (0%)
./.nuxt/dist/client/components/v-full-layout.modern.js 1.49 kB +1 B (0%)
./.nuxt/dist/client/components/v-grid-skeleton.js 1.61 kB +1 B (0%)
./.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 +1 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.43 kB 0 B
./.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 0 B
./.nuxt/dist/client/components/v-image-details.modern.js 1.43 kB +1 B (0%)
./.nuxt/dist/client/components/v-image-grid.js 2.53 kB 0 B
./.nuxt/dist/client/components/v-image-grid.modern.js 2.42 kB +1 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 +1 B (0%)
./.nuxt/dist/client/components/v-load-more.modern.js 682 B -1 B (0%)
./.nuxt/dist/client/components/v-media-license.js 800 B +1 B (0%)
./.nuxt/dist/client/components/v-media-license.modern.js 807 B -1 B (0%)
./.nuxt/dist/client/components/v-media-reuse.js 1.63 kB 0 B
./.nuxt/dist/client/components/v-media-reuse.modern.js 1.62 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-radio.js 1.51 kB -1 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 -3 B (0%)
./.nuxt/dist/client/components/v-related-audio.modern.js 1.24 kB +2 B (0%)
./.nuxt/dist/client/components/v-related-images.js 3.1 kB +2 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 967 B +2 B (0%)
./.nuxt/dist/client/components/v-report-desc-form.modern.js 965 B 0 B
./.nuxt/dist/client/components/v-row-layout.js 1.7 kB +3 B (0%)
./.nuxt/dist/client/components/v-row-layout.modern.js 1.71 kB +5 B (0%)
./.nuxt/dist/client/components/v-scroll-button.js 813 B -1 B (0%)
./.nuxt/dist/client/components/v-scroll-button.modern.js 819 B 0 B
./.nuxt/dist/client/components/v-search-results-title.js 658 B 0 B
./.nuxt/dist/client/components/v-search-results-title.modern.js 651 B +1 B (0%)
./.nuxt/dist/client/components/v-search-type-radio.js 795 B +2 B (0%)
./.nuxt/dist/client/components/v-search-type-radio.modern.js 769 B +2 B (0%)
./.nuxt/dist/client/components/v-server-timeout.js 298 B -1 B (0%)
./.nuxt/dist/client/components/v-server-timeout.modern.js 303 B 0 B
./.nuxt/dist/client/components/v-sketch-fab-viewer.js 997 B 0 B
./.nuxt/dist/client/components/v-sketch-fab-viewer.modern.js 895 B -1 B (0%)
./.nuxt/dist/client/components/v-skip-to-content-container.js 889 B +1 B (0%)
./.nuxt/dist/client/components/v-skip-to-content-container.modern.js 892 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-warning-suppressor.js 298 B 0 B
./.nuxt/dist/client/components/v-warning-suppressor.modern.js 302 B 0 B
./.nuxt/dist/client/pages/about.js 1.06 kB +1 B (0%)
./.nuxt/dist/client/pages/about.modern.js 1.07 kB 0 B
./.nuxt/dist/client/pages/audio/_id.js 4.89 kB -1 B (0%)
./.nuxt/dist/client/pages/audio/_id.modern.js 4.73 kB +5 B (0%)
./.nuxt/dist/client/pages/external-sources.js 1.45 kB 0 B
./.nuxt/dist/client/pages/external-sources.modern.js 1.45 kB -1 B (0%)
./.nuxt/dist/client/pages/feedback.js 1.24 kB 0 B
./.nuxt/dist/client/pages/feedback.modern.js 1.24 kB -2 B (0%)
./.nuxt/dist/client/pages/image/_id.modern.js 7.24 kB +9 B (0%)
./.nuxt/dist/client/pages/index.js 5 kB -1 B (0%)
./.nuxt/dist/client/pages/index.modern.js 4.86 kB +3 B (0%)
./.nuxt/dist/client/pages/preferences.js 1.21 kB 0 B
./.nuxt/dist/client/pages/preferences.modern.js 1.21 kB -1 B (0%)
./.nuxt/dist/client/pages/search-help.js 1.55 kB +3 B (0%)
./.nuxt/dist/client/pages/search-help.modern.js 1.55 kB 0 B
./.nuxt/dist/client/pages/search.js 2.75 kB 0 B
./.nuxt/dist/client/pages/search.modern.js 2.59 kB +1 B (0%)
./.nuxt/dist/client/pages/search/audio.js 1.19 kB +1 B (0%)
./.nuxt/dist/client/pages/search/audio.modern.js 1.19 kB +1 B (0%)
./.nuxt/dist/client/pages/search/image.js 2.79 kB 0 B
./.nuxt/dist/client/pages/search/image.modern.js 2.67 kB +2 B (0%)
./.nuxt/dist/client/pages/search/index.js 2.97 kB +1 B (0%)
./.nuxt/dist/client/pages/search/index.modern.js 2.94 kB 0 B
./.nuxt/dist/client/pages/search/model-3d.js 243 B +1 B (0%)
./.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 271 B +1 B (0%)
./.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.44 kB -2 B (0%)
./.nuxt/dist/client/pages/sources.modern.js 1.45 kB +1 B (0%)

compressed-size-action

Replace all `size`s with `w-x h-x` classes
Reuse VSearchBarButton instead of a separate VClearButton component
Add 8 to safelist and fix iconSize (it's string, not a number)
Revert changes to plain--avoid button

Add size classes to all VIcons

Add size classes to all VIcons
@obulat obulat force-pushed the re-add_size_to_vicon branch from 6bcef8d to 3da22e9 Compare October 21, 2022 14:19
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.

Did you miss the tests? Can't see them in the PR. All good otherwise!

@obulat obulat force-pushed the re-add_size_to_vicon branch from 3b451f7 to 8b08bf7 Compare October 26, 2022 08:10
@obulat
Copy link
Contributor Author

obulat commented Oct 26, 2022

Did you miss the tests? Can't see them in the PR. All good otherwise!

I did forget to add the tests! I went back to add some tests, and also re-audited all the VIconButtons to make sure that we have consistent sizes (and removed all of the unused ones). Could you have one more look at this PR?

@obulat obulat changed the title Add VSearchBarButton stories, tests, and additional sizes to VIcon Audit VIconButton sizes and props Oct 26, 2022
Copy link
Contributor

@sarayourfriend sarayourfriend left a comment

Choose a reason for hiding this comment

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

Love the tests and really appreciate how much confidence the visual regression tests give us when working on these things. Kudos to everyone who's been writing more and more of them 🚀

The changes LGTM. I left just one non-blocking note about the names of the sizes.

Comment on lines 32 to 33
larger: { icon: 8, button: 'w-14 h-14' },
large: { icon: 12, button: 'w-20 h-20' },
Copy link
Contributor

Choose a reason for hiding this comment

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

Just a nit pick on the names here: In my head I expected larger to be bigger than large 🤔 Maybe larger -> large and large -> extra-large or something would be clearer in the "order" of how big one or the other is?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thank you for helping with the naming :)

@obulat obulat merged commit 94ad95f into main Oct 27, 2022
@obulat obulat deleted the re-add_size_to_vicon branch October 27, 2022 18:32
github-actions bot pushed a commit that referenced this pull request Oct 27, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
💻 aspect: code Concerns the software code in the repository ✨ 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.

Add accessible button components for mobile searchbar
4 participants