@videts/vide / ui
ui
Interfaces
| Interface | Description |
|---|---|
| AdUIState | Shared mutable state for ad UI components. Set by uiAdPlugin, read by ad components. |
| AdUIStateRef | Mutable holder for AdUIState, shared between ad-plugin and ad UI components. |
| UIComponent | A single UI component that can be independently mounted and connected. |
| UiPlugin | UI plugin return type, with getAdPlugin() for VAST/VMAP integration. |
| UiPluginOptions | Options for the ui() convenience plugin. |
Type Aliases
| Type Alias | Description |
|---|---|
| UIComponentName | Component names that can be excluded from the ui() convenience plugin. |
Functions
| Function | Description |
|---|---|
| connectStateClasses | Subscribe to statechange and toggle CSS modifier classes on the root element. Returns a cleanup function. |
| createAdCountdown | - |
| createAdLabel | - |
| createAdLearnMore | - |
| createAdOverlay | - |
| createAdSkip | - |
| createAdUIState | Create a shared mutable holder for ad UI state. |
| createAutohide | - |
| createBigPlay | - |
| createClickPlay | - |
| createErrorDisplay | - |
| createFullscreen | - |
| createKeyboard | - |
| createLoader | - |
| createPlayButton | - |
| createPoster | - |
| createProgress | - |
| createTimeDisplay | - |
| createVolume | - |
| formatTime | Format seconds as M:SS or H:MM:SS. Returns "0:00" for NaN/negative. |
| isAdState | Whether the given state is an ad state. |
| stateToClass | Convert a PlayerState to a CSS modifier class on the vide-ui root. |
| ui | Create the UI convenience plugin. Mounts all components (minus excluded). |
| uiAdPlugin | Create an AdPlugin that bridges VAST ad data into the UI's shared ad state. |