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

Add a counter to filter button and tab #826

Merged
merged 17 commits into from
Mar 20, 2023
Merged

Add a counter to filter button and tab #826

merged 17 commits into from
Mar 20, 2023

Conversation

obulat
Copy link
Contributor

@obulat obulat commented Mar 2, 2023

Fixes

Fixes #482 by @panchovm

Description

This PR adds the counter to the filters button and tab according to the Mockups in Figma

It is the same as WordPress/openverse-frontend#2143, with the gray square on hover (reported by @zackkrida) fixed.

Testing Instructions

When you select filters, the number of selected filters should appear on the button (desktop) or the tab (mobile).
I've added some Storybook snapshot tests and Playwright VR snapshot 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 March 2, 2023 14:14
@obulat obulat requested review from krysal and dhruvkb March 2, 2023 14:14
@openverse-bot openverse-bot added 🟨 priority: medium Not blocking but should be addressed soon ✨ goal: improvement Improvement to an existing user-facing feature 🕹 aspect: interface Concerns end-users' experience with the software labels Mar 2, 2023
@github-actions
Copy link

github-actions bot commented Mar 2, 2023

Full-stack documentation: Ready

https://WordPress.github.io/openverse/_preview/826

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 draft March 2, 2023 14:34
@obulat obulat force-pushed the add/filter_counter branch 3 times, most recently from abf3ceb to 6dc88c5 Compare March 8, 2023 04:19
@obulat obulat changed the base branch from main to add/filter_tab_button_vr_tests March 8, 2023 05:57
@obulat obulat force-pushed the add/filter_counter branch 3 times, most recently from da46b23 to 9a243f5 Compare March 8, 2023 08:24
@obulat obulat changed the base branch from add/filter_tab_button_vr_tests to main March 8, 2023 14:52
@obulat obulat marked this pull request as ready for review March 8, 2023 17:19
@obulat obulat requested a review from a team as a code owner March 8, 2023 17:19
@obulat obulat requested a review from zackkrida March 8, 2023 17:19
@krysal krysal removed their request for review March 8, 2023 17:33
@obulat obulat self-assigned this Mar 9, 2023
@obulat obulat added the 🧱 stack: frontend Related to the Nuxt frontend label Mar 9, 2023
@obulat obulat requested a review from fcoveram March 10, 2023 13:29
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

<VIcon v-if="showIcon" :icon-path="filterIcon" />
<p
v-else
class="flex h-6 w-6 items-center justify-center"
Copy link
Contributor

Choose a reason for hiding this comment

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

The counter needs to have a corner radius of 2px. I think the class is rounded-sm.

@fcoveram
Copy link
Contributor

The filter looks great ✨

I just noticed two things:

  1. The counter needs a corner radius of 2px. I left the comment above this one.
  2. The "clear action" in VFilterTab on small breakpoints does not need to show the number. The "Clear filters" label is enough.
PR Design
CleanShot 2023-03-13 at 11 45 36@2x CleanShot 2023-03-13 at 11 53 57@2x

@obulat obulat force-pushed the add/filter_counter branch from 4908874 to d1dd32d Compare March 13, 2023 16:34
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 code and visuals look good to me, but I'd like to make sure someone accessibility-minded can look at this, specifically for the aria label. Previously, the button was labeled "Filters" and its purpose is to toggle the filter sidebar open or closed. Now, it also indicates how many filters are enabled at a given time.

I wonder if the aria label should be something like "Toggle filters (5 enabled)" instead of the current "5 filters" 🤔

@github-actions
Copy link

github-actions bot commented Mar 15, 2023

Size Change: +619 B (0%)

Total Size: 882 kB

