UNPKG

@aidenlx/vidstack-react

Version:

UI component library for building high-quality, accessible video and audio experiences on the web.

1,225 lines (1,224 loc) 199 kB
{ "components": [], "elements": [], "react": [ { "type": "react", "file": { "path": "/Users/aidenlx/repo/vidstack-player/packages/react/src/components/announcer.tsx" }, "name": "MediaAnnouncer", "displayName": "MediaAnnouncer", "doctags": [ { "name": "docs", "text": "https://www.vidstack.io/docs/player/components/display/announcer" }, { "name": "example", "text": "```tsx\n<MediaAnnouncer />\n```" } ], "instance": "MediaAnnouncerInstance", "attributes": "HTMLAttributes", "propsType": "MediaAnnouncerProps", "ref": { "type": { "primitive": "object", "concise": "HTMLElement", "full": "HTMLElement" } } }, { "type": "react", "file": { "path": "/Users/aidenlx/repo/vidstack-player/packages/react/src/components/layouts/default/audio-layout.tsx" }, "name": "DefaultAudioLayout", "displayName": "DefaultAudioLayout", "docs": "The audio layout is our production-ready UI that's displayed when the media view type is set to\n'audio'. It includes support for audio tracks, slider chapters, captions, live streams\nand more out of the box.", "doctags": [ { "name": "attr", "text": "data-match - Whether this layout is being used." }, { "name": "attr", "text": "data-sm - The small layout is active" }, { "name": "attr", "text": "data-lg - The large layout is active." }, { "name": "attr", "text": "data-size - The active layout size (sm or lg)." }, { "name": "example", "text": "```tsx\n<MediaPlayer src=\"audio.mp3\">\n <MediaProvider />\n <DefaultAudioLayout icons={defaultLayoutIcons} />\n</MediaPlayer>\n```" } ], "attributes": "RefAttributes", "props": [ { "name": "children", "type": { "primitive": "mixed", "concise": "ReactNode", "full": "string | number | bigint | boolean | ReactElement<unknown, string | JSXElementConstructor<any>> | Iterable<ReactNode> | ReactPortal | Promise<AwaitedReactNode>" } }, { "name": "icons", "type": { "primitive": "object", "concise": "DefaultLayoutIcons", "full": "DefaultLayoutIcons" }, "docs": "The icons to be rendered and displayed inside the layout." }, { "name": "colorScheme", "type": { "primitive": "string", "concise": "'light' | 'dark' | 'system' | 'default'", "full": "'light' | 'dark' | 'system' | 'default'" }, "docs": "Whether light or dark color theme should be active. Defaults to user operating system\npreference.", "doctags": [ { "name": "see", "text": "https://developer.mozilla.org/en-US/docs/Web/CSS/@media/prefers-color-scheme" } ] }, { "name": "download", "type": { "primitive": "mixed", "concise": "FileDownloadInfo", "full": "string | boolean | { url: string; filename: string; }" }, "docs": "Sets the download URL and filename for the download button." }, { "name": "showTooltipDelay", "default": "700", "type": { "primitive": "number", "concise": "number", "full": "number" }, "docs": "Specifies the number of milliseconds to wait before tooltips are visible after interacting\nwith a control." }, { "name": "showMenuDelay", "default": "0", "type": { "primitive": "number", "concise": "number", "full": "number" }, "docs": "Specifies the number of milliseconds to wait before menus are visible after opening them." }, { "name": "hideQualityBitrate", "default": "false", "type": { "primitive": "boolean", "concise": "boolean", "full": "boolean" }, "docs": "Whether the bitrate should be hidden in the settings quality menu next to each option." }, { "name": "smallLayoutWhen", "default": "`({ width, height }) => width < 576 || height < 380`", "type": { "primitive": "boolean", "concise": "boolean | MediaPlayerQuery", "full": "boolean | MediaPlayerQuery" }, "docs": "Determines when the small (e.g., mobile) UI should be displayed." }, { "name": "thumbnails", "type": { "primitive": "string", "concise": "ThumbnailSrc", "full": "string | ThumbnailImageInit[] | ThumbnailStoryboard | MuxThumbnailStoryboard" }, "docs": "The thumbnails resource.", "doctags": [ { "name": "see", "text": "https://www.vidstack.io/docs/wc/player/core-concepts/loading#thumbnails" } ] }, { "name": "translations", "type": { "primitive": "object", "concise": "Partial<DefaultLayoutTranslations>", "full": "{ Announcements?: string; Accessibility?: string; AirPlay?: string; Audio?: string; Auto?: string; Boost?: string; Captions?: string; \"Caption Styles\"?: string; \"Captions look like this\"?: string; Chapters?: string; \"Closed-Captions Off\"?: string; \"Closed-Captions On\"?: string; Connected?: string; Continue?: string; Connecting?: string; Default?: string; Disabled?: string; Disconnected?: string; \"Display Background\"?: string; Download?: string; \"Enter Fullscreen\"?: string; \"Enter PiP\"?: string; \"Exit Fullscreen\"?: string; \"Exit PiP\"?: string; Font?: string; Family?: string; Fullscreen?: string; \"Google Cast\"?: string; \"Keyboard Animations\"?: string; LIVE?: string; Loop?: string; Mute?: string; Normal?: string; Off?: string; Pause?: string; Play?: string; Playback?: string; PiP?: string; Quality?: string; Replay?: string; Reset?: string; \"Seek Backward\"?: string; \"Seek Forward\"?: string; Seek?: string; Settings?: string; \"Skip To Live\"?: string; Speed?: string; Size?: string; Color?: string; Opacity?: string; Shadow?: string; Text?: string; \"Text Background\"?: string; Track?: string; Unmute?: string; Volume?: string; }" }, "docs": "Translation map from english to your desired language for words used throughout the layout." }, { "name": "menuContainer", "default": "`document.body`", "type": { "primitive": "string", "concise": "string | HTMLElement", "full": "string | HTMLElement" }, "docs": "A document query selector string or `HTMLElement` to mount menus inside." }, { "name": "menuGroup", "type": { "primitive": "string", "concise": "'top' | 'bottom'", "full": "'top' | 'bottom'" }, "docs": "Specifies whether menu buttons should be placed in the top or bottom controls group. This\nonly applies to the large video layout." }, { "name": "noAudioGain", "type": { "primitive": "boolean", "concise": "boolean", "full": "boolean" }, "docs": "Disable audio boost slider in the settings menu." }, { "name": "audioGains", "type": { "primitive": "object", "concise": "number[] | { min: number; max: number; step: number; }", "full": "number[] | { min: number; max: number; step: number; }" }, "docs": "The audio gain options to be displayed in the settings menu." }, { "name": "noModal", "type": { "primitive": "boolean", "concise": "boolean", "full": "boolean" }, "docs": "Whether modal menus should be disabled when the small layout is active. A modal menu is\na floating panel that floats up from the bottom of the screen (outside of the player). It's\nenabled by default as it provides a better user experience for touch devices." }, { "name": "noScrubGesture", "type": { "primitive": "boolean", "concise": "boolean", "full": "boolean" }, "docs": "Whether to disable scrubbing by touch swiping left or right on the player canvas." }, { "name": "sliderChaptersMinWidth", "type": { "primitive": "number", "concise": "number", "full": "number" }, "docs": "The minimum width of the slider to start displaying slider chapters when available." }, { "name": "disableTimeSlider", "type": { "primitive": "boolean", "concise": "boolean", "full": "boolean" }, "docs": "Whether the time slider should be disabled." }, { "name": "noGestures", "type": { "primitive": "boolean", "concise": "boolean", "full": "boolean" }, "docs": "Whether all gestures such as press to play or seek should not be active." }, { "name": "noKeyboardAnimations", "type": { "primitive": "boolean", "concise": "boolean", "full": "boolean" }, "docs": "Whether keyboard actions should not be displayed." }, { "name": "playbackRates", "type": { "primitive": "object", "concise": "number[] | { min: number; max: number; step: number; }", "full": "number[] | { min: number; max: number; step: number; }" }, "docs": "The playback rate options to be displayed in the settings menu." }, { "name": "seekStep", "type": { "primitive": "number", "concise": "number", "full": "number" }, "docs": "The number of seconds to seek forward or backward when pressing the seek button or using\nkeyboard shortcuts." }, { "name": "slots", "type": { "primitive": "object", "concise": "DefaultAudioLayoutSlots", "full": "DefaultAudioLayoutSlots" }, "docs": "Provide additional content to be inserted in specific positions." }, { "name": "asChild", "type": { "primitive": "boolean", "concise": "boolean", "full": "boolean" } } ], "propsType": "DefaultAudioLayoutProps" }, { "type": "react", "file": { "path": "/Users/aidenlx/repo/vidstack-player/packages/react/src/components/layouts/default/audio-layout.tsx" }, "name": "AudioLayout", "displayName": "AudioLayout" }, { "type": "react", "file": { "path": "/Users/aidenlx/repo/vidstack-player/packages/react/src/components/layouts/default/audio-layout.tsx" }, "name": "DefaultAudioMenus", "displayName": "DefaultAudioMenus", "props": [ { "name": "slots", "type": { "primitive": "object", "concise": "Slots<DefaultLayoutMenuSlotName>", "full": "{ chaptersMenu?: ReactNode; settingsMenu?: ReactNode; settingsMenuStartItems?: ReactNode; settingsMenuEndItems?: ReactNode; settingsMenuItemsStart?: ReactNode; settingsMenuItemsEnd?: ReactNode; playbackMenuItemsStart?: ReactNode; playbackMenuItemsEnd?: ReactNode; playbackMenuLoop?: ReactNode; accessibilityMenuItemsStart?: ReactNode; accessibilityMenuItemsEnd?: ReactNode; audioMenuItemsStart?: ReactNode; audioMenuItemsEnd?: ReactNode; captionsMenuItemsStart?: ReactNode; captionsMenuItemsEnd?: ReactNode; beforeChaptersMenu?: ReactNode; beforeSettingsMenu?: ReactNode; beforeSettingsMenuStartItems?: ReactNode; beforeSettingsMenuEndItems?: ReactNode; beforeSettingsMenuItemsStart?: ReactNode; beforeSettingsMenuItemsEnd?: ReactNode; beforePlaybackMenuItemsStart?: ReactNode; beforePlaybackMenuItemsEnd?: ReactNode; beforePlaybackMenuLoop?: ReactNode; beforeAccessibilityMenuItemsStart?: ReactNode; beforeAccessibilityMenuItemsEnd?: ReactNode; beforeAudioMenuItemsStart?: ReactNode; beforeAudioMenuItemsEnd?: ReactNode; beforeCaptionsMenuItemsStart?: ReactNode; beforeCaptionsMenuItemsEnd?: ReactNode; afterChaptersMenu?: ReactNode; afterSettingsMenu?: ReactNode; afterSettingsMenuStartItems?: ReactNode; afterSettingsMenuEndItems?: ReactNode; afterSettingsMenuItemsStart?: ReactNode; afterSettingsMenuItemsEnd?: ReactNode; afterPlaybackMenuItemsStart?: ReactNode; afterPlaybackMenuItemsEnd?: ReactNode; afterPlaybackMenuLoop?: ReactNode; afterAccessibilityMenuItemsStart?: ReactNode; afterAccessibilityMenuItemsEnd?: ReactNode; afterAudioMenuItemsStart?: ReactNode; afterAudioMenuItemsEnd?: ReactNode; afterCaptionsMenuItemsStart?: ReactNode; afterCaptionsMenuItemsEnd?: ReactNode; }" } } ], "propsType": "{ slots?: Slots<DefaultLayoutMenuSlotName>; }" }, { "type": "react", "file": { "path": "/Users/aidenlx/repo/vidstack-player/packages/react/src/components/layouts/default/audio-layout.tsx" }, "name": "DefaultAudioTitle", "displayName": "DefaultAudioTitle" }, { "type": "react", "file": { "path": "/Users/aidenlx/repo/vidstack-player/packages/react/src/components/layouts/default/audio-layout.tsx" }, "name": "AudioTitle", "displayName": "AudioTitle", "props": [ { "name": "title", "type": { "primitive": "string", "concise": "string", "full": "string" } }, { "name": "chapterTitle", "type": { "primitive": "string", "concise": "string", "full": "string" } } ], "propsType": "{ title: string; chapterTitle: string; }" }, { "type": "react", "file": { "path": "/Users/aidenlx/repo/vidstack-player/packages/react/src/components/layouts/default/ui/announcer.tsx" }, "name": "DefaultAnnouncer", "displayName": "DefaultAnnouncer" }, { "type": "react", "file": { "path": "/Users/aidenlx/repo/vidstack-player/packages/react/src/components/layouts/default/ui/buttons.tsx" }, "name": "DefaultPlayButton", "displayName": "DefaultPlayButton", "props": [ { "name": "tooltip", "type": { "primitive": "string", "concise": "TooltipPlacement", "full": "TooltipPlacementSide | 'top center' | 'top start' | 'top end' | 'bottom center' | 'bottom start' | 'bottom end' | 'right center' | 'right start' | 'right end' | 'left center' | 'left start' | 'left end'" } } ], "propsType": "DefaultMediaButtonProps" }, { "type": "react", "file": { "path": "/Users/aidenlx/repo/vidstack-player/packages/react/src/components/layouts/default/ui/buttons.tsx" }, "name": "DefaultMuteButton", "displayName": "DefaultMuteButton", "props": [ { "name": "tooltip", "type": { "primitive": "string", "concise": "TooltipPlacement", "full": "TooltipPlacementSide | 'top center' | 'top start' | 'top end' | 'bottom center' | 'bottom start' | 'bottom end' | 'right center' | 'right start' | 'right end' | 'left center' | 'left start' | 'left end'" } } ], "propsType": "DefaultMediaButtonProps", "ref": { "type": { "primitive": "object", "concise": "HTMLButtonElement", "full": "HTMLButtonElement" } } }, { "type": "react", "file": { "path": "/Users/aidenlx/repo/vidstack-player/packages/react/src/components/layouts/default/ui/buttons.tsx" }, "name": "DefaultCaptionButton", "displayName": "DefaultCaptionButton", "props": [ { "name": "tooltip", "type": { "primitive": "string", "concise": "TooltipPlacement", "full": "TooltipPlacementSide | 'top center' | 'top start' | 'top end' | 'bottom center' | 'bottom start' | 'bottom end' | 'right center' | 'right start' | 'right end' | 'left center' | 'left start' | 'left end'" } } ], "propsType": "DefaultMediaButtonProps" }, { "type": "react", "file": { "path": "/Users/aidenlx/repo/vidstack-player/packages/react/src/components/layouts/default/ui/buttons.tsx" }, "name": "DefaultPIPButton", "displayName": "DefaultPIPButton", "props": [ { "name": "tooltip", "type": { "primitive": "string", "concise": "TooltipPlacement", "full": "TooltipPlacementSide | 'top center' | 'top start' | 'top end' | 'bottom center' | 'bottom start' | 'bottom end' | 'right center' | 'right start' | 'right end' | 'left center' | 'left start' | 'left end'" } } ], "propsType": "DefaultMediaButtonProps" }, { "type": "react", "file": { "path": "/Users/aidenlx/repo/vidstack-player/packages/react/src/components/layouts/default/ui/buttons.tsx" }, "name": "DefaultFullscreenButton", "displayName": "DefaultFullscreenButton", "props": [ { "name": "tooltip", "type": { "primitive": "string", "concise": "TooltipPlacement", "full": "TooltipPlacementSide | 'top center' | 'top start' | 'top end' | 'bottom center' | 'bottom start' | 'bottom end' | 'right center' | 'right start' | 'right end' | 'left center' | 'left start' | 'left end'" } } ], "propsType": "DefaultMediaButtonProps" }, { "type": "react", "file": { "path": "/Users/aidenlx/repo/vidstack-player/packages/react/src/components/layouts/default/ui/buttons.tsx" }, "name": "DefaultSeekButton", "displayName": "DefaultSeekButton", "props": [ { "name": "tooltip", "type": { "primitive": "string", "concise": "TooltipPlacement", "full": "TooltipPlacementSide | 'top center' | 'top start' | 'top end' | 'bottom center' | 'bottom start' | 'bottom end' | 'right center' | 'right start' | 'right end' | 'left center' | 'left start' | 'left end'" } }, { "name": "backward", "type": { "primitive": "boolean", "concise": "boolean", "full": "boolean" } } ], "propsType": "DefaultMediaButtonProps & { backward?: boolean; }" }, { "type": "react", "file": { "path": "/Users/aidenlx/repo/vidstack-player/packages/react/src/components/layouts/default/ui/buttons.tsx" }, "name": "DefaultAirPlayButton", "displayName": "DefaultAirPlayButton", "props": [ { "name": "tooltip", "type": { "primitive": "string", "concise": "TooltipPlacement", "full": "TooltipPlacementSide | 'top center' | 'top start' | 'top end' | 'bottom center' | 'bottom start' | 'bottom end' | 'right center' | 'right start' | 'right end' | 'left center' | 'left start' | 'left end'" } } ], "propsType": "DefaultMediaButtonProps" }, { "type": "react", "file": { "path": "/Users/aidenlx/repo/vidstack-player/packages/react/src/components/layouts/default/ui/buttons.tsx" }, "name": "DefaultGoogleCastButton", "displayName": "DefaultGoogleCastButton", "props": [ { "name": "tooltip", "type": { "primitive": "string", "concise": "TooltipPlacement", "full": "TooltipPlacementSide | 'top center' | 'top start' | 'top end' | 'bottom center' | 'bottom start' | 'bottom end' | 'right center' | 'right start' | 'right end' | 'left center' | 'left start' | 'left end'" } } ], "propsType": "DefaultMediaButtonProps" }, { "type": "react", "file": { "path": "/Users/aidenlx/repo/vidstack-player/packages/react/src/components/layouts/default/ui/buttons.tsx" }, "name": "DefaultLiveButton", "displayName": "DefaultLiveButton" }, { "type": "react", "file": { "path": "/Users/aidenlx/repo/vidstack-player/packages/react/src/components/layouts/default/ui/buttons.tsx" }, "name": "DefaultDownloadButton", "displayName": "DefaultDownloadButton" }, { "type": "react", "file": { "path": "/Users/aidenlx/repo/vidstack-player/packages/react/src/components/layouts/default/ui/captions.tsx" }, "name": "DefaultCaptions", "displayName": "DefaultCaptions" }, { "type": "react", "file": { "path": "/Users/aidenlx/repo/vidstack-player/packages/react/src/components/layouts/default/ui/controls.tsx" }, "name": "DefaultControlsSpacer", "displayName": "DefaultControlsSpacer" }, { "type": "react", "file": { "path": "/Users/aidenlx/repo/vidstack-player/packages/react/src/components/layouts/default/ui/keyboard-display.tsx" }, "name": "DefaultKeyboardDisplay", "displayName": "DefaultKeyboardDisplay", "attributes": "RefAttributes", "props": [ { "name": "icons", "type": { "primitive": "object", "concise": "Partial<DefaultKeyboardDisplayIcons>", "full": "{ Play?: DefaultLayoutIcon; Pause?: DefaultLayoutIcon; Mute?: DefaultLayoutIcon; VolumeUp?: DefaultLayoutIcon; VolumeDown?: DefaultLayoutIcon; EnterFullscreen?: DefaultLayoutIcon; ExitFullscreen?: DefaultLayoutIcon; EnterPiP?: DefaultLayoutIcon; ExitPiP?: DefaultLayoutIcon; CaptionsOn?: DefaultLayoutIcon; CaptionsOff?: DefaultLayoutIcon; SeekForward?: DefaultLayoutIcon; SeekBackward?: DefaultLayoutIcon; }" } }, { "name": "asChild", "type": { "primitive": "boolean", "concise": "boolean", "full": "boolean" } } ], "propsType": "DefaultKeyboardDisplayProps", "ref": { "type": { "primitive": "object", "concise": "HTMLElement", "full": "HTMLElement" } } }, { "type": "react", "file": { "path": "/Users/aidenlx/repo/vidstack-player/packages/react/src/components/layouts/default/ui/menus/accessibility-menu.tsx" }, "name": "DefaultAccessibilityMenu", "displayName": "DefaultAccessibilityMenu", "props": [ { "name": "slots", "type": { "primitive": "object", "concise": "Slots<DefaultLayoutMenuSlotName>", "full": "{ chaptersMenu?: ReactNode; settingsMenu?: ReactNode; settingsMenuStartItems?: ReactNode; settingsMenuEndItems?: ReactNode; settingsMenuItemsStart?: ReactNode; settingsMenuItemsEnd?: ReactNode; playbackMenuItemsStart?: ReactNode; playbackMenuItemsEnd?: ReactNode; playbackMenuLoop?: ReactNode; accessibilityMenuItemsStart?: ReactNode; accessibilityMenuItemsEnd?: ReactNode; audioMenuItemsStart?: ReactNode; audioMenuItemsEnd?: ReactNode; captionsMenuItemsStart?: ReactNode; captionsMenuItemsEnd?: ReactNode; beforeChaptersMenu?: ReactNode; beforeSettingsMenu?: ReactNode; beforeSettingsMenuStartItems?: ReactNode; beforeSettingsMenuEndItems?: ReactNode; beforeSettingsMenuItemsStart?: ReactNode; beforeSettingsMenuItemsEnd?: ReactNode; beforePlaybackMenuItemsStart?: ReactNode; beforePlaybackMenuItemsEnd?: ReactNode; beforePlaybackMenuLoop?: ReactNode; beforeAccessibilityMenuItemsStart?: ReactNode; beforeAccessibilityMenuItemsEnd?: ReactNode; beforeAudioMenuItemsStart?: ReactNode; beforeAudioMenuItemsEnd?: ReactNode; beforeCaptionsMenuItemsStart?: ReactNode; beforeCaptionsMenuItemsEnd?: ReactNode; afterChaptersMenu?: ReactNode; afterSettingsMenu?: ReactNode; afterSettingsMenuStartItems?: ReactNode; afterSettingsMenuEndItems?: ReactNode; afterSettingsMenuItemsStart?: ReactNode; afterSettingsMenuItemsEnd?: ReactNode; afterPlaybackMenuItemsStart?: ReactNode; afterPlaybackMenuItemsEnd?: ReactNode; afterPlaybackMenuLoop?: ReactNode; afterAccessibilityMenuItemsStart?: ReactNode; afterAccessibilityMenuItemsEnd?: ReactNode; afterAudioMenuItemsStart?: ReactNode; afterAudioMenuItemsEnd?: ReactNode; afterCaptionsMenuItemsStart?: ReactNode; afterCaptionsMenuItemsEnd?: ReactNode; }" } } ], "propsType": "DefaultAccessibilityMenuProps" }, { "type": "react", "file": { "path": "/Users/aidenlx/repo/vidstack-player/packages/react/src/components/layouts/default/ui/menus/accessibility-menu.tsx" }, "name": "DefaultAnnouncementsMenuCheckbox", "displayName": "DefaultAnnouncementsMenuCheckbox" }, { "type": "react", "file": { "path": "/Users/aidenlx/repo/vidstack-player/packages/react/src/components/layouts/default/ui/menus/accessibility-menu.tsx" }, "name": "DefaultKeyboardAnimationsMenuCheckbox", "displayName": "DefaultKeyboardAnimationsMenuCheckbox" }, { "type": "react", "file": { "path": "/Users/aidenlx/repo/vidstack-player/packages/react/src/components/layouts/default/ui/menus/audio-menu.tsx" }, "name": "DefaultAudioMenu", "displayName": "DefaultAudioMenu", "props": [ { "name": "slots", "type": { "primitive": "object", "concise": "Slots<DefaultLayoutMenuSlotName>", "full": "{ chaptersMenu?: ReactNode; settingsMenu?: ReactNode; settingsMenuStartItems?: ReactNode; settingsMenuEndItems?: ReactNode; settingsMenuItemsStart?: ReactNode; settingsMenuItemsEnd?: ReactNode; playbackMenuItemsStart?: ReactNode; playbackMenuItemsEnd?: ReactNode; playbackMenuLoop?: ReactNode; accessibilityMenuItemsStart?: ReactNode; accessibilityMenuItemsEnd?: ReactNode; audioMenuItemsStart?: ReactNode; audioMenuItemsEnd?: ReactNode; captionsMenuItemsStart?: ReactNode; captionsMenuItemsEnd?: ReactNode; beforeChaptersMenu?: ReactNode; beforeSettingsMenu?: ReactNode; beforeSettingsMenuStartItems?: ReactNode; beforeSettingsMenuEndItems?: ReactNode; beforeSettingsMenuItemsStart?: ReactNode; beforeSettingsMenuItemsEnd?: ReactNode; beforePlaybackMenuItemsStart?: ReactNode; beforePlaybackMenuItemsEnd?: ReactNode; beforePlaybackMenuLoop?: ReactNode; beforeAccessibilityMenuItemsStart?: ReactNode; beforeAccessibilityMenuItemsEnd?: ReactNode; beforeAudioMenuItemsStart?: ReactNode; beforeAudioMenuItemsEnd?: ReactNode; beforeCaptionsMenuItemsStart?: ReactNode; beforeCaptionsMenuItemsEnd?: ReactNode; afterChaptersMenu?: ReactNode; afterSettingsMenu?: ReactNode; afterSettingsMenuStartItems?: ReactNode; afterSettingsMenuEndItems?: ReactNode; afterSettingsMenuItemsStart?: ReactNode; afterSettingsMenuItemsEnd?: ReactNode; afterPlaybackMenuItemsStart?: ReactNode; afterPlaybackMenuItemsEnd?: ReactNode; afterPlaybackMenuLoop?: ReactNode; afterAccessibilityMenuItemsStart?: ReactNode; afterAccessibilityMenuItemsEnd?: ReactNode; afterAudioMenuItemsStart?: ReactNode; afterAudioMenuItemsEnd?: ReactNode; afterCaptionsMenuItemsStart?: ReactNode; afterCaptionsMenuItemsEnd?: ReactNode; }" } } ], "propsType": "DefaultAudioMenuProps" }, { "type": "react", "file": { "path": "/Users/aidenlx/repo/vidstack-player/packages/react/src/components/layouts/default/ui/menus/audio-menu.tsx" }, "name": "DefaultAudioBoostMenuSection", "displayName": "DefaultAudioBoostMenuSection" }, { "type": "react", "file": { "path": "/Users/aidenlx/repo/vidstack-player/packages/react/src/components/layouts/default/ui/menus/audio-menu.tsx" }, "name": "DefaultAudioGainSlider", "displayName": "DefaultAudioGainSlider" }, { "type": "react", "file": { "path": "/Users/aidenlx/repo/vidstack-player/packages/react/src/components/layouts/default/ui/menus/audio-menu.tsx" }, "name": "DefaultAudioTracksMenu", "displayName": "DefaultAudioTracksMenu" }, { "type": "react", "file": { "path": "/Users/aidenlx/repo/vidstack-player/packages/react/src/components/layouts/default/ui/menus/captions-menu.tsx" }, "name": "DefaultCaptionMenu", "displayName": "DefaultCaptionMenu", "props": [ { "name": "slots", "type": { "primitive": "object", "concise": "Slots<DefaultLayoutMenuSlotName>", "full": "{ chaptersMenu?: ReactNode; settingsMenu?: ReactNode; settingsMenuStartItems?: ReactNode; settingsMenuEndItems?: ReactNode; settingsMenuItemsStart?: ReactNode; settingsMenuItemsEnd?: ReactNode; playbackMenuItemsStart?: ReactNode; playbackMenuItemsEnd?: ReactNode; playbackMenuLoop?: ReactNode; accessibilityMenuItemsStart?: ReactNode; accessibilityMenuItemsEnd?: ReactNode; audioMenuItemsStart?: ReactNode; audioMenuItemsEnd?: ReactNode; captionsMenuItemsStart?: ReactNode; captionsMenuItemsEnd?: ReactNode; beforeChaptersMenu?: ReactNode; beforeSettingsMenu?: ReactNode; beforeSettingsMenuStartItems?: ReactNode; beforeSettingsMenuEndItems?: ReactNode; beforeSettingsMenuItemsStart?: ReactNode; beforeSettingsMenuItemsEnd?: ReactNode; beforePlaybackMenuItemsStart?: ReactNode; beforePlaybackMenuItemsEnd?: ReactNode; beforePlaybackMenuLoop?: ReactNode; beforeAccessibilityMenuItemsStart?: ReactNode; beforeAccessibilityMenuItemsEnd?: ReactNode; beforeAudioMenuItemsStart?: ReactNode; beforeAudioMenuItemsEnd?: ReactNode; beforeCaptionsMenuItemsStart?: ReactNode; beforeCaptionsMenuItemsEnd?: ReactNode; afterChaptersMenu?: ReactNode; afterSettingsMenu?: ReactNode; afterSettingsMenuStartItems?: ReactNode; afterSettingsMenuEndItems?: ReactNode; afterSettingsMenuItemsStart?: ReactNode; afterSettingsMenuItemsEnd?: ReactNode; afterPlaybackMenuItemsStart?: ReactNode; afterPlaybackMenuItemsEnd?: ReactNode; afterPlaybackMenuLoop?: ReactNode; afterAccessibilityMenuItemsStart?: ReactNode; afterAccessibilityMenuItemsEnd?: ReactNode; afterAudioMenuItemsStart?: ReactNode; afterAudioMenuItemsEnd?: ReactNode; afterCaptionsMenuItemsStart?: ReactNode; afterCaptionsMenuItemsEnd?: ReactNode; }" } } ], "propsType": "DefaultCaptionMenuProps" }, { "type": "react", "file": { "path": "/Users/aidenlx/repo/vidstack-player/packages/react/src/components/layouts/default/ui/menus/chapters-menu.tsx" }, "name": "DefaultChaptersMenu", "displayName": "DefaultChaptersMenu", "props": [ { "name": "tooltip", "type": { "primitive": "string", "concise": "TooltipPlacement", "full": "TooltipPlacementSide | 'top center' | 'top start' | 'top end' | 'bottom center' | 'bottom start' | 'bottom end' | 'right center' | 'right start' | 'right end' | 'left center' | 'left start' | 'left end'" } }, { "name": "placement", "type": { "primitive": "string", "concise": "MenuPlacement", "full": "'top center' | 'top start' | 'top end' | 'bottom center' | 'bottom start' | 'bottom end' | 'right center' | 'right start' | 'right end' | 'left center' | 'left start' | 'left end' | MenuPlacementSide" } }, { "name": "portalClass", "type": { "primitive": "string", "concise": "string", "full": "string" } }, { "name": "slots", "type": { "primitive": "object", "concise": "Slots<DefaultLayoutMenuSlotName>", "full": "{ chaptersMenu?: ReactNode; settingsMenu?: ReactNode; settingsMenuStartItems?: ReactNode; settingsMenuEndItems?: ReactNode; settingsMenuItemsStart?: ReactNode; settingsMenuItemsEnd?: ReactNode; playbackMenuItemsStart?: ReactNode; playbackMenuItemsEnd?: ReactNode; playbackMenuLoop?: ReactNode; accessibilityMenuItemsStart?: ReactNode; accessibilityMenuItemsEnd?: ReactNode; audioMenuItemsStart?: ReactNode; audioMenuItemsEnd?: ReactNode; captionsMenuItemsStart?: ReactNode; captionsMenuItemsEnd?: ReactNode; beforeChaptersMenu?: ReactNode; beforeSettingsMenu?: ReactNode; beforeSettingsMenuStartItems?: ReactNode; beforeSettingsMenuEndItems?: ReactNode; beforeSettingsMenuItemsStart?: ReactNode; beforeSettingsMenuItemsEnd?: ReactNode; beforePlaybackMenuItemsStart?: ReactNode; beforePlaybackMenuItemsEnd?: ReactNode; beforePlaybackMenuLoop?: ReactNode; beforeAccessibilityMenuItemsStart?: ReactNode; beforeAccessibilityMenuItemsEnd?: ReactNode; beforeAudioMenuItemsStart?: ReactNode; beforeAudioMenuItemsEnd?: ReactNode; beforeCaptionsMenuItemsStart?: ReactNode; beforeCaptionsMenuItemsEnd?: ReactNode; afterChaptersMenu?: ReactNode; afterSettingsMenu?: ReactNode; afterSettingsMenuStartItems?: ReactNode; afterSettingsMenuEndItems?: ReactNode; afterSettingsMenuItemsStart?: ReactNode; afterSettingsMenuItemsEnd?: ReactNode; afterPlaybackMenuItemsStart?: ReactNode; afterPlaybackMenuItemsEnd?: ReactNode; afterPlaybackMenuLoop?: ReactNode; afterAccessibilityMenuItemsStart?: ReactNode; afterAccessibilityMenuItemsEnd?: ReactNode; afterAudioMenuItemsStart?: ReactNode; afterAudioMenuItemsEnd?: ReactNode; afterCaptionsMenuItemsStart?: ReactNode; afterCaptionsMenuItemsEnd?: ReactNode; }" } } ], "propsType": "DefaultMediaMenuProps" }, { "type": "react", "file": { "path": "/Users/aidenlx/repo/vidstack-player/packages/react/src/components/layouts/default/ui/menus/font-menu.tsx" }, "name": "DefaultFontMenu", "displayName": "DefaultFontMenu" }, { "type": "react", "file": { "path": "/Users/aidenlx/repo/vidstack-player/packages/react/src/components/layouts/default/ui/menus/font-menu.tsx" }, "name": "DefaultFontFamilyMenu", "displayName": "DefaultFontFamilyMenu" }, { "type": "react", "file": { "path": "/Users/aidenlx/repo/vidstack-player/packages/react/src/components/layouts/default/ui/menus/font-menu.tsx" }, "name": "DefaultFontSizeSlider", "displayName": "DefaultFontSizeSlider" }, { "type": "react", "file": { "path": "/Users/aidenlx/repo/vidstack-player/packages/react/src/components/layouts/default/ui/menus/font-menu.tsx" }, "name": "DefaultTextColorInput", "displayName": "DefaultTextColorInput" }, { "type": "react", "file": { "path": "/Users/aidenlx/repo/vidstack-player/packages/react/src/components/layouts/default/ui/menus/font-menu.tsx" }, "name": "DefaultTextOpacitySlider", "displayName": "DefaultTextOpacitySlider" }, { "type": "react", "file": { "path": "/Users/aidenlx/repo/vidstack-player/packages/react/src/components/layouts/default/ui/menus/font-menu.tsx" }, "name": "DefaultTextShadowMenu", "displayName": "DefaultTextShadowMenu" }, { "type": "react", "file": { "path": "/Users/aidenlx/repo/vidstack-player/packages/react/src/components/layouts/default/ui/menus/font-menu.tsx" }, "name": "DefaultTextBgInput", "displayName": "DefaultTextBgInput" }, { "type": "react", "file": { "path": "/Users/aidenlx/repo/vidstack-player/packages/react/src/components/layouts/default/ui/menus/font-menu.tsx" }, "name": "DefaultTextBgOpacitySlider", "displayName": "DefaultTextBgOpacitySlider" }, { "type": "react", "file": { "path": "/Users/aidenlx/repo/vidstack-player/packages/react/src/components/layouts/default/ui/menus/font-menu.tsx" }, "name": "DefaultDisplayBgInput", "displayName": "DefaultDisplayBgInput" }, { "type": "react", "file": { "path": "/Users/aidenlx/repo/vidstack-player/packages/react/src/components/layouts/default/ui/menus/font-menu.tsx" }, "name": "DefaultDisplayBgOpacitySlider", "displayName": "DefaultDisplayBgOpacitySlider" }, { "type": "react", "file": { "path": "/Users/aidenlx/repo/vidstack-player/packages/react/src/components/layouts/default/ui/menus/font-menu.tsx" }, "name": "DefaultFontSetting", "displayName": "DefaultFontSetting", "propsType": "DefaultFontSettingProps" }, { "type": "react", "file": { "path": "/Users/aidenlx/repo/vidstack-player/packages/react/src/components/layouts/default/ui/menus/font-menu.tsx" }, "name": "DefaultFontRadioGroup", "displayName": "DefaultFontRadioGroup", "props": [ { "name": "id", "type": { "primitive": "string", "concise": "string", "full": "string" } }, { "name": "label", "type": { "primitive": "string", "concise": "string", "full": "string" } }, { "name": "value", "type": { "primitive": "string", "concise": "string", "full": "string" } }, { "name": "values", "type": { "primitive": "any", "concise": "FontRadioOption", "full": "FontRadioOption" } } ], "propsType": "DefaultFontRadioGroupProps", "callbacks": [ { "name": "onChange", "type": { "primitive": "function", "concise": "(value: string) => void", "full": "(value: string) => void" }, "parameters": [ { "name": "value", "type": { "primitive": "string", "concise": "string", "full": "string" } } ] } ] }, { "type": "react", "file": { "path": "/Users/aidenlx/repo/vidstack-player/packages/react/src/components/layouts/default/ui/menus/font-menu.tsx" }, "name": "DefaultResetMenuItem", "displayName": "DefaultResetMenuItem" }, { "type": "react", "file": { "path": "/Users/aidenlx/repo/vidstack-player/packages/react/src/components/layouts/default/ui/menus/items/menu-checkbox.tsx" }, "name": "DefaultMenuCheckbox", "displayName": "DefaultMenuCheckbox", "props": [ { "name": "label", "type": { "primitive": "string", "concise": "string", "full": "string" } }, { "name": "checked", "type": { "primitive": "boolean", "concise": "boolean", "full": "boolean" } }, { "name": "storageKey", "type": { "primitive": "string", "concise": "string", "full": "string" } }, { "name": "defaultChecked", "type": { "primitive": "boolean", "concise": "boolean", "full": "boolean" } } ], "propsType": "DefaultMenuCheckboxProps", "callbacks": [ { "name": "onChange", "type": { "primitive": "function", "concise": "(checked: boolean, trigger?: Event) => void", "full": "(checked: boolean, trigger?: Event) => void" }, "parameters": [ { "name": "checked", "type": { "primitive": "boolean", "concise": "boolean", "full": "boolean" } }, { "name": "trigger", "type": { "primitive": "object", "concise": "Event", "full": "Event" } } ] } ] }, { "type": "react", "file": { "path": "/Users/aidenlx/repo/vidstack-player/packages/react/src/components/layouts/default/ui/menus/items/menu-items.tsx" }, "name": "DefaultMenuSection", "displayName": "DefaultMenuSection", "props": [ { "name": "label", "type": { "primitive": "string", "concise": "string", "full": "string" } }, { "name": "value", "type": { "primitive": "string", "concise": "string", "full": "string" } }, { "name": "children", "type": { "primitive": "mixed", "concise": "ReactNode", "full": "string | number | bigint | boolean | ReactElement<unknown, string | JSXElementConstructor<any>> | Iterable<ReactNode> | ReactPortal | Promise<AwaitedReactNode>" } } ], "propsType": "DefaultMenuSectionProps" }, { "type": "react", "file": { "path": "/Users/aidenlx/repo/vidstack-player/packages/react/src/components/layouts/default/ui/menus/items/menu-items.tsx" }, "name": "DefaultMenuButton", "displayName": "DefaultMenuButton", "props": [ { "name": "label", "type": { "primitive": "string", "concise": "string", "full": "string" } }, { "name": "hint", "type": { "primitive": "string", "concise": "string", "full": "string" } }, { "name": "disabled", "type": { "primitive": "boolean", "concise": "boolean", "full": "boolean" } }, { "name": "Icon", "type": { "primitive": "function", "concise": "DefaultLayoutIcon", "full": "DefaultLayoutIcon" } } ], "propsType": "DefaultMenuButtonProps" }, { "type": "react", "file": { "path": "/Users/aidenlx/repo/vidstack-player/packages/react/src/components/layouts/default/ui/menus/items/menu-items.tsx" }, "name": "DefaultMenuItem", "displayName": "DefaultMenuItem", "props": [ { "name": "label", "type": { "primitive": "string", "concise": "string", "full": "string" } }, { "name": "children", "type": { "primitive": "mixed", "concise": "ReactNode", "full": "string | number | bigint | boolean | ReactElement<unknown, string | JSXElementConstructor<any>> | Iterable<ReactNode> | ReactPortal | Promise<AwaitedReactNode>" } } ], "propsType": "DefaultMenuItemProps" }, { "type": "react", "file": { "path": "/Users/aidenlx/repo/vidstack-player/packages/react/src/components/layouts/default/ui/menus/items/menu-items.tsx" }, "name": "DefaultMenuRadioGroup", "displayName": "DefaultMenuRadioGroup", "props": [ { "name": "value", "type": { "primitive": "string", "concise": "string", "full": "string" } }, { "name": "options", "type": { "primitive": "object", "concise": "{ label: string; value: string; }[]", "full": "{ label: string; value: string; }[]" } } ], "propsType": "DefaultMenuRadioGroupProps", "callbacks": [ { "name": "onChange", "type": { "primitive": "function", "concise": "(newValue: string) => void", "full": "(newValue: string) => void" }, "parameters": [ { "name": "newValue", "type": { "primitive": "string", "concise": "string", "full": "string" } } ] } ] }, { "type": "react", "file": { "path": "/Users/aidenlx/repo/vidstack-player/packages/react/src/components/layouts/default/ui/menus/items/menu-slider.tsx" }, "name": "DefaultMenuSliderItem", "displayName": "DefaultMenuSliderItem", "props": [ { "name": "label", "type": { "primitive": "string", "concise": "string", "full": "string" } }, { "name": "value", "type": { "primitive": "string", "concise": "string", "full": "string" } }, { "name": "UpIcon", "type": { "primitive": "function", "concise": "DefaultLayoutIcon", "full": "DefaultLayoutIcon" } }, { "name": "DownIcon", "type": { "primitive": "function", "concise": "DefaultLayoutIcon", "full": "DefaultLayoutIcon" } }, { "name": "children", "type": { "primitive": "mixed", "concise": "ReactNode", "full": "string | number | bigint | boolean | ReactElement<unknown, string | JSXElementConstructor<any>> | Iterable<ReactNode> | ReactPortal | Promise<AwaitedReactNode>" } }, { "name": "isMin", "type": { "primitive": "boolean", "concise": "boolean", "full": "boolean" } }, { "name": "isMax", "type": { "primitive": "boolean", "concise": "boolean", "full": "boolean" } } ], "propsType": "DefaultMenuSliderItemProps" }, { "type": "react", "file": { "path": "/Users/aidenlx/repo/vidstack-player/packages/react/src/components/layouts/default/ui/menus/items/menu-slider.tsx" }, "name": "DefaultSliderParts", "displayName": "DefaultSliderParts" }, { "type": "react", "file": { "path": "/Users/aidenlx/repo/vidstack-player/packages/react/src/components/layouts/default/ui/menus/items/menu-slider.tsx" }, "name": "DefaultSliderSteps", "displayName": "DefaultSliderSteps" }, { "type": "react", "file": { "path": "/Users/aidenlx/repo/vidstack-player/packages/react/src/components/layouts/default/ui/menus/playback-menu.tsx" }, "name": "DefaultPlaybackMenu", "displayName": "DefaultPlaybackMenu", "props": [ { "name": "slots", "type": { "primitive": "object", "concise": "Slots<DefaultLayoutMenuSlotName>", "full": "{ chaptersMenu?: ReactNode; settingsMenu?: ReactNode; settingsMenuStartItems?: ReactNode; settingsMenuEndItems?: ReactNode; settingsMenuItemsStart?: ReactNode; settingsMenuItemsEnd?: ReactNode; playbackMenuItemsStart?: ReactNode; playbackMenuItemsEnd?: ReactNode; playbackMenuLoop?: ReactNode; accessibilityMenuItemsStart?: ReactNode; accessibilityMenuItemsEnd?: ReactNode; audioMenuItemsStart?: ReactNode; audioMenuItemsEnd?: ReactNode; captionsMenuItemsStart?: ReactNode; captionsMenuItemsEnd?: ReactNode; beforeChaptersMenu?: ReactNode; beforeSettingsMenu?: ReactNode; beforeSettingsMenuStartItems?: ReactNode; beforeSettingsMenuEndItems?: ReactNode; beforeSettingsMenuItemsStart?: ReactNode; beforeSettingsMenuItemsEnd?: ReactNode; beforePlaybackMenuItemsStart?: ReactNode; beforePlaybackMenuItemsEnd?: ReactNode; beforePlaybackMenuLoop?: ReactNode; beforeAccessibilityMenuItemsStart?: ReactNode; beforeAccessibilityMenuItemsEnd?: ReactNode; beforeAudioMenuItemsStart?: ReactNode; beforeAudioMenuItemsEnd?: ReactNode; beforeCaptionsMenuItemsStart?: ReactNode; beforeCaptionsMenuItemsEnd?: ReactNode; afterChaptersMenu?: ReactNode; afterSettingsMenu?: ReactNode; afterSettingsMenuStartItems?: ReactNode; afterSettingsMenuEndItems?: ReactNode; afterSettingsMenuItemsStart?: ReactNode; afterSettingsMenuItemsEnd?: ReactNode; afterPlaybackMenuItemsStart?: ReactNode; afterPlaybackMenuItemsEnd?: ReactNode; afterPlaybackMenuLoop?: ReactNode; afterAccessibilityMenuItemsStart?: ReactNode; afterAccessibilityMenuItemsEnd?: ReactNode; afterAudioMenuItemsStart?: ReactNode; afterAudioMenuItemsEnd?: ReactNode; afterCaptionsMenuItemsStart?: ReactNode; afterCaptionsMenuItemsEnd?: ReactNode; }" } }