oakoss/agent-skills

storybook-stories

Writes and maintains Storybook stories and interaction tests using CSF3 format.

ソースを見る

使い方

  1. インストールコマンドをコピーし、自分の環境へ導入する前にソースを確認します。
  2. 必要なツール、認証情報、対応環境を原文で確認します。
  3. 入力と成果物を指定し、出力を資料と照合します。
npx skills add https://github.com/oakoss/agent-skills --skill storybook-stories

開始前の確認

  • 導入にはモデル契約、API枠、ファイルへのアクセス許可は含まれません。
  • スター数や導入数は活動の指標であり、独立した品質・安全性試験ではありません。
リポジトリの原文

見出し、例、コード、表、リンク、参照画像を含む原文を表示しています。

Storybook Stories

Overview

Storybook is a frontend workshop for building UI components in isolation. Stories are written in Component Story Format 3 (CSF3), which uses object syntax with args for type-safe component documentation and testing.

When to use: Component documentation with live examples, interaction testing with play functions, visual regression testing, accessibility validation, design system maintenance, isolated component development.

When NOT to use: End-to-end testing (use Playwright/Cypress), API integration testing (use Vitest/Jest), full application testing (use browser automation), performance testing (use Lighthouse/WebPageTest).

Quick Reference

PatternAPIKey Points
Basic storyexport const Default: Story = { args }Use args for simple single components
Complex storyexport const Example: Story = { render }Use render for multi-component layouts
Meta configurationconst meta = { component, args } satisfies MetaDefine defaults and argTypes
Interaction testplay: async ({ canvas, userEvent, args })canvas and userEvent provided directly
User interactionawait userEvent.click(element)Always await userEvent methods
Query elementscanvas.getByRole('button')Prefer getByRole over other queries
Assertionsawait expect(args.onPress).toHaveBeenCalled()Use storybook/test assertions
beforeEach hookbeforeEach: async ({ args }) => {}Setup mocks before story renders
Play compositionawait OtherStory.play?.(context)Reuse setup across stories
Autodocstags: ['autodocs']Enable automatic documentation
Controls customizationargTypes: { variant: { control: 'select' } }Configure control panel
Decoratorsdecorators: [withTheme]Add wrappers or context providers
Parametersparameters: { layout: 'centered' }Configure addon behavior per story
Chromatic snapshotparameters: { chromatic: { delay: 300 } }Control visual regression captures
Disable snapshotparameters: { chromatic: { disableSnapshot: true } }Skip story in visual tests
A11y testingawait expect(button).toHaveAccessibleName()Validate accessible labels

Common Mistakes

MistakeCorrect Pattern
Using args with multi-component layoutsUse render for complex compositions
Not awaiting userEvent methodsAlways await: await userEvent.click(button)
Using within(canvasElement) manuallyDestructure canvas from play context directly
Using getByTestId firstPrefer getByRole, getByLabelText, getByText
Missing default args at meta levelAdd args to meta to prevent placeholder controls
Exposing non-serializable propsDisable className, ref, style in argTypes
Not composing play functionsReuse setup with await BaseStory.play?.(context)
Forgetting to mock callbacksUse fn() for event handlers: args: { onPress: fn() }
Missing accessible names for icon buttonsAdd aria-label or use aria-labelledby
Not scoping queries for portal contentUse within(canvasElement.ownerDocument.body)
Using boolean && for conditional renderingUse ternary in stories for consistent snapshots
Not waiting for animationsWrap assertions in waitFor for async state

Common Fixes

ProblemSolution
Controls show placeholdersAdd args at meta level with default values
Serialization errorDisable className, ref, style in argTypes
Portal element not foundSearch body instead of canvas
Animation timing issuesWrap assertions in waitFor
Multiple buttons foundAdd { name: '...' } to getByRole
A11y test failingAdd label prop or aria-label

Delegation

  • Story structure review: Use code-reviewer skill for CSF3 pattern validation
  • Accessibility audit: Use Explore agent to discover ARIA patterns across stories
  • Visual regression analysis: Use Task agent to investigate Chromatic failures

References

同じリポジトリから

関連する Skills

すべての Skills