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.

Sign up for GitHub

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

Jump to bottom

Convert stories to Component Story Format #1596

Merged
merged 27 commits into from
Jul 10, 2024
Merged

Convert stories to Component Story Format #1596

merged 27 commits into from
Jul 10, 2024

Conversation

jamesmockett
Copy link
Contributor

@jamesmockett jamesmockett commented Jul 5, 2024 •
edited
Loading

What are you changing?

Why?

  • This is the recommended way to write stories and should make upgrading to newer releases of Storybook simpler
  • It's an open format that can be used outside of Storybook
  • It's simpler and removes boilerplate code. (For single component stories there's no need to explicitly render the component and pass args—this happens automatically.)

@jamesmockett jamesmockett self-assigned this Jul 5, 2024
@changeset-bot changeset-bot
Copy link

changeset-bot bot commented Jul 5, 2024 •
edited
Loading

⚠️ No Changeset found

Latest commit: d6760de

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.

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

@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Jul 5, 2024

Tip

Once this PR is ready to go, add the run_chromatic label to run the Chromatic tests.

This saves us a lot of money by not running the tests before we need them.

@github-actions github-actions bot added the 📦 npm Affects a @guardian package on NPM label Jul 5, 2024
@jamesmockett jamesmockett linked an issue Jul 5, 2024 that may be closed by this pull request
Update all Storybook stories to use Component Story Format #1589
Closed
@jamesmockett
Disable rules-of-hooks ESLint rule for Stories
7c872dd 
The lowercase `render` function in CSF stories
breaks the rule that component names should begin
with a capital letter.
@jamesmockett jamesmockett added the run_chromatic Runs chromatic when label is applied label Jul 5, 2024
@jamesmockett jamesmockett marked this pull request as ready for review July 5, 2024 14:35
@jamesmockett jamesmockett requested review from a team as code owners July 5, 2024 14:35
@jamesmockett jamesmockett changed the title Convert stories to CSF3 Convert stories to Component Story Format Jul 5, 2024
@jamesmockett jamesmockett merged commit 4cb35f0 into main Jul 10, 2024
19 checks passed
@jamesmockett jamesmockett deleted the jm/convert-stories-to-csf3 branch July 10, 2024 09:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@sndrs sndrs sndrs approved these changes

Assignees

@jamesmockett jamesmockett

Labels
📦 npm Affects a @guardian package on NPM run_chromatic Runs chromatic when label is applied
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Update all Storybook stories to use Component Story Format
2 participants
@jamesmockett @sndrs