Filename Size Change
./frontend/.nuxt/dist/client/app.js 143 kB +320 B (0%)
./frontend/.nuxt/dist/client/app.modern.js 117 kB +252 B (0%)
./frontend/.nuxt/dist/client/commons/app.js 87.8 kB +15 B (0%)
./frontend/.nuxt/dist/client/commons/app.modern.js 78.3 kB +25 B (0%)
./frontend/.nuxt/dist/client/components/v-sources-table.js 16.2 kB +26 B (0%)
./frontend/.nuxt/dist/client/components/v-sources-table.modern.js 16.2 kB +23 B (0%)
./frontend/.nuxt/dist/client/vendors/app.js 64.2 kB -17 B (0%)
ℹ️ View Unchanged
Filename Size Change
./frontend/.nuxt/dist/client/235.js 273 B 0 B
./frontend/.nuxt/dist/client/235.modern.js 278 B 0 B
./frontend/.nuxt/dist/client/236.js 1.85 kB 0 B
./frontend/.nuxt/dist/client/components/loading-icon.js 747 B +1 B (0%)
./frontend/.nuxt/dist/client/components/loading-icon.modern.js 753 B 0 B
./frontend/.nuxt/dist/client/components/table-sort-icon.js 515 B +1 B (0%)
./frontend/.nuxt/dist/client/components/table-sort-icon.modern.js 518 B -1 B (0%)
./frontend/.nuxt/dist/client/components/v-all-results-grid.js 8.01 kB -4 B (0%)
./frontend/.nuxt/dist/client/components/v-all-results-grid.modern.js 5.49 kB -1 B (0%)
./frontend/.nuxt/dist/client/components/v-audio-cell.js 392 B -1 B (0%)
./frontend/.nuxt/dist/client/components/v-audio-cell.modern.js 397 B 0 B
./frontend/.nuxt/dist/client/components/v-audio-details.js 2.55 kB -1 B (0%)
./frontend/.nuxt/dist/client/components/v-audio-details.modern.js 1.79 kB -1 B (0%)
./frontend/.nuxt/dist/client/components/v-audio-track-skeleton.js 1.02 kB 0 B
./frontend/.nuxt/dist/client/components/v-audio-track-skeleton.modern.js 1.02 kB -1 B (0%)
./frontend/.nuxt/dist/client/components/v-audio-track.js 5.22 kB -4 B (0%)
./frontend/.nuxt/dist/client/components/v-audio-track.modern.js 5.18 kB +4 B (0%)
./frontend/.nuxt/dist/client/components/v-back-to-search-results-link.js 543 B +1 B (0%)
./frontend/.nuxt/dist/client/components/v-back-to-search-results-link.modern.js 547 B 0 B
./frontend/.nuxt/dist/client/components/v-bone.js 693 B +1 B (0%)
./frontend/.nuxt/dist/client/components/v-bone.modern.js 697 B 0 B
./frontend/.nuxt/dist/client/components/v-box-layout.js 1.24 kB +1 B (0%)
./frontend/.nuxt/dist/client/components/v-box-layout.modern.js 1.24 kB +1 B (0%)
./frontend/.nuxt/dist/client/components/v-content-link.js 1.12 kB 0 B
./frontend/.nuxt/dist/client/components/v-content-link.modern.js 1.1 kB +1 B (0%)
./frontend/.nuxt/dist/client/components/v-content-page.js 526 B 0 B
./frontend/.nuxt/dist/client/components/v-content-page.modern.js 530 B +1 B (0%)
./frontend/.nuxt/dist/client/components/v-content-report-button.js 785 B +1 B (0%)
./frontend/.nuxt/dist/client/components/v-content-report-button.modern.js 789 B 0 B
./frontend/.nuxt/dist/client/components/v-content-report-form.js 6.11 kB -2 B (0%)
./frontend/.nuxt/dist/client/components/v-content-report-form.modern.js 3.59 kB +2 B (0%)
./frontend/.nuxt/dist/client/components/v-content-report-popover.js 1.24 kB +2 B (0%)
./frontend/.nuxt/dist/client/components/v-content-report-popover.modern.js 4.25 kB +1 B (0%)
./frontend/.nuxt/dist/client/components/v-copy-button.js 4 kB -1 B (0%)
./frontend/.nuxt/dist/client/components/v-copy-button.modern.js 4.01 kB -2 B (0%)
./frontend/.nuxt/dist/client/components/v-copy-license.js 1 kB -2 B (0%)
./frontend/.nuxt/dist/client/components/v-copy-license.modern.js 1 kB -2 B (0%)
./frontend/.nuxt/dist/client/components/v-copy-license/components/v-error-image/components/v-media-reuse/components/v-search-grid/d219393b.js 9.96 kB +2 B (0%)
./frontend/.nuxt/dist/client/components/v-copy-license/components/v-error-image/components/v-media-reuse/components/v-search-grid/d219393b.modern.js 9.94 kB -1 B (0%)
./frontend/.nuxt/dist/client/components/v-dmca-notice.js 754 B 0 B
./frontend/.nuxt/dist/client/components/v-dmca-notice.modern.js 758 B -1 B (0%)
./frontend/.nuxt/dist/client/components/v-error-image.js 1.7 kB +1 B (0%)
./frontend/.nuxt/dist/client/components/v-error-image.modern.js 1.69 kB -3 B (0%)
./frontend/.nuxt/dist/client/components/v-error-section.js 372 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 1.93 kB +5 B (0%)
./frontend/.nuxt/dist/client/components/v-external-search-form.modern.js 1.92 kB 0 B
./frontend/.nuxt/dist/client/components/v-external-source-list.js 905 B +2 B (0%)
./frontend/.nuxt/dist/client/components/v-external-source-list.modern.js 906 B -1 B (0%)
./frontend/.nuxt/dist/client/components/v-full-layout.js 1.52 kB -4 B (0%)
./frontend/.nuxt/dist/client/components/v-full-layout.modern.js 1.52 kB 0 B
./frontend/.nuxt/dist/client/components/v-grid-skeleton.js 1.62 kB +1 B (0%)
./frontend/.nuxt/dist/client/components/v-grid-skeleton.modern.js 1.63 kB -1 B (0%)
./frontend/.nuxt/dist/client/components/v-home-gallery.js 5.18 kB 0 B
./frontend/.nuxt/dist/client/components/v-home-gallery.modern.js 5.17 kB +1 B (0%)
./frontend/.nuxt/dist/client/components/v-homepage-content.js 1.76 kB -2 B (0%)
./frontend/.nuxt/dist/client/components/v-homepage-content.modern.js 1.73 kB -1 B (0%)
./frontend/.nuxt/dist/client/components/v-image-carousel.js 4.73 kB +1 B (0%)
./frontend/.nuxt/dist/client/components/v-image-carousel.modern.js 4.71 kB +3 B (0%)
./frontend/.nuxt/dist/client/components/v-image-cell.js 1.57 kB -1 B (0%)
./frontend/.nuxt/dist/client/components/v-image-cell.modern.js 1.56 kB 0 B
./frontend/.nuxt/dist/client/components/v-image-details.js 2.16 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.99 kB -1 B (0%)
./frontend/.nuxt/dist/client/components/v-image-grid.modern.js 2.52 kB +5 B (0%)
./frontend/.nuxt/dist/client/components/v-license-tab-panel.js 526 B 0 B
./frontend/.nuxt/dist/client/components/v-license-tab-panel.modern.js 529 B -1 B (0%)
./frontend/.nuxt/dist/client/components/v-load-more.js 3.17 kB -1 B (0%)
./frontend/.nuxt/dist/client/components/v-load-more.modern.js 695 B 0 B
./frontend/.nuxt/dist/client/components/v-media-license.js 829 B +2 B (0%)
./frontend/.nuxt/dist/client/components/v-media-license.modern.js 837 B 0 B
./frontend/.nuxt/dist/client/components/v-media-reuse.js 1.63 kB 0 B
./frontend/.nuxt/dist/client/components/v-media-reuse.modern.js 1.63 kB -1 B (0%)
./frontend/.nuxt/dist/client/components/v-media-tag.js 434 B -1 B (0%)
./frontend/.nuxt/dist/client/components/v-media-tag.modern.js 439 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 0 B
./frontend/.nuxt/dist/client/components/v-no-results.js 757 B 0 B
./frontend/.nuxt/dist/client/components/v-no-results.modern.js 756 B +1 B (0%)
./frontend/.nuxt/dist/client/components/v-radio.js 1.51 kB 0 B
./frontend/.nuxt/dist/client/components/v-radio.modern.js 1.47 kB 0 B
./frontend/.nuxt/dist/client/components/v-related-audio.js 1.26 kB +1 B (0%)
./frontend/.nuxt/dist/client/components/v-related-audio.modern.js 1.26 kB -2 B (0%)
./frontend/.nuxt/dist/client/components/v-related-images.js 1.06 kB +1 B (0%)
./frontend/.nuxt/dist/client/components/v-related-images.modern.js 3.1 kB +6 B (0%)
./frontend/.nuxt/dist/client/components/v-report-desc-form.js 977 B -1 B (0%)
./frontend/.nuxt/dist/client/components/v-report-desc-form.modern.js 981 B 0 B
./frontend/.nuxt/dist/client/components/v-row-layout.js 1.71 kB -2 B (0%)
./frontend/.nuxt/dist/client/components/v-row-layout.modern.js 1.72 kB -1 B (0%)
./frontend/.nuxt/dist/client/components/v-scroll-button.js 824 B -1 B (0%)
./frontend/.nuxt/dist/client/components/v-scroll-button.modern.js 830 B 0 B
./frontend/.nuxt/dist/client/components/v-search-grid.js 5.75 kB +2 B (0%)
./frontend/.nuxt/dist/client/components/v-search-grid.modern.js 5.68 kB -2 B (0%)
./frontend/.nuxt/dist/client/components/v-search-results-title.js 600 B 0 B
./frontend/.nuxt/dist/client/components/v-search-results-title.modern.js 604 B -1 B (0%)
./frontend/.nuxt/dist/client/components/v-search-type-radio.js 806 B 0 B
./frontend/.nuxt/dist/client/components/v-search-type-radio.modern.js 781 B +1 B (0%)
./frontend/.nuxt/dist/client/components/v-server-timeout.js 300 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 3.39 kB -2 B (0%)
./frontend/.nuxt/dist/client/components/v-sketch-fab-viewer.modern.js 913 B -1 B (0%)
./frontend/.nuxt/dist/client/components/v-snackbar.js 1.19 kB -4 B (0%)
./frontend/.nuxt/dist/client/components/v-snackbar.modern.js 1.19 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.4 kB -2 B (0%)
./frontend/.nuxt/dist/client/pages/about.modern.js 1.4 kB 0 B
./frontend/.nuxt/dist/client/pages/audio/_id/index.js 8.01 kB -3 B (0%)
./frontend/.nuxt/dist/client/pages/audio/_id/index.modern.js 4.85 kB -3 B (0%)
./frontend/.nuxt/dist/client/pages/external-sources.js 1.56 kB -4 B (0%)
./frontend/.nuxt/dist/client/pages/external-sources.modern.js 1.56 kB +1 B (0%)
./frontend/.nuxt/dist/client/pages/feedback.js 1.34 kB 0 B
./frontend/.nuxt/dist/client/pages/feedback.modern.js 1.34 kB 0 B
./frontend/.nuxt/dist/client/pages/image/_id/index.js 9.32 kB -9 B (0%)
./frontend/.nuxt/dist/client/pages/image/_id/index.modern.js 5.18 kB +4 B (0%)
./frontend/.nuxt/dist/client/pages/image/_id/report.js 3.66 kB +2 B (0%)
./frontend/.nuxt/dist/client/pages/image/_id/report.modern.js 4.27 kB +2 B (0%)
./frontend/.nuxt/dist/client/pages/index.js 7.28 kB +5 B (0%)
./frontend/.nuxt/dist/client/pages/index.modern.js 7.21 kB 0 B
./frontend/.nuxt/dist/client/pages/preferences.js 1.32 kB -1 B (0%)
./frontend/.nuxt/dist/client/pages/preferences.modern.js 1.32 kB 0 B
./frontend/.nuxt/dist/client/pages/privacy.js 1.01 kB -2 B (0%)
./frontend/.nuxt/dist/client/pages/privacy.modern.js 1.02 kB +1 B (0%)
./frontend/.nuxt/dist/client/pages/search-help.js 1.6 kB -1 B (0%)
./frontend/.nuxt/dist/client/pages/search-help.modern.js 1.58 kB 0 B
./frontend/.nuxt/dist/client/pages/search.js 4.55 kB -4 B (0%)
./frontend/.nuxt/dist/client/pages/search.modern.js 2.04 kB +3 B (0%)
./frontend/.nuxt/dist/client/pages/search/audio.js 6.02 kB -5 B (0%)
./frontend/.nuxt/dist/client/pages/search/audio.modern.js 3.55 kB 0 B
./frontend/.nuxt/dist/client/pages/search/image.js 507 B 0 B
./frontend/.nuxt/dist/client/pages/search/image.modern.js 2.71 kB +3 B (0%)
./frontend/.nuxt/dist/client/pages/search/index.js 443 B +1 B (0%)
./frontend/.nuxt/dist/client/pages/search/index.modern.js 448 B +1 B (0%)
./frontend/.nuxt/dist/client/pages/search/model-3d.js 244 B +1 B (0%)
./frontend/.nuxt/dist/client/pages/search/model-3d.modern.js 246 B 0 B
./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.57 kB -2 B (0%)
./frontend/.nuxt/dist/client/pages/sources.modern.js 1.57 kB -2 B (0%)
./frontend/.nuxt/dist/client/runtime.js 2.72 kB 0 B
./frontend/.nuxt/dist/client/runtime.modern.js 2.73 kB 0 B
./frontend/.nuxt/dist/client/vendors/app.modern.js 63.3 kB -3 B (0%)

compressed-size-action

@obulat obulat force-pushed the add/filter_counter branch from 78b537c to 2ecd370 Compare March 16, 2023 10:59
@obulat obulat force-pushed the add/filter_counter branch from 2ecd370 to 085f7e7 Compare March 20, 2023 15:13
@obulat
Copy link
Contributor Author

obulat commented Mar 20, 2023

I wonder if the aria label should be something like "Toggle filters (5 enabled)" instead of the current "5 filters" 🤔

I am going to open an issue for better accessibility of the filters button and tab.

@obulat obulat merged commit bee7999 into main Mar 20, 2023
@obulat obulat deleted the add/filter_counter branch March 20, 2023 15:40
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: improvement Improvement to an existing user-facing feature 🟨 priority: medium Not blocking but should be addressed soon 🧱 stack: frontend Related to the Nuxt frontend
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Filter counter in button and tab
5 participants