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

[Enhancement] Improve Storybook Icon documentation to display all icons #346

Merged
merged 5 commits into from
Jun 6, 2024

Conversation

TimRoe
Copy link
Contributor

@TimRoe TimRoe commented Jun 4, 2024

Description of Change

Used the Storybook built in IconGallery and IconItem components paired with an iterating function to build out a grid of all our icons and insert it into the Docs page for the Icon component story section.

It was decided against, but I committed a prototype method of coercing the icon gallery into being a story with this commit, modeled on this comment from a discussion of the error I was encountering.

Screenshots/Video

Screen.Recording.2024-06-04.at.3.55.15.PM.mov

Testing

Validated appeared in Web as expected. Minor bug with (5) long icon names being cut off, but it is a known bug with Storybook and Jessica thought it was acceptable.

Doc pages do not presently appear in iOS/Android, but spot checked nothing seemed amiss.

  • Tested on iOS
  • Tested on Android
  • Tested on Web

PR Checklist

Code reviewer validation:

  • General
    • PR is linked to ticket(s)
    • PR has changelog label applied if it's to be included in the changelog
    • Acceptance criteria:
      • All satisfied or
      • Documented reason for not being performed or
      • Split to separate ticket and ticket is linked by relevant AC(s)
    • Above PR sections adequately filled out
    • If any breaking changes, in accordance with the pre-1.0.0 versioning guidelines: a CU ticket has been created for the VA Mobile App detailing necessary adjustments with the package version that will be published by this ticket
  • Code
    • Tests are included if appropriate (or split to separate ticket)
    • New functions have proper TSDoc annotations

Publish

Changes do not warrant a new version per the versioning guidelines as they are purely Storybook/documentation.

@TimRoe TimRoe marked this pull request as ready for review June 4, 2024 21:10
@TimRoe TimRoe requested a review from a team as a code owner June 4, 2024 21:10
Copy link
Contributor

@narin narin left a comment

Choose a reason for hiding this comment

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

Looks great! Nice find with the IconGallery.

@TimRoe TimRoe merged commit a1d439b into main Jun 6, 2024
10 of 18 checks passed
@TimRoe TimRoe deleted the feature/258-roettger-DisplayAllIconsInStorybookAtOnce branch June 6, 2024 16:26
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.

2 participants