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

filter-sidebar: Enhanced documentation and guidance around mobile usage. #1918

Open
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

danger17
Copy link
Contributor

@danger17 danger17 commented Dec 19, 2024

Expanded on existing content.

View preview

Checklist

Preflight

  • Prefix the PR title with the slug of the package or component - e.g. accordion: Updated padding or docs: Updated header links
  • Describe the changes clearly in the PR description
  • Read and check your code before tagging someone for review
  • Create a changeset file by running yarn changeset. Learn more about change management.

Testing

  • Manually test component in various modern browsers at various sizes (use Browserstack)
  • Manually test component in various devices (phone, tablet, desktop)
  • Manually test component using a keyboard
  • Manually test component using a screen reader
  • Manually tested in dark mode
  • Component meets Web Content Accessibility Guidelines (WCAG) 2.1 standards
  • Add any necessary unit tests (HTML validation, snapshots etc)
  • Run yarn test to ensure tests are passing. If required, run yarn test -u to update any generated snapshots.

Documentation

  • Create or update documentation on the website
  • Create or update stories for Storybook
  • Create or update stories for Playroom snippets

Copy link

changeset-bot bot commented Dec 19, 2024

🦋 Changeset detected

Latest commit: 21bdc21

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package
Name Type
@ag.ds-next/react Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

Copy link
Contributor

github-actions bot commented Dec 19, 2024

PR Preview Action v1.4.8
🚀 Deployed preview to https://agriculturegovau.github.io/agds-next/pr-preview/pr-1918/
on branch gh-pages at 2024-12-20 02:16 UTC

@danger17 danger17 requested a review from adrian-yee December 19, 2024 02:05
@@ -8,7 +8,7 @@ relatedPatterns: ['search-filters']

Filter sidebar is used in catalogue or search results pages to contain filtering options for a list of Cards.

The Filter sidebar collapses on mobile devices, and displays a number of active filter options in the header.
The Filter sidebar collapses on mobile devices into an accordion, where the number of active filter options is displayed prominently in the header. Individual filter tags are displayed outside of the accordion, providing users with a clear, interactive way to view and remove specific filters as needed.
Copy link
Contributor

Choose a reason for hiding this comment

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

Filter tags aren't part of this component, so I think this should be more "if you add filter tags" or it should be added to the patterns/search-filters documentation

Edited to reflect that filter tags are not part of the component, so changed language to "can"
Added tags as related component
filter-sidebar: Enhanced documentation and guidance around mobile usage.
@danger17 danger17 changed the title Updated mobile documentation for filter sidebar filter-sidebar: Enhanced documentation and guidance around mobile usage. Dec 20, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants