mirror of
https://github.com/CherryHQ/cherry-studio.git
synced 2026-07-05 13:47:59 +08:00
Co-authored-by: Claude Opus 4.8 <noreply@anthropic.com> Co-authored-by: Pleasurecruise <3196812536@qq.com> Co-authored-by: fullex <106392080+0xfullex@users.noreply.github.com> Signed-off-by: gujiaming <52187003+AtomsH4@users.noreply.github.com> Signed-off-by: Pleasurecruise <3196812536@qq.com>
Stories Guide
This directory contains Storybook stories for packages/ui, separated from the source tree to keep the component implementation structure clean.
Directory Structure
stories/
├── components/
│ ├── base/ # Base component stories
│ ├── display/ # Display component stories
│ ├── interactive/ # Interactive component stories
│ ├── icons/ # Icon component stories
│ ├── layout/ # Layout component stories
│ └── composite/ # Composite component stories
└── README.md # This guide
Naming Conventions
- File names should follow
ComponentName.stories.tsx - Story titles should follow
Category/ComponentName, for exampleBase/CustomTag - Import source components through relative paths, for example
../../../src/components/base/ComponentName
Authoring Guidelines
Each story file should usually include:
- Default - basic usage
- Variants - different variants or visual states
- Interactive - interaction demos when applicable
- Use Cases - realistic examples
Run Storybook
cd packages/ui
pnpm storybook
Open http://localhost:6006 to browse the component documentation.