Skip to content

Add grid overlay control to Storybook #969

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

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

Conversation

joshfarrant
Copy link
Contributor

@joshfarrant joshfarrant commented Apr 9, 2025

Summary

Adds a grid overlay control to the Storybook preview.

When building the RiverAccordion I needed an easy way to check that it conformed to our standard Grid, so I added this control.

The control supports multiple grid options to allow it to be used across all of our stories.

List of notable changes:

  • Adds a grid overlay control to Storybook, which supports 5 modes
    • Off
    • Limited width — limits the grid to 1280px to match our standard Grid
    • Full width — allows the grid to expand to the full width of the viewport, similar to passing fullWidth to Grid
    • Limited width (no padding) — limits the grid to 1280px without padding
    • Full width (no padding) — allows the grid to expand to the full width of the viewport without padding
  • Changes the icon for the colour mode control; a paint brush felt more appropriate

What should reviewers focus on?

  • Are you happy with this addition?

Steps to test:

  1. Open 🔗 Storybook
  2. Click the Grid overlay control
    image

Contributor checklist:

  • All new and existing CI checks pass
  • Tests prove that the feature works and covers both happy and unhappy paths
  • Any drop in coverage, breaking changes or regressions have been documented above
  • UI Changes contain new visual snapshots (generated by adding update snapshots label to the PR)
  • All developer debugging and non-functional logging has been removed
  • Related issues have been referenced in the PR description

Reviewer checklist:

  • Check that pull request and proposed changes adhere to our contribution guidelines and code of conduct
  • Check that tests prove the feature works and covers both happy and unhappy paths
  • Check that there aren't other open Pull Requests for the same update/change

Example screenshots

image

image

Copy link

changeset-bot bot commented Apr 9, 2025

⚠️ No Changeset found

Latest commit: c5f7fec

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

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

Copy link
Contributor

github-actions bot commented Apr 9, 2025

🟢 No design token changes found

Copy link
Contributor

github-actions bot commented Apr 9, 2025

🟢 No visual differences found

Our visual comparison tests did not find any differences in the UI.

@joshfarrant joshfarrant marked this pull request as ready for review April 9, 2025 12:08
@joshfarrant joshfarrant force-pushed the joshfarrant/storybook-grid-overlay branch from ac18cbf to c5f7fec Compare April 9, 2025 14:52
@joshfarrant joshfarrant changed the title add grid overlay control Add grid overlay control to Storybook Apr 9, 2025
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.

1 participant