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: Add docs for story tags #26715

Merged
merged 7 commits into from
May 7, 2024
Merged
Show file tree
Hide file tree
Changes from 5 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
1 change: 1 addition & 0 deletions docs/api/cli-options.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: 'CLI options'
hideRendererSelector: true
---

The Storybook command line interface (CLI) is the main tool you use to build and develop Storybook.
Expand Down
33 changes: 0 additions & 33 deletions docs/snippets/angular/button-story-auto-docs.ts.mdx

This file was deleted.

13 changes: 13 additions & 0 deletions docs/snippets/angular/tags-autodocs-in-meta.ts.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
```ts
// Button.stories.ts
import type { Meta } from '@storybook/angular';

import { Button } from './Button';

const meta: Meta<Button> = {
component: Button,
//👇 Enables auto-generated documentation for this component and includes all stories in this file
tags: ['autodocs'],
};
export default meta;
```
13 changes: 13 additions & 0 deletions docs/snippets/angular/tags-autodocs-remove-component.ts.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
```ts
// Page.stories.ts
import type { Meta, StoryObj } from '@storybook/angular';

import { Page } from './Page';

const meta: Meta<Page> = {
component: Page,
// 👇 Disable auto-generated documentation for this component
tags: ['!autodocs'],
};
export default meta;
```
20 changes: 20 additions & 0 deletions docs/snippets/angular/tags-autodocs-remove-story.ts.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
```ts
// Button.stories.ts
import type { Meta, StoryObj } from '@storybook/angular';

import { Button } from './Button';

const meta: Meta<Button> = {
component: Button,
//👇 Enables auto-generated documentation for this component and includes all stories in this file
tags: ['autodocs'],
};
export default meta;

type Story = StoryObj<Button>;

export const UndocumentedStory: Story = {
// 👇 Removes this story from auto-generated documentation
tags: ['!autodocs'],
};
```
41 changes: 41 additions & 0 deletions docs/snippets/angular/tags-combo-example.ts.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
```ts
// Button.stories.ts
import type { Meta, StoryObj } from '@storybook/angular';

import { Button } from './Button';

const meta: Meta<Button> = {
component: Button,
};
export default meta;

type Story = StoryObj<Button>;

export const Variant1: Story = {
// 👇 This story will not appear in Storybook's sidebar or docs page
tags: ['!dev', '!docs'],
args: { variant: 1 },
};

export const Variant2: Story = {
// 👇 This story will not appear in Storybook's sidebar or docs page
tags: ['!dev', '!docs'],
args: { variant: 2 },
};

// Etc...

export const Combo: Story = {
// 👇 This story should not be tested, but will appear in the sidebar and docs page
tags: ['!test'],
render: () => ({
template: `
<div>
<demo-button variant={1}>
<demo-button variant={2}>
<!-- Etc... -->
</div>
`,
}),
};
```
17 changes: 17 additions & 0 deletions docs/snippets/angular/tags-docs-only-in-meta.ts.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
```ts
// Button.stories.ts
import type { Meta, StoryObj } from '@storybook/angular';

import { Button } from './Button';

const meta: Meta<Button> = {
component: Button,
/**
* 👇 All stories in this file will:
* - Be included in the docs page
* - Not appear in Storybook's sidebar
*/
tags: ['autodocs', '!dev'],
};
export default meta;
```
31 changes: 31 additions & 0 deletions docs/snippets/angular/tags-in-meta-and-story.ts.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
```ts
// Button.stories.ts
import type { Meta, StoryObj } from '@storybook/angular';

import { Button } from './Button';

const meta: Meta<Button> = {
component: Button,
/**
* 👇 All stories in this file will have these tags applied:
* - autodocs
* - dev (implicit default, inherited from preview)
* - test (implicit default, inherited from preview)
*/
tags: ['autodocs'],
};
export default meta;

type Story = StoryObj<Button>;

export const ExperimentalFeatureStory: Story = {
/**
* 👇 This particular story will have these tags applied:
* - experimental
* - autodocs (inherited from meta)
* - dev (inherited from meta)
* - test (inherited from meta)
*/
tags: ['experimental'],
};
```
23 changes: 23 additions & 0 deletions docs/snippets/angular/tags-remove-in-story.ts.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
```ts
// Button.stories.ts
import type { Meta, StoryObj } from '@storybook/angular';

import { Button } from './Button';

const meta: Meta<Button> = {
component: Button,
// 👇 Applies to all stories in this file
tags: ['stable'],
};
export default meta;

type Story = StoryObj<Button>;

export const ExperimentalFeatureStory: Story = {
/**
* 👇 For this particular story, remove the inherited
* `stable` tag and apply the `experimental` tag
*/
tags: ['!stable', 'experimental'],
};
```
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,6 @@ export default {
addons: ['@storybook/addon-essentials'],
docs: {
//👇 See the table below for the list of supported options
autodocs: 'tag',
defaultName: 'Documentation',
},
};
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,6 @@ const config: StorybookConfig = {
addons: ['@storybook/addon-essentials'],
docs: {
//👇 See the table below for the list of supported options
autodocs: 'tag',
defaultName: 'Documentation',
},
};
Expand Down
10 changes: 10 additions & 0 deletions docs/snippets/common/tags-autodocs-in-meta.js.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
```js
// Button.stories.js
import { Button } from './Button';

export default {
component: Button,
//👇 Enables auto-generated documentation for this component and includes all stories in this file
tags: ['autodocs'],
};
```
14 changes: 14 additions & 0 deletions docs/snippets/common/tags-autodocs-in-meta.ts-4-9.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
```ts
// Button.stories.ts
// Replace your-framework with the framework you are using (e.g., nextjs, vue3-vite)
import type { Meta } from '@storybook/your-framework';

import { Button } from './Button';

const meta = {
component: Button,
//👇 Enables auto-generated documentation for this component and includes all stories in this file
tags: ['autodocs'],
} satisfies Meta<typeof Button>;
export default meta;
```
14 changes: 14 additions & 0 deletions docs/snippets/common/tags-autodocs-in-meta.ts.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
```ts
// Button.stories.ts
// Replace your-framework with the framework you are using (e.g., nextjs, vue3-vite)
import type { Meta } from '@storybook/your-framework';

import { Button } from './Button';

const meta: Meta<typeof Button> = {
component: Button,
//👇 Enables auto-generated documentation for this component and includes all stories in this file
tags: ['autodocs'],
};
export default meta;
```
8 changes: 8 additions & 0 deletions docs/snippets/common/tags-autodocs-in-preview.js.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
```js
// .storybook/preview.js
export default {
// ...rest of preview
//👇 Enables auto-generated documentation for all stories
tags: ['autodocs'],
};
```
13 changes: 13 additions & 0 deletions docs/snippets/common/tags-autodocs-in-preview.ts.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
```ts
// .storybook/preview.ts
// Replace your-renderer with the renderer you are using (e.g., react, vue3)
import type { Preview } from '@storybook/your-renderer';

const preview: Preview = {
// ...rest of preview
//👇 Enables auto-generated documentation for all stories
tags: ['autodocs'],
};

export default preview;
```
10 changes: 10 additions & 0 deletions docs/snippets/common/tags-autodocs-remove-component.js.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
```js
// Page.stories.js
import { Page } from './Page';

export default {
component: Page,
// 👇 Disable auto-generated documentation for this component
tags: ['!autodocs'],
};
```
14 changes: 14 additions & 0 deletions docs/snippets/common/tags-autodocs-remove-component.ts-4-9.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
```ts
// Page.stories.ts
// Replace your-framework with the framework you are using (e.g., nextjs, vue3-vite)
import type { Meta, StoryObj } from '@storybook/your-framework';

import { Page } from './Page';

const meta = {
component: Page,
// 👇 Disable auto-generated documentation for this component
tags: ['!autodocs'],
} satisfies Meta<typeof Page>;
export default meta;
```
14 changes: 14 additions & 0 deletions docs/snippets/common/tags-autodocs-remove-component.ts.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
```ts
// Page.stories.ts
// Replace your-framework with the framework you are using (e.g., nextjs, vue3-vite)
import type { Meta, StoryObj } from '@storybook/your-framework';

import { Page } from './Page';

const meta: Meta<typeof Page> = {
component: Page,
// 👇 Disable auto-generated documentation for this component
tags: ['!autodocs'],
};
export default meta;
```
15 changes: 15 additions & 0 deletions docs/snippets/common/tags-autodocs-remove-story.js.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
```js
// Button.stories.js
import { Button } from './Button';

export default {
component: Button,
//👇 Enables auto-generated documentation for this component and includes all stories in this file
tags: ['autodocs'],
};

export const UndocumentedStory = {
// 👇 Removes this story from auto-generated documentation
tags: ['!autodocs'],
};
```
21 changes: 21 additions & 0 deletions docs/snippets/common/tags-autodocs-remove-story.ts-4-9.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
```ts
// Button.stories.ts
// Replace your-framework with the framework you are using (e.g., nextjs, vue3-vite)
import type { Meta, StoryObj } from '@storybook/your-framework';

import { Button } from './Button';

const meta = {
component: Button,
//👇 Enables auto-generated documentation for this component and includes all stories in this file
tags: ['autodocs'],
} satisfies Meta<typeof Button>;
export default meta;

type Story = StoryObj<typeof meta>;

export const UndocumentedStory: Story = {
// 👇 Removes this story from auto-generated documentation
tags: ['!autodocs'],
};
```
21 changes: 21 additions & 0 deletions docs/snippets/common/tags-autodocs-remove-story.ts.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
```ts
// Button.stories.ts
// Replace your-framework with the framework you are using (e.g., nextjs, vue3-vite)
import type { Meta, StoryObj } from '@storybook/your-framework';

import { Button } from './Button';

const meta: Meta<typeof Button> = {
component: Button,
//👇 Enables auto-generated documentation for this component and includes all stories in this file
tags: ['autodocs'],
};
export default meta;

type Story = StoryObj<typeof Button>;

export const UndocumentedStory: Story = {
// 👇 Removes this story from auto-generated documentation
tags: ['!autodocs'],
};
```
Loading