@mhmo91/schmancy 0.2.194 → 0.2.196

package/ai/nav-drawer.md

@@ -0,0 +1,206 @@
+# Navigation Drawer Component
+
+A responsive navigation drawer system that adapts between overlay and push modes based on screen size, providing flexible app navigation patterns.
+
+## Quick Start
+
+```html
+<!-- Basic navigation drawer -->
+<schmancy-nav-drawer>
+  <schmancy-nav-drawer-navbar>
+    <nav>
+      <schmancy-list>
+        <schmancy-list-item>Dashboard</schmancy-list-item>
+        <schmancy-list-item>Settings</schmancy-list-item>
+      </schmancy-list>
+    </nav>
+  </schmancy-nav-drawer-navbar>
+  
+  <schmancy-nav-drawer-content>
+    <schmancy-nav-drawer-appbar>
+      <h1>My App</h1>
+    </schmancy-nav-drawer-appbar>
+    <main>
+      <!-- Page content -->
+    </main>
+  </schmancy-nav-drawer-content>
+</schmancy-nav-drawer>
+```
+
+## Components
+
+### schmancy-nav-drawer
+The root container that manages drawer state and responsive behavior.
+
+**Properties:**
+| Property | Type | Default | Description |
+|----------|------|---------|-------------|
+| `fullscreen` | `boolean` | `false` | Hide drawer in fullscreen mode |
+| `breakpoint` | `'sm' \| 'md' \| 'lg' \| 'xl'` | `'md'` | Responsive breakpoint |
+| `open` | `'open' \| 'close'` | - | Drawer state |
+
+### schmancy-nav-drawer-navbar
+The navigation sidebar component.
+
+**Properties:**
+| Property | Type | Default | Description |
+|----------|------|---------|-------------|
+| `width` | `string` | `'320px'` | Drawer width |
+
+### schmancy-nav-drawer-content
+Container for main content area.
+
+### schmancy-nav-drawer-appbar
+Optional app bar for the content area.
+
+## Examples
+
+### Complete App Layout
+```html
+<schmancy-nav-drawer breakpoint="lg">
+  <!-- Navigation Sidebar -->
+  <schmancy-nav-drawer-navbar width="280px">
+    <div class="p-4">
+      <h2 class="text-xl font-bold mb-4">My App</h2>
+    </div>
+    
+    <schmancy-list>
+      <schmancy-list-item @click="${() => navigate('/dashboard')}">
+        <schmancy-icon slot="start">dashboard</schmancy-icon>
+        Dashboard
+      </schmancy-list-item>
+      
+      <schmancy-list-item @click="${() => navigate('/users')}">
+        <schmancy-icon slot="start">people</schmancy-icon>
+        Users
+      </schmancy-list-item>
+      
+      <schmancy-divider class="my-2"></schmancy-divider>
+      
+      <schmancy-list-item @click="${() => navigate('/settings')}">
+        <schmancy-icon slot="start">settings</schmancy-icon>
+        Settings
+      </schmancy-list-item>
+    </schmancy-list>
+  </schmancy-nav-drawer-navbar>
+  
+  <!-- Main Content -->
+  <schmancy-nav-drawer-content>
+    <!-- App Bar -->
+    <schmancy-nav-drawer-appbar>
+      <schmancy-icon-button @click="${toggleDrawer}">
+        menu
+      </schmancy-icon-button>
+      <h1 class="text-xl">Dashboard</h1>
+    </schmancy-nav-drawer-appbar>
+    
+    <!-- Page Content -->
+    <main class="p-4">
+      <router-outlet></router-outlet>
+    </main>
+  </schmancy-nav-drawer-content>
+</schmancy-nav-drawer>
+```
+
+### With User Profile
+```html
+<schmancy-nav-drawer>
+  <schmancy-nav-drawer-navbar>
+    <!-- User Profile Section -->
+    <div class="p-4 border-b">
+      <schmancy-avatar 
+        src="/user-avatar.jpg" 
+        name="John Doe"
+      ></schmancy-avatar>
+      <div class="mt-2">
+        <div class="font-medium">John Doe</div>
+        <div class="text-sm opacity-70">john@example.com</div>
+      </div>
+    </div>
+    
+    <!-- Navigation -->
+    <schmancy-list class="py-2">
+      <!-- Menu items -->
+    </schmancy-list>
+  </schmancy-nav-drawer-navbar>
+  
+  <schmancy-nav-drawer-content>
+    <!-- Content -->
+  </schmancy-nav-drawer-content>
+</schmancy-nav-drawer>
+```
+
+## Features
+
+### Responsive Modes
+- **Push Mode**: Drawer pushes content (desktop)
+- **Overlay Mode**: Drawer overlays content (mobile)
+- Automatic switching based on breakpoint
+
+### Breakpoint Values
+- `sm`: 640px
+- `md`: 768px (default)
+- `lg`: 1024px
+- `xl`: 1280px
+
+### Events
+Toggle drawer programmatically:
+```javascript
+window.dispatchEvent(
+  new CustomEvent('schmancy-nav-drawer-toggle', {
+    detail: { state: 'open' } // or 'close'
+  })
+);
+```
+
+### Animation
+Smooth transitions with customizable easing:
+- Overlay fade: 200ms open, 150ms close
+- Drawer slide: 200ms
+- Cubic bezier easing for natural motion
+
+## Styling
+
+```css
+/* Custom drawer styling */
+schmancy-nav-drawer-navbar {
+  --drawer-width: 320px;
+  --animation-duration: 200ms;
+}
+
+/* Overlay customization */
+schmancy-nav-drawer {
+  --overlay-opacity: 0.4;
+  --overlay-color: var(--schmancy-sys-color-scrim);
+}
+```
+
+## Context System
+
+The component uses Lit Context API for state management:
+- `SchmancyDrawerNavbarMode`: Current mode (push/overlay)
+- `SchmancyDrawerNavbarState`: Open/close state
+
+## Best Practices
+
+1. **Navigation Structure**: Keep navigation hierarchy shallow
+2. **Mobile First**: Design for overlay mode first
+3. **Breakpoints**: Choose breakpoints based on content
+4. **Performance**: Use `fullscreen` prop for immersive experiences
+5. **Accessibility**: Include proper ARIA labels
+
+## Related Components
+
+- [List](./list.md) - Navigation menu items
+- [Icon](./icons.md) - Menu icons
+- [Avatar](./avatar.md) - User profiles
+- [Surface](./surface.md) - Content containers
+- [Button](./button.md) - Navigation triggers
+
+## Use Cases
+
+1. **Admin Dashboards**: Multi-section navigation
+2. **Mobile Apps**: Responsive app shells
+3. **Documentation Sites**: Side navigation
+4. **E-commerce**: Category navigation
+5. **Social Apps**: User navigation with profiles

package/ai/option.md

@@ -0,0 +1,173 @@
+# Option Component
+
+A versatile option element designed for use with select dropdowns and autocomplete components, providing accessible and interactive selection items.
+
+## Quick Start
+
+```html
+<!-- Basic option -->
+<schmancy-option value="1">Option One</schmancy-option>
+
+<!-- Option with custom label -->
+<schmancy-option value="us" label="United States"></schmancy-option>
+
+<!-- Option with icon -->
+<schmancy-option value="email" icon="✉️">Email Notifications</schmancy-option>
+```
+
+## Properties
+
+| Property | Type | Default | Description |
+|----------|------|---------|-------------|
+| `value` | `string` | `''` | The value when selected |
+| `label` | `string` | `''` | Display label (defaults to text content) |
+| `selected` | `boolean` | `false` | Whether option is selected |
+| `disabled` | `boolean` | `false` | Whether option is disabled |
+| `group` | `string` | `''` | Optional group name |
+| `icon` | `string` | `''` | Optional icon/emoji |
+
+## Events
+
+### option-select
+Fired when option is clicked or selected via keyboard.
+
+```typescript
+interface OptionSelectEvent {
+  detail: {
+    value: string;
+  }
+}
+```
+
+## Examples
+
+### In Select Component
+```html
+<schmancy-select placeholder="Choose country">
+  <schmancy-option value="us" icon="🇺🇸">United States</schmancy-option>
+  <schmancy-option value="uk" icon="🇬🇧">United Kingdom</schmancy-option>
+  <schmancy-option value="ca" icon="🇨🇦">Canada</schmancy-option>
+  <schmancy-option value="au" icon="🇦🇺">Australia</schmancy-option>
+</schmancy-select>
+```
+
+### Grouped Options
+```html
+<schmancy-select>
+  <!-- North America -->
+  <schmancy-option value="us" group="North America">United States</schmancy-option>
+  <schmancy-option value="ca" group="North America">Canada</schmancy-option>
+  <schmancy-option value="mx" group="North America">Mexico</schmancy-option>
+  
+  <!-- Europe -->
+  <schmancy-option value="uk" group="Europe">United Kingdom</schmancy-option>
+  <schmancy-option value="de" group="Europe">Germany</schmancy-option>
+  <schmancy-option value="fr" group="Europe">France</schmancy-option>
+</schmancy-select>
+```
+
+### With Status Indicators
+```html
+<schmancy-autocomplete>
+  <schmancy-option value="active" icon="🟢">Active</schmancy-option>
+  <schmancy-option value="pending" icon="🟡">Pending</schmancy-option>
+  <schmancy-option value="inactive" icon="🔴">Inactive</schmancy-option>
+  <schmancy-option value="archived" icon="📦" disabled>Archived</schmancy-option>
+</schmancy-autocomplete>
+```
+
+### Dynamic Options
+```html
+${users.map(user => html`
+  <schmancy-option 
+    value="${user.id}"
+    label="${user.name}"
+    ?disabled="${!user.active}"
+  >
+    <span class="flex items-center gap-2">
+      <schmancy-avatar size="xs" name="${user.name}"></schmancy-avatar>
+      <span>
+        <div>${user.name}</div>
+        <div class="text-xs opacity-70">${user.email}</div>
+      </span>
+    </span>
+  </schmancy-option>
+`)}
+```
+
+## Features
+
+### Automatic Value Assignment
+- If no value is provided, uses text content
+- If no label is provided, uses text content or value
+
+### Keyboard Navigation
+- `Space` or `Enter` to select
+- Full keyboard accessibility
+
+### Visual States
+- Hover highlighting
+- Selected state with checkmark
+- Disabled state with reduced opacity
+- Focus ring for keyboard navigation
+
+### Unique IDs
+Automatically generates unique IDs for accessibility if not provided.
+
+## Styling
+
+The component uses semantic design tokens:
+
+```css
+/* Default state */
+.hover:bg-surface-high
+
+/* Selected state */
+.bg-primary-container
+.text-primary-onContainer
+
+/* Custom styling */
+schmancy-option {
+  --option-padding-y: 0.5rem;
+  --option-padding-x: 0.75rem;
+  --option-border-radius: 0.25rem;
+}
+```
+
+## Accessibility
+
+- `role="option"` for semantic meaning
+- `aria-selected` state management
+- `aria-disabled` for disabled options
+- Keyboard event handling
+- Focus management
+
+## Integration
+
+Options are designed to work seamlessly with:
+- `schmancy-select` - Dropdown selection
+- `schmancy-autocomplete` - Filtered selection
+- Custom dropdown components
+
+## Best Practices
+
+1. **Clear Values**: Use meaningful, unique values
+2. **Icons**: Use icons to improve scannability
+3. **Groups**: Group related options together
+4. **Labels**: Provide clear, concise labels
+5. **Disabled State**: Clearly indicate why options are disabled
+
+## Related Components
+
+- [Select](./select.md) - Dropdown selector
+- [Autocomplete](./autocomplete.md) - Searchable selector
+- [List](./list.md) - Similar list item pattern
+- [Menu](./menu.md) - Menu items
+
+## Use Cases
+
+1. **Form Selects**: Country, state, category selection
+2. **Settings**: Preference options
+3. **Filters**: Data filtering options
+4. **Status Selection**: Workflow states
+5. **User Selection**: Team member pickers

package/ai/slider.md

@@ -0,0 +1,227 @@
+# Slider Component
+
+A smooth, touch-friendly carousel component for displaying content in slides with navigation controls and indicators.
+
+## Quick Start
+
+```html
+<!-- Basic image slider -->
+<schmancy-slider>
+  <schmancy-slide type="image" src="/image1.jpg" alt="Slide 1"></schmancy-slide>
+  <schmancy-slide type="image" src="/image2.jpg" alt="Slide 2"></schmancy-slide>
+  <schmancy-slide type="image" src="/image3.jpg" alt="Slide 3"></schmancy-slide>
+</schmancy-slider>
+
+<!-- Content slider -->
+<schmancy-slider showArrows>
+  <schmancy-slide>
+    <schmancy-card>
+      <h3>Feature One</h3>
+      <p>Description of the first feature...</p>
+    </schmancy-card>
+  </schmancy-slide>
+  <schmancy-slide>
+    <schmancy-card>
+      <h3>Feature Two</h3>
+      <p>Description of the second feature...</p>
+    </schmancy-card>
+  </schmancy-slide>
+</schmancy-slider>
+```
+
+## Components
+
+### schmancy-slider
+The main container that handles slide navigation and controls.
+
+**Properties:**
+| Property | Type | Default | Description |
+|----------|------|---------|-------------|
+| `showArrows` | `boolean` | `true` | Show navigation arrows |
+
+**Events:**
+- `slide-changed`: Fired when active slide changes with `{ detail: { index: number } }`
+
+### schmancy-slide
+Individual slide component supporting various content types.
+
+**Properties:**
+| Property | Type | Default | Description |
+|----------|------|---------|-------------|
+| `type` | `'image' \| 'video' \| 'content'` | `'content'` | Slide content type |
+| `src` | `string` | `''` | Source for image/video |
+| `alt` | `string` | `''` | Alt text for images |
+| `controls` | `boolean` | `true` | Show video controls |
+| `autoplay` | `boolean` | `false` | Autoplay video |
+| `loop` | `boolean` | `false` | Loop video |
+| `muted` | `boolean` | `false` | Mute video |
+| `fit` | `'cover' \| 'contain' \| 'fill' \| 'scale-down' \| 'none'` | `'cover'` | Object fit style |
+
+## Examples
+
+### Product Gallery
+```html
+<schmancy-slider class="h-96">
+  ${products.map(product => html`
+    <schmancy-slide type="image" 
+      src="${product.image}" 
+      alt="${product.name}"
+      fit="contain"
+    ></schmancy-slide>
+  `)}
+</schmancy-slider>
+```
+
+### Testimonials Carousel
+```html
+<schmancy-slider showArrows>
+  ${testimonials.map(testimonial => html`
+    <schmancy-slide>
+      <div class="p-8 text-center">
+        <schmancy-avatar 
+          src="${testimonial.avatar}" 
+          name="${testimonial.name}"
+          size="lg"
+          class="mx-auto mb-4"
+        ></schmancy-avatar>
+        <blockquote class="text-lg italic mb-4">
+          "${testimonial.quote}"
+        </blockquote>
+        <cite class="text-sm">
+          - ${testimonial.name}, ${testimonial.role}
+        </cite>
+      </div>
+    </schmancy-slide>
+  `)}
+</schmancy-slider>
+```
+
+### Video Showcase
+```html
+<schmancy-slider>
+  <schmancy-slide 
+    type="video" 
+    src="/demo-video-1.mp4"
+    controls
+    muted
+    autoplay
+  ></schmancy-slide>
+  <schmancy-slide 
+    type="video" 
+    src="/demo-video-2.mp4"
+    controls
+  ></schmancy-slide>
+</schmancy-slider>
+```
+
+### Mixed Content Slider
+```html
+<schmancy-slider>
+  <!-- Welcome slide -->
+  <schmancy-slide>
+    <div class="flex items-center justify-center h-full p-8">
+      <div class="text-center">
+        <h1 class="text-4xl mb-4">Welcome</h1>
+        <p>Swipe to explore our features</p>
+      </div>
+    </div>
+  </schmancy-slide>
+  
+  <!-- Feature image -->
+  <schmancy-slide type="image" src="/feature.jpg" alt="Main Feature"></schmancy-slide>
+  
+  <!-- Video demo -->
+  <schmancy-slide type="video" src="/demo.mp4" controls></schmancy-slide>
+  
+  <!-- Call to action -->
+  <schmancy-slide>
+    <div class="flex items-center justify-center h-full">
+      <schmancy-button variant="filled" size="lg">
+        Get Started
+      </schmancy-button>
+    </div>
+  </schmancy-slide>
+</schmancy-slider>
+```
+
+## Features
+
+### Smooth Scrolling
+- Native scroll behavior with CSS scroll-snap
+- Touch and mouse support
+- Keyboard navigation ready
+
+### Navigation Controls
+- Previous/Next arrow buttons
+- Automatic disable at bounds
+- Dot indicators showing current position
+
+### Responsive Design
+- Slides automatically fill container width
+- Hidden scrollbars for clean appearance
+- Works on all device sizes
+
+### Performance
+- Lazy loading for images
+- Throttled scroll events
+- Efficient slide position detection
+
+## Styling
+
+```css
+/* Container styling */
+schmancy-slider {
+  height: 400px; /* Set explicit height */
+}
+
+/* Custom arrow positioning */
+schmancy-slider::part(prev-button) {
+  left: 1rem;
+}
+
+schmancy-slider::part(next-button) {
+  right: 1rem;
+}
+
+/* Indicator customization */
+schmancy-slider::part(indicators) {
+  bottom: 2rem;
+}
+```
+
+## Navigation Methods
+
+```javascript
+// Get slider element
+const slider = document.querySelector('schmancy-slider');
+
+// Listen for slide changes
+slider.addEventListener('slide-changed', (e) => {
+  console.log('Current slide:', e.detail.index);
+});
+
+// Programmatically navigate (if exposed)
+// slider.goToSlide(2);
+```
+
+## Best Practices
+
+1. **Height**: Always set explicit height on slider container
+2. **Images**: Optimize images for web delivery
+3. **Accessibility**: Provide meaningful alt text
+4. **Performance**: Limit number of slides for better performance
+5. **Touch**: Ensure adequate touch targets on mobile
+
+## Related Components
+
+- [Card](./card.md) - Content containers for slides
+- [Button](./button.md) - Navigation controls
+- [Surface](./surface.md) - Slide backgrounds
+
+## Use Cases
+
+1. **Product Galleries**: E-commerce product images
+2. **Hero Sections**: Landing page carousels
+3. **Testimonials**: Customer feedback showcase
+4. **Tutorials**: Step-by-step guides
+5. **Media Galleries**: Photo and video collections