{/* Introduction.mdx */}
import { Meta } from 'storybook/blocks';
<Meta title="Introduction" />
Welcome to the Yemaya component library documentation. This Storybook showcases the UI components used in the Yemaya web application.
Getting Started#
To run Storybook locally:
bash
cd apps/yemaya/studio-web
pnpm storybook
To build the static Storybook site:
bash
pnpm build-storybook
Design Principles#
Theming#
All components support both light and dark themes through CSS custom properties. Use the theme toggle in the toolbar to preview components in different themes.
css
/* Available CSS custom properties */
--color-bg-primary
--color-bg-secondary
--color-bg-tertiary
--color-text-primary
--color-text-secondary
--color-border
--color-accent
--color-accent-light
Accessibility#
Components are built with accessibility in mind:
- Proper ARIA labels and roles
- Keyboard navigation support
- Focus management
- Color contrast compliance
Responsive Design#
Components are responsive by default using Tailwind CSS utilities:
- Mobile-first approach
- Breakpoints:
sm(640px),md(768px),lg(1024px),xl(1280px)
Component Categories#
Layout Components#
- Layout - Main application shell with header and sidebar
- Header - Top navigation bar with branding and user actions
- Sidebar - Side navigation with collapsible design
Navigation#
- Header Navigation - Top-level navigation links
- Sidebar Navigation - Hierarchical navigation for different sections
Contributing#
When adding new components:
- Create the component in
src/components/ - Add a story file in
src/stories/ - Include all relevant states and variations
- Add accessibility annotations
- Document props with JSDoc comments