-
Notifications
You must be signed in to change notification settings - Fork 7
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: Using mdx syntax to create stories (#9)
- Loading branch information
1 parent
68ccbdd
commit 9d9f03f
Showing
11 changed files
with
2,496 additions
and
911 deletions.
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,24 +1,20 @@ | ||
| const path = require('path'); | ||
|
|
||
| module.exports = { | ||
| stories: ['../src/**/*.stories.tsx'], | ||
| addons: ['@storybook/addon-viewport/register'], | ||
| stories: ['../src/**/*.stories.mdx'], | ||
| addons: [ | ||
| '@storybook/addon-viewport', | ||
| '@storybook/addon-docs', | ||
| '@storybook/addon-controls', | ||
| '@storybook/addon-a11y', | ||
| ], | ||
| webpackFinal: async (config) => { | ||
| config.module.rules.push({ | ||
| test: /\.scss$/, | ||
| use: ['style-loader', 'css-loader', 'sass-loader'], | ||
| include: path.resolve(__dirname, '../'), | ||
| }); | ||
|
|
||
| config.module.rules.push({ | ||
| test: /\.(ts|tsx)$/, | ||
| use: [ | ||
| { loader: require.resolve('ts-loader') }, | ||
| { loader: require.resolve('react-docgen-typescript-loader') }, | ||
| ], | ||
| }); | ||
| config.resolve.extensions.push('.ts', '.tsx'); | ||
|
|
||
| return config; | ||
| }, | ||
| }; |
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,9 @@ | ||
| import { addParameters } from '@storybook/react'; | ||
| import { DocsPage, DocsContainer } from '@storybook/addon-docs/blocks'; | ||
|
|
||
| addParameters({ | ||
| docs: { | ||
| container: DocsContainer, | ||
| page: DocsPage, | ||
| }, | ||
| }); |
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
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
71 changes: 71 additions & 0 deletions
71
packages/ocean-components/src/Typography/stories/Typography.stories.mdx
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,71 @@ | ||
| import { Meta, Story, Preview, Props } from '@storybook/addon-docs/blocks'; | ||
| import Typography from '../Typography'; | ||
|
|
||
| <Meta title="Components|Typography" component={Typography} /> | ||
|
|
||
| # Typography API | ||
|
|
||
| The API documentation of the Typography React component. Learn more about the props and the CSS customization points. | ||
|
|
||
| ## Import | ||
|
|
||
| ```javascript | ||
| import Typography from '@useblu/ocean-ui/Typography'; | ||
| // or | ||
| import { Typography } from '@useblu/ocean-ui'; | ||
| ``` | ||
|
|
||
| ## Usage | ||
|
|
||
| <Preview withSource="open" withToolbar> | ||
| <Story | ||
| name="Usage" | ||
| parameters={{ controls: { hideNoControlsWarning: true } }} | ||
| > | ||
| <Typography variant="paragraph"> | ||
| Lorem ipsum dolor sit amet, consectetur adipisicing elit. Quos blanditiis | ||
| tenetur | ||
| </Typography> | ||
| </Story> | ||
| </Preview> | ||
|
|
||
| ## Props | ||
|
|
||
| <Props component={Typography} parameters /> | ||
|
|
||
| The ref is forwarded to the root element. | ||
|
|
||
| Any other props supplied will be provided to the root element (native element). | ||
|
|
||
| ## CSS | ||
|
|
||
| | Rule name | Global class | Description | | ||
| | ----------- | ------------------------------ | ------------------------------------------------------------ | | ||
| | Root | .ods-typography | Styles applied to the root element. | | ||
| | heading1 | .ods-typography\_\_heading1 | Styles applied to the root element if variant="heading1". | | ||
| | heading2 | .ods-typography\_\_heading2 | Styles applied to the root element if variant="heading2". | | ||
| | heading3 | .ods-typography\_\_heading3 | Styles applied to the root element if variant="heading3". | | ||
| | heading4 | .ods-typography\_\_heading4 | Styles applied to the root element if variant="heading4". | | ||
| | subtitle1 | .ods-typography\_\_subtitle1 | Styles applied to the root element if variant="subtitle1". | | ||
| | subtitle2 | .ods-typography\_\_subtitle2 | Styles applied to the root element if variant="subtitle2". | | ||
| | paragraph | .ods-typography\_\_paragraph | Styles applied to the root element if variant="paragraph". | | ||
| | description | .ods-typography\_\_description | Styles applied to the root element if variant="description". | | ||
| | caption | .ods-typography\_\_caption | Styles applied to the root element if variant="caption". | | ||
|
|
||
| If that's not sufficient, you can check the [implementation of the component](https://github.com/Pagnet/ocean-ds/blob/master/src/Typography/Typography.tsx) for more detail. | ||
|
|
||
| ## Playground | ||
|
|
||
| <Preview> | ||
| <Story | ||
| name="Playground" | ||
| args={{ | ||
| variant: 'heading3', | ||
| children: 'Lorem ipsum dolor sit amet, consectetur adipiscing elit.', | ||
| }} | ||
| > | ||
| {(props) => <Typography {...props} />} | ||
| </Story> | ||
| </Preview> | ||
|
|
||
| <Props story="Playground" /> |
10 changes: 0 additions & 10 deletions
10
packages/ocean-components/src/Typography/stories/Typography.stories.tsx
This file was deleted.
Oops, something went wrong.
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 |
|---|---|---|
|
|
@@ -19,7 +19,7 @@ | |
| "exclude": [ | ||
| "node_modules", | ||
| "dist", | ||
| "src/**/*.stories.tsx", | ||
| "src/**/*.stories.mdx", | ||
| "src/**/*.test.tsx" | ||
| ] | ||
| } | ||
Oops, something went wrong.