@signal9/era-ui 32.0.1 → 33.0.0

package/dist/generated-docs/video-player.md

@@ -1,73 +0,0 @@
-# Video Player
-
-A vidstack-powered player with support for MP4, HLS, and live streams.
-
-## Import
-
-```ts
-import { VideoPlayer } from "@signal9/era-ui/video-player";
-```
-
-## Props
-
-| Prop | Type | Default | Notes |
-|------|------|---------|-------|
-| `ref?` | `HTMLElement \| null` | `null` | bindable |
-| `src` | `string` | — | — |
-| `poster?` | `string` | — | — |
-| `chapters?` | `string \| ChapterTrack` | — | Optional WebVTT chapters track. Pass a URL or full track descriptor. |
-| `preload?` | `'none' \| 'metadata' \| 'auto'` | `'metadata'` | — |
-| `load?` | `'eager' \| 'idle' \| 'visible' \| 'custom'` | `'visible'` | — |
-| `muted?` | `boolean` | `false` | — |
-| `autoplay?` | `boolean` | `false` | — |
-| `loop?` | `boolean` | `false` | — |
-| `playsinline?` | `boolean` | `true` | — |
-| `crossorigin?` | `'anonymous' \| 'use-credentials'` | — | — |
-| `initialVolume?` | `number` | — | Initial volume (0–1). |
-| `initialPlaybackRate?` | `number` | — | Initial playback rate (e.g. 1, 1.5, 2). |
-| `aspectRatio?` | `number` | — | Force a fixed aspect ratio as width/height, e.g. 16/9. |
-| `viewType?` | `'unknown' \| 'audio' \| 'video'` | — | — |
-| `streamType?` | `'unknown' \| 'on-demand' \| 'live' \| 'live:dvr' \| 'll-live' \| 'll-live:dvr'` | — | — |
-| `fullscreenOrientation?` | `\| 'any' \| 'natural' \| 'landscape' \| 'portrait' \| 'portrait-primary' \| 'portrait-secondary' \| 'landscape-primary' \| 'landscape-secondary'` | — | — |
-| `controls?` | `boolean` | `false` | Fall back to the provider's native controls instead of the custom chrome. |
-| `play?` | `boolean` | `true` | Show the play / pause button in the custom chrome. |
-| `time?` | `boolean` | `true` | Show the elapsed and duration time badges. |
-| `skip?` | `boolean \| number` | `false` | Show ±N-second skip buttons. `true` defaults to 10s; pass a number to override. |
-| `volume?` | `boolean` | `false` | Show the mute toggle and volume slider. |
-| `volumeOrientation?` | `'horizontal' \| 'vertical'` | `'horizontal'` | Layout direction for the volume slider. |
-| `speed?` | `boolean` | `false` | Show the playback-speed dropdown. |
-| `quality?` | `boolean` | `false` | Show the quality dropdown. Auto-hidden when the source exposes no quality options (e.g. plain MP4). |
-| `pip?` | `boolean` | `false` | Show the picture-in-picture toggle. |
-| `fullscreen?` | `boolean` | `false` | Show the fullscreen toggle. |
-| `seekPreview?` | `boolean` | `false` | Show a hover preview above the seek bar with the cursor's time and (if available) the chapter at that point. |
-| `contextMenu?` | `boolean` | `false` | Enable a right-click context menu mirroring the enabled chrome plus a download shortcut. |
-| `autoHide?` | `boolean` | `true` | Whether the controls bar fades when the user is idle during playback. Set `false` to keep it visible. |
-| `idleDelay?` | `number` | `500` | Delay (ms) of inactivity during playback before vidstack flips `userIdle` to true.
-Maps to the player's `user-idle-delay` attribute. Defaults to 500 ms (vidstack's
-own default is 2000 ms). |
-| `idleWhilePaused?` | `boolean` | `false` | Vidstack only fades the bar while playing (deliberately — its `MediaUserController`
-bails out of idle tracking on `pause`). Set this to `true` to also hide the bar
-while paused after `idleDelay` ms of pointer/keyboard inactivity. |
-| `mobileTimelineOnly?` | `boolean` | `true` | On narrow viewports / coarse-pointer devices, auto-collapse to a "timeline-only"
-layout — every chrome control suppresses regardless of its individual prop, leaving
-just the seek bar. Set `false` to honor the chrome props as-is on mobile too. |
-| `keyDisabled?` | `boolean` | `false` | — |
-| `keyTarget?` | `'document' \| 'player'` | — | — |
-| `keyShortcuts?` | `Record<string, string>` | — | — |
-| `onplay?` | `(e: Event) => void` | — | — |
-| `onpause?` | `(e: Event) => void` | — | — |
-| `onended?` | `(e: Event) => void` | — | — |
-| `onplaying?` | `(e: Event) => void` | — | — |
-| `onseeked?` | `(e: MediaEventWithDetail<number>) => void` | — | — |
-| `onseeking?` | `(e: MediaEventWithDetail<number>) => void` | — | — |
-| `oncanplay?` | `(e: Event) => void` | — | — |
-| `ontimeupdate?` | `(e: MediaEventWithDetail<{ currentTime: number; played: TimeRanges }>) => void` | — | — |
-| `onvolumechange?` | `(e: MediaEventWithDetail<{ volume: number; muted: boolean }>) => void` | — | — |
-| `onratechange?` | `(e: MediaEventWithDetail<number>) => void` | — | — |
-| `ondurationchange?` | `(e: MediaEventWithDetail<number>) => void` | — | — |
-| `onloadedmetadata?` | `(e: Event) => void` | — | — |
-| `onfullscreenchange?` | `(e: MediaEventWithDetail<boolean>) => void` | — | — |
-| `onpipchange?` | `(e: MediaEventWithDetail<boolean>) => void` | — | — |
-| `onerror?` | `(e: Event) => void` | — | — |
-| `children?` | `Snippet` | — | Optional override for the entire controls layer — replaces the default chrome. |
-| `class?` | `string` | — | — |