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

Dialog: fix broken stories for Dialog v1 and v2 #4762

Closed
wants to merge 2 commits into from

Conversation

broccolinisoup
Copy link
Member

@broccolinisoup broccolinisoup commented Jul 21, 2024

Because we have customisation for Dialog stories.

This is Dialog Alpha: https://primer.style/react/storybook/?path=/story/components-dialogv1--default&globals=colorScheme:light
This is Dialog Draft (What we recommend): https://primer.style/react/storybook/?path=/story/components-dialog--default&globals=colorScheme:light

Changelog

New

  • Add a custom story name generator for Dialog
  • Add feature stories of Dialog draft to docs.json

Changed

Removed

Rollout strategy

  • Patch release
  • Minor release
  • Major release; if selected, include a written rollout or migration plan
  • None; if selected, include a brief description as to why

Testing & Reviewing

Copy link

changeset-bot bot commented Jul 21, 2024

⚠️ No Changeset found

Latest commit: 6294439

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

@github-actions github-actions bot added the staff Author is a staff member label Jul 21, 2024
Copy link
Contributor

github-actions bot commented Jul 21, 2024

size-limit report 📦

Path Size
packages/react/dist/browser.esm.js 92.4 KB (0%)
packages/react/dist/browser.umd.js 92.72 KB (0%)

@github-actions github-actions bot temporarily deployed to storybook-preview-4762 July 21, 2024 23:30 Inactive
@broccolinisoup broccolinisoup added the skip changeset This change does not need a changelog label Jul 21, 2024
@@ -59,7 +60,12 @@ const components = docsFiles.map(docsFilepath => {
const componentName = isComponentV2 ? `${docsName}v2` : docsName

// Get the default story id
const defaultStoryId = `${storyPrefix[docs.status]}components-${componentName}--default`
let defaultStoryId = `${storyPrefix[docs.status]}components-${componentName}--default`
Copy link
Member Author

Choose a reason for hiding this comment

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

I don't like this but couldn't think of another way to accommodate Dialog customisation. Let me know if you have any recommendation 🙌🏻

@broccolinisoup broccolinisoup marked this pull request as ready for review July 21, 2024 23:38
@broccolinisoup broccolinisoup requested a review from a team as a code owner July 21, 2024 23:38
@broccolinisoup broccolinisoup requested a review from TylerJDev July 21, 2024 23:38
@broccolinisoup broccolinisoup deleted the dialog-story-fix branch August 12, 2024 00:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
skip changeset This change does not need a changelog staff Author is a staff member
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants