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

docs: update storybook docs #1056

Merged
merged 7 commits into from
Oct 16, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions .storybook/theme.ts
Original file line number Diff line number Diff line change
Expand Up @@ -26,9 +26,9 @@ export const CloudThemeLight = create({
inputTextColor: 'black',
inputBorderRadius: 4,

brandUrl: 'https://github.com/gravity-ui/uikit',
brandUrl: 'https://gravity-ui.com/',
brandTitle: `<div style="font-size: 18px; color: #027bf3; font-weight: 600; margin-top: -6px; margin-bottom: 2px;">Gravity UI</div>
<div style="font-size: 14px;color: #7d7d7d;font-weight: 400;">Base Components</div>`,
<div style="font-size: 14px;color: #7d7d7d;font-weight: 400;">UIKit</div>`,
});

export const CloudThemeDark = create({
Expand Down
14 changes: 7 additions & 7 deletions src/components/Button/__stories__/Button.stories.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ import {
} from '@gravity-ui/icons';
import type {Meta, StoryObj} from '@storybook/react';

import {StoryLayout} from '../../../demo/StoryLayout/StoryLayout';
import {Showcase} from '../../../demo/Showcase';
import {Icon as IconComponent} from '../../Icon/Icon';
import {Button} from '../Button';

Expand All @@ -31,7 +31,7 @@ export const View: Story = {

export const Size: Story = {
render: (args) => (
<StoryLayout>
<Showcase>
<Button {...args} size="xs">
Size xs
</Button>
Expand All @@ -47,13 +47,13 @@ export const Size: Story = {
<Button {...args} size="xl">
Size xl
</Button>
</StoryLayout>
</Showcase>
),
};

export const Icon: Story = {
render: (args) => (
<StoryLayout>
<Showcase>
<Button {...args}>No icon</Button>
<Button {...args}>
<IconComponent data={Heart} />
Expand All @@ -71,7 +71,7 @@ export const Icon: Story = {
<Button {...args}>
<IconComponent data={Copy} />
</Button>
</StoryLayout>
</Showcase>
),
};

Expand Down Expand Up @@ -121,15 +121,15 @@ export const Width: Story = {
export const Pin: Story = {
render: (args) => {
return (
<StoryLayout>
<Showcase>
<Button {...args}>Round</Button>
<Button {...args} pin="circle-circle">
Circle
</Button>
<Button {...args} pin="brick-brick">
Brick
</Button>
</StoryLayout>
</Showcase>
);
},
};
Expand Down
100 changes: 50 additions & 50 deletions src/components/Checkbox/__stories__/Checkbox.stories.tsx
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
import React from 'react';

import type {Meta, StoryFn} from '@storybook/react';
import type {Meta, StoryObj} from '@storybook/react';

import {Showcase} from '../../../demo/Showcase';
import {Checkbox} from '../Checkbox';
import type {CheckboxProps} from '../Checkbox';

import {CheckboxShowcase} from './CheckboxShowcase';

Expand All @@ -12,58 +12,58 @@ export default {
component: Checkbox,
} as Meta;

const DefaultTemplate: StoryFn<CheckboxProps> = (args) => <Checkbox {...args} />;
export const Default = DefaultTemplate.bind({});
type Story = StoryObj<typeof Checkbox>;

const SizeTemplate: StoryFn<CheckboxProps> = (args) => (
<React.Fragment>
m: <Checkbox {...args} size="m" />
<span style={{margin: '16px'}} />
l: <Checkbox {...args} size="l" />
</React.Fragment>
);
export const Size = SizeTemplate.bind({});
export const Default: Story = {
args: {
content: 'Label',
},
};

const DisabledTemplate: StoryFn<CheckboxProps> = (args) => (
<React.Fragment>
<Checkbox {...args} defaultChecked disabled content="Disabled checked" />
<span style={{margin: '16px'}} />
<Checkbox disabled content="Disabled" />
</React.Fragment>
);
export const Disabled = DisabledTemplate.bind({});
export const Checked: Story = {
args: {
...Default.args,
checked: true,
},
};

const IndeterminateTemplate: StoryFn<CheckboxProps> = (args) => (
<Checkbox {...args} indeterminate />
);
export const Indeterminate = IndeterminateTemplate.bind({});
export const Indeterminate: Story = {
args: {
...Default.args,
indeterminate: true,
},
};

const LabelTemplate: StoryFn<CheckboxProps> = (args) => (
<React.Fragment>
<Checkbox {...args} size="m" content="content m" />
<span style={{margin: '16px'}} />
<Checkbox {...args} size="l" content="content l" />
<div style={{width: 200, marginTop: 10}}>
<Checkbox {...args} size="m" style={{width: '100%'}}>
<div style={{display: 'flex', justifyContent: 'space-between'}}>
<span>Full</span>
<span>width</span>
<span>content</span>
</div>
export const Size: Story = {
render: (args) => (
<Showcase>
<Checkbox {...args} size="m">
Size m
</Checkbox>
</div>
</React.Fragment>
);
export const Label = LabelTemplate.bind({});
<Checkbox {...args} size="l">
Size l
</Checkbox>
</Showcase>
),
};

const ControlledTemplate: StoryFn<CheckboxProps> = (args) => (
<React.Fragment>
<Checkbox {...args} content="Controlled checked" checked />
<span style={{margin: '16px'}} />
<Checkbox {...args} content="Controlled unchecked" checked={false} />
</React.Fragment>
);
export const Controlled = ControlledTemplate.bind({});
export const Disabled: Story = {
render: (args) => (
<Showcase>
<Checkbox {...args} disabled checked={false}>
Unchecked
</Checkbox>
<Checkbox {...args} disabled checked>
Checked
</Checkbox>
<Checkbox {...args} disabled indeterminate>
Indeterminate
</Checkbox>
</Showcase>
),
};

const ShowcaseTemplate: StoryFn = () => <CheckboxShowcase />;
export const Showcase = ShowcaseTemplate.bind({});
export const ShowcaseStory: Story = {
render: () => <CheckboxShowcase />,
name: 'Showcase',
};
10 changes: 5 additions & 5 deletions src/components/Checkbox/__stories__/CheckboxShowcase.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@ import {Checkbox} from '../Checkbox';

export function CheckboxShowcase() {
return (
<Showcase title="Checkbox">
<ShowcaseItem title="size">
<Showcase>
<ShowcaseItem title="Size">
<p>
<Checkbox size="m" checked={false} content="size m" />
<span style={{margin: '8px'}} />
Expand All @@ -23,7 +23,7 @@ export function CheckboxShowcase() {
<Checkbox size="l" indeterminate={true} content="size l" />
</p>
</ShowcaseItem>
<ShowcaseItem title="disabled">
<ShowcaseItem title="Disabled">
<p>
<Checkbox checked={false} disabled content="unchecked" />
</p>
Expand All @@ -34,15 +34,15 @@ export function CheckboxShowcase() {
<Checkbox checked={true} disabled content="checked" />
</p>
</ShowcaseItem>
<ShowcaseItem title="uncontrolled">
<ShowcaseItem title="Uncontrolled">
<p>
<Checkbox defaultChecked={false} content="unchecked" />
</p>
<p>
<Checkbox defaultChecked={true} content="checked" />
</p>
</ShowcaseItem>
<ShowcaseItem title="controlled">
<ShowcaseItem title="Controlled">
<p>
<Checkbox checked={false} content="unchecked" />
</p>
Expand Down
7 changes: 7 additions & 0 deletions src/components/Checkbox/__stories__/Docs.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
import {Meta, Markdown} from '@storybook/addon-docs';
import * as Stories from './Checkbox.stories';
import Readme from '../README.md?raw';

<Meta of={Stories} />

<Markdown>{Readme}</Markdown>
7 changes: 7 additions & 0 deletions src/components/Radio/__stories__/Docs.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
import {Meta, Markdown} from '@storybook/addon-docs';
import * as Stories from './Radio.stories';
import Readme from '../README.md?raw';

<Meta of={Stories} />

<Markdown>{Readme}</Markdown>
52 changes: 46 additions & 6 deletions src/components/Radio/__stories__/Radio.stories.tsx
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
import React from 'react';

import type {Meta, StoryFn} from '@storybook/react';
import type {Meta, StoryObj} from '@storybook/react';

import {Showcase} from '../../../demo/Showcase';
import {Radio} from '../Radio';
import type {RadioProps} from '../Radio';

import {RadioShowcase} from './RadioShowcase';

Expand All @@ -12,8 +12,48 @@ export default {
component: Radio,
} as Meta;

const DefaultTemplate: StoryFn<RadioProps> = (args) => <Radio {...args} />;
export const Default = DefaultTemplate.bind({});
type Story = StoryObj<typeof Radio>;

const ShowcaseTemplate: StoryFn = () => <RadioShowcase />;
export const Showcase = ShowcaseTemplate.bind({});
export const Default: Story = {
args: {
content: 'Label',
},
};

export const Checked: Story = {
args: {
...Default.args,
checked: true,
},
};

export const Size: Story = {
render: (args) => (
<Showcase>
<Radio {...args} size="m">
Size m
</Radio>
<Radio {...args} size="l">
Size l
</Radio>
</Showcase>
),
};

export const Disabled: Story = {
render: (args) => (
<Showcase>
<Radio {...args} disabled checked={false}>
Unchecked
</Radio>
<Radio {...args} disabled checked>
Checked
</Radio>
</Showcase>
),
};

export const ShowcaseStory: Story = {
render: () => <RadioShowcase />,
name: 'Showcase',
};
14 changes: 7 additions & 7 deletions src/components/Radio/__stories__/RadioShowcase.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@ import {Radio} from '../Radio';

export function RadioShowcase() {
return (
<Showcase title="Radio">
<ShowcaseItem title="size">
<Showcase>
<ShowcaseItem title="Size">
<p>
<Radio size="m" content="size m" value="value 1" />
<span style={{margin: '8px'}} />
Expand All @@ -19,11 +19,11 @@ export function RadioShowcase() {
<Radio size="l" content="size l" value="value 2" />
</p>
</ShowcaseItem>
<ShowcaseItem title="disabled">
<ShowcaseItem title="Disabled">
<p>
<Radio
size="m"
content="unchecked"
content="Unchecked"
defaultChecked={false}
value="value 1"
disabled
Expand All @@ -32,14 +32,14 @@ export function RadioShowcase() {
<p>
<Radio
size="m"
content="checked"
content="Checked"
defaultChecked={true}
value="value 2"
disabled
/>
</p>
</ShowcaseItem>
<ShowcaseItem title="uncontrolled">
<ShowcaseItem title="Uncontrolled">
<p>
<Radio size="m" content="checked" defaultChecked={true} value="value 1" />
</p>
Expand All @@ -48,7 +48,7 @@ export function RadioShowcase() {
</p>
</ShowcaseItem>

<ShowcaseItem title="controlled">
<ShowcaseItem title="Controlled">
<p>
<Radio size="m" content="checked" checked={true} value="value 1" />
</p>
Expand Down
7 changes: 7 additions & 0 deletions src/components/RadioButton/__stories__/Docs.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
import {Meta, Markdown} from '@storybook/addon-docs';
import * as Stories from './RadioButton.stories';
import Readme from '../README.md?raw';

<Meta of={Stories} />

<Markdown>{Readme}</Markdown>
Loading
Loading