Experience 8346: Add configuration for local instance of Storybook #8803
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,22 @@ | ||
| module.exports = { | ||
| stories: [ | ||
| "../src/**/*.stories.mdx", | ||
| "../src/**/*.stories.@(js|jsx|ts|tsx)", | ||
| ], | ||
| addons: [ | ||
| "@storybook/addon-links", | ||
| "@storybook/addon-essentials", | ||
| "@storybook/addon-interactions", | ||
| "@storybook/addon-a11y", | ||
| ], | ||
| framework: "@storybook/react", | ||
| core: { | ||
| builder: "@storybook/builder-webpack5", | ||
| }, | ||
| refs: { | ||
|
There was a problem hiding this comment. Allows for composition with other/external Storybooks. Everything's still going through network requests so browsing external stories won't be as snappy as our own, but it's still nice to have everything in one place. |
||
| trussworks: { | ||
| title: "Trussworks Storybook", | ||
| url: "https://trussworks.github.io/react-uswds/", | ||
| }, | ||
| }, | ||
| }; | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,59 @@ | ||
| import { initializeWorker, mswDecorator } from "msw-storybook-addon"; | ||
| import { CacheProvider } from "rest-hooks"; | ||
| import { BrowserRouter } from "react-router-dom"; | ||
| import { HelmetProvider } from "react-helmet-async"; | ||
| import MockDate from "mockdate"; | ||
|
|
||
| import "../src/content/generated/global.out.css"; | ||
|
|
||
| // mock all dates in stories to make sure we don't run into date-related inconsistencies | ||
| MockDate.set("2023-01-01"); | ||
|
There was a problem hiding this comment. This'd be especially useful if we start using snapshots with Chromatic. There was a problem hiding this comment. I'm curious how this will interact with faker.js if we end up using it but something to worry about later. |
||
|
|
||
| export const parameters = { | ||
| actions: { argTypesRegex: "^on[A-Z].*" }, | ||
| controls: { | ||
| matchers: { | ||
|
There was a problem hiding this comment. These are included by default on installation, but they're useful! |
||
| color: /(background|color)$/i, | ||
| date: /Date$/, | ||
| }, | ||
| }, | ||
| options: { | ||
| storySort: { | ||
| method: "alphabetical", | ||
| order: [], | ||
|
There was a problem hiding this comment. Not sure what the order should be yet since our component system is still in a limbo state. |
||
| }, | ||
| }, | ||
| }; | ||
|
|
||
| initializeWorker(); | ||
|
There was a problem hiding this comment. MSW isn't hooked up yet, but we might as well get it started 馃し |
||
|
|
||
| function withRestHooksCacheProvider(Story) { | ||
|
There was a problem hiding this comment. We could add an all-in-one HOC like we do in tests, but I figure the granularity might be good. Not really an issue either way, though! |
||
| return ( | ||
| <CacheProvider> | ||
| <Story /> | ||
| </CacheProvider> | ||
| ); | ||
| } | ||
|
|
||
| function withRouter(Story) { | ||
| return ( | ||
| <BrowserRouter> | ||
| <Story /> | ||
| </BrowserRouter> | ||
| ); | ||
| } | ||
|
|
||
| function withHelmet(Story) { | ||
| return ( | ||
| <HelmetProvider> | ||
| <Story /> | ||
| </HelmetProvider> | ||
| ); | ||
| } | ||
|
|
||
| export const decorators = [ | ||
| withHelmet, | ||
| withRouter, | ||
| withRestHooksCacheProvider, | ||
| mswDecorator, | ||
| ]; | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,27 @@ | ||
| import React from "react"; | ||
| import { ComponentMeta, ComponentStory } from "@storybook/react"; | ||
|
|
||
| import { StaticAlert, StaticAlertType } from "./StaticAlert"; | ||
|
|
||
| export default { | ||
| title: "components/StaticAlert", | ||
| component: StaticAlert, | ||
| argTypes: { | ||
| type: { | ||
| control: { | ||
| type: "radio", | ||
| options: Object.values(StaticAlertType), | ||
| }, | ||
| }, | ||
| }, | ||
| } as ComponentMeta<typeof StaticAlert>; | ||
|
|
||
| export const Default: ComponentStory<typeof StaticAlert> = (args) => ( | ||
| <StaticAlert {...args} /> | ||
| ); | ||
| Default.args = { | ||
| type: StaticAlertType.Success, | ||
| heading: "StaticAlert Heading", | ||
| message: "This is the message of the StaticAlert", | ||
| children: "Children are optional! (Try clearing me out)", | ||
| }; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,50 @@ | ||
| import React from "react"; | ||
| import { ComponentMeta, ComponentStory } from "@storybook/react"; | ||
|
|
||
| import { USExtLink, USLink, USLinkButton } from "./USLink"; | ||
|
|
||
| export default { | ||
| title: "components/USLink", | ||
| component: USLink, | ||
| } as ComponentMeta<typeof USLink>; | ||
|
|
||
| export const Default: ComponentStory<typeof USLink> = (args) => ( | ||
| <USLink {...args} /> | ||
| ); | ||
| Default.args = { | ||
| className: "", | ||
| children: "This is a link", | ||
| }; | ||
|
|
||
| export const Button: ComponentStory<typeof USLinkButton> = (args) => ( | ||
| <USLinkButton {...args} /> | ||
| ); | ||
| Button.args = { | ||
| children: "This is a link styled as a button", | ||
| secondary: false, | ||
| base: false, | ||
| inverse: false, | ||
| unstyled: false, | ||
| }; | ||
| Button.argTypes = { | ||
| accentStyle: { | ||
| control: { | ||
| type: "radio", | ||
| options: ["", "cool", "warm"], | ||
| }, | ||
| }, | ||
| size: { | ||
| control: { | ||
| type: "radio", | ||
| options: ["", "big"], | ||
| }, | ||
| }, | ||
| }; | ||
|
|
||
| export const ExtLink: ComponentStory<typeof USExtLink> = (args) => ( | ||
| <USExtLink {...args} /> | ||
| ); | ||
| ExtLink.args = { | ||
| className: "", | ||
| children: "This is an external link", | ||
| }; |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
for later, but this might be a really nice package to see the states of different components without the need of dev tools: https://storybook.js.org/addons/storybook-addon-pseudo-states