-
Notifications
You must be signed in to change notification settings - Fork 24
docs(divider): Add Storybook story and docs page #1208
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
Merged
+78
−0
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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,31 @@ | ||
| import { Canvas, Controls, Meta, Subtitle, Title } from '@storybook/addon-docs/blocks' | ||
|
|
||
| import * as DividerStories from './divider.stories' | ||
|
|
||
| <Meta of={DividerStories} /> | ||
|
|
||
| <Title /> | ||
|
|
||
| <Subtitle>Horizontal rule that separates content.</Subtitle> | ||
|
|
||
| ## Basic usage | ||
|
|
||
| `Divider` renders an `<hr>` with the given `weight`, and defaults to `tertiary`. | ||
|
|
||
| <Canvas of={DividerStories.Default} /> | ||
|
|
||
| ### API | ||
|
|
||
| <Controls of={DividerStories.Default} /> | ||
|
|
||
| ## Weights | ||
|
|
||
| The weight sets the line color. Ordered by contrast against the background: `secondary` is the | ||
| faintest, then `primary`, then `tertiary`. | ||
|
|
||
| <Canvas of={DividerStories.Weights} /> | ||
|
|
||
| ## Dividers between stacked items | ||
|
|
||
| `Stack` draws the same dividers between its children through its own `dividers` prop. Prefer that | ||
| over placing a `Divider` between each item. |
This file contains hidden or 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,47 @@ | ||
| import * as React from 'react' | ||
|
|
||
| import { Stack } from '../stack' | ||
| import { Text } from '../text' | ||
|
|
||
| import { Divider } from './divider' | ||
|
|
||
| import type { Meta, StoryObj } from '@storybook/react-vite' | ||
|
|
||
| const weights = ['primary', 'secondary', 'tertiary'] as const | ||
|
|
||
| const meta = { | ||
| title: '📐 Layout/Divider', | ||
| component: Divider, | ||
| parameters: { | ||
| badges: ['accessible'], | ||
| figma: { | ||
| path: 'Web › Components / Todoist › Dividers › Divider', | ||
| url: 'https://www.figma.com/design/LYlWNzvhMDh907l07mPPQk/Product-Library---Web?node-id=1751-25739', | ||
| }, | ||
| }, | ||
| } satisfies Meta<typeof Divider> | ||
|
|
||
| export default meta | ||
|
|
||
| type Story = StoryObj<typeof meta> | ||
|
|
||
| export const Default: Story = { | ||
| args: { | ||
| weight: 'tertiary', | ||
| }, | ||
| } | ||
|
|
||
| export const Weights: Story = { | ||
| render: () => ( | ||
| <Stack space="xlarge"> | ||
| {weights.map((weight) => ( | ||
| <Stack key={weight} space="small"> | ||
| <Text variant="caption-1" tone="secondary"> | ||
| {weight} | ||
| </Text> | ||
| <Divider weight={weight} /> | ||
| </Stack> | ||
| ))} | ||
| </Stack> | ||
| ), | ||
| } | ||
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.
Uh oh!
There was an error while loading. Please reload this page.