@retoo/scena 0.0.2 → 0.1.0

package/README.md

@@ -4,7 +4,7 @@
 [![bundle size](https://img.shields.io/badge/gzipped-~30KB-blue)](https://use-retoo.github.io/scena/distribution/bundle-size)
 [![license](https://img.shields.io/badge/license-PolyForm%20Shield%201.0.0-blue)](./LICENSE.md)
 
-Embeddable video widget for any website. Framework-agnostic, SSR-safe, ~26KB gzipped.
+Embeddable video widget for any website. Framework-agnostic, SSR-safe, ~30KB gzipped.
 
 **[Documentation](https://use-retoo.github.io/scena)**
 

package/dist/index.d.ts

@@ -294,6 +294,10 @@ interface ScenaCloseButtonComponentStyles {
     button: ComponentStyles;
     cross: ComponentStyles;
 }
+/** Custom HTML override for the close button. */
+interface ScenaCloseButtonComponentHtml {
+    button: string;
+}
 /** Configuration props for the close button widget. */
 interface ScenaCloseButtonProps {
     id: string;
@@ -302,6 +306,7 @@ interface ScenaCloseButtonProps {
     aria: Partial<ComponentAriaProps>;
     customClasses: Partial<ScenaCloseButtonComponentClasses>;
     customStyles: Partial<ScenaCloseButtonComponentStyles>;
+    customHtml: Partial<ScenaCloseButtonComponentHtml>;
     onClick: (event: Event) => void;
 }
 /** DOM elements exposed by the close button component. */
@@ -330,6 +335,10 @@ interface ScenaCtaButtonComponentStyles {
     root: ComponentStyles;
     button: ComponentStyles;
 }
+/** Custom HTML override for the CTA button. */
+interface ScenaCtaButtonComponentHtml {
+    button: string;
+}
 /** Adaptive display settings for the CTA button across screen sizes. */
 interface ScenaCtaButtonAdaptive {
     sizes: ComponentSize[];
@@ -345,6 +354,7 @@ interface ScenaCtaButtonProps {
     aria: Partial<ComponentAriaProps>;
     customClasses: Partial<ScenaCtaButtonComponentClasses>;
     customStyles: Partial<ScenaCtaButtonComponentStyles>;
+    customHtml: Partial<ScenaCtaButtonComponentHtml>;
     onClick: (event: Event) => void;
 }
 /** DOM elements exposed by the CTA button component. */
@@ -499,7 +509,7 @@ interface ScenaVideoSnippets {
 /** Options for creating the video controller. */
 interface UseVideoControllerOptions {
     /** Getter that returns the underlying `<video>` DOM element. */
-    getVideoElement: () => HTMLVideoElement;
+    getVideoElement: () => HTMLVideoElement | null;
     /** Event emitter to broadcast video lifecycle events. */
     eventEmitter: ScenaEventEmitter;
 }
@@ -508,7 +518,7 @@ type UseVideoControllerReturns = ScenaVideoData & ScenaVideoMethods & ScenaVideo
 /** DOM elements exposed by the video widget. */
 interface ScenaVideoElements {
     root: HTMLDivElement | null;
-    video: HTMLVideoElement;
+    video: HTMLVideoElement | null;
 }
 /** Component ref for the video widget. */
 interface ScenaVideoRef {
@@ -564,6 +574,11 @@ interface ScenaVideoControlsComponentStyles {
     play: ComponentStyles;
     pause: ComponentStyles;
 }
+/** Custom HTML overrides for the video play/pause controls. */
+interface ScenaVideoControlsComponentHtml {
+    play: string;
+    pause: string;
+}
 /** Per-button ARIA overrides for video controls. */
 interface ScenaVideoControlsComponentAria {
     play: Partial<ComponentAriaProps>;
@@ -576,6 +591,7 @@ interface ScenaVideoControlsProps {
     aria: Partial<ScenaVideoControlsComponentAria>;
     customClasses: Partial<ScenaVideoControlsComponentClasses>;
     customStyles: Partial<ScenaVideoControlsComponentStyles>;
+    customHtml: Partial<ScenaVideoControlsComponentHtml>;
 }
 /** DOM elements exposed by the video controls component. */
 interface ScenaVideoControlsElements {
@@ -620,12 +636,17 @@ interface ScenaVideoLoaderComponentStyles {
     root: ComponentStyles;
     loader: ComponentStyles;
 }
+/** Custom HTML override for the video loader. */
+interface ScenaVideoLoaderComponentHtml {
+    loader: string;
+}
 /** Configuration props for the video buffering/loading indicator. */
 interface ScenaVideoLoaderProps {
     id: string;
     size: ComponentSize;
     customClasses: Partial<ScenaVideoLoaderComponentClasses>;
     customStyles: Partial<ScenaVideoLoaderComponentStyles>;
+    customHtml: Partial<ScenaVideoLoaderComponentHtml>;
 }
 /** DOM elements exposed by the video loader component. */
 interface ScenaVideoLoaderElements {
@@ -737,8 +758,8 @@ interface UseProgressLineReturn {
 /** Props accepted by the line progress hook. */
 interface UseProgressLineProps {
     getRootElement: () => HTMLElement;
-    getSize: () => ComponentSize;
     getCustomThickness: () => ScenaProgressComponentThickness;
+    getSize: () => ComponentSize;
     getProgress: () => number;
 }
 /** Seek event callbacks used internally by the line progress hook. */
@@ -749,9 +770,9 @@ interface UseProgressLineEvents {
 }
 /** Props accepted by the circle progress hook. */
 interface UseProgressCircleProps {
-    getRootElement: () => SVGSVGElement;
-    getSize: () => ComponentSize;
+    getRootElement: () => SVGSVGElement | null;
     getCustomThickness: () => ScenaProgressComponentThickness;
+    getSize: () => ComponentSize;
     getProgress: () => number;
     getBuffer: () => number;
 }
@@ -859,6 +880,11 @@ interface ScenaVideoVolumeComponentStyles {
     mute: ComponentStyles;
     unmute: ComponentStyles;
 }
+/** Custom HTML overrides for the volume mute/unmute controls. */
+interface ScenaVideoVolumeComponentHtml {
+    mute: string;
+    unmute: string;
+}
 /** Per-button ARIA overrides for volume controls. */
 interface ScenaVideoVolumeComponentAria {
     mute: Partial<ComponentAriaProps>;
@@ -872,6 +898,7 @@ interface ScenaVideoVolumeProps {
     aria: Partial<ScenaVideoVolumeComponentAria>;
     customClasses: Partial<ScenaVideoVolumeComponentClasses>;
     customStyles: Partial<ScenaVideoVolumeComponentStyles>;
+    customHtml: Partial<ScenaVideoVolumeComponentHtml>;
 }
 /** DOM elements exposed by the volume control component. */
 interface ScenaVideoVolumeElements {
@@ -1253,4 +1280,4 @@ declare const getScenaContext: () => ScenaContext;
 declare const setScenaContext: (context: ScenaContext) => ScenaContext;
 
 export { ComponentAriaHaspopup, ComponentAriaPressed, ComponentPlacement, ComponentPosition, ComponentShape, ComponentSize, OverrideLayer, ScenaButtonAriaHaspopup, ScenaButtonAriaPressed, ScenaButtonShape, ScenaButtonType, ScenaButtonVariant, ScenaCtaButtonPlacement, ScenaElement, ScenaEvent, ScenaVideoCrossOrigin, ScenaVideoPreload, ScenaVideoProgressVariant, ScenaVideoState, defineScenaElement, getScenaContext, getScenaElement, getScenaVideoContext, scenaProgressCircleThicknessMap, scenaProgressLineThicknessMap, setScenaContext, setScenaVideoContext, useEventEmitter, useProgressCircle, useProgressLine, useScena, useScenaConfig, useScenaOverrides, useScenaPreview, useScenaResponsive, useScenaVisibility, useVideoController };
-export type { ComponentAriaProps, ComponentClasses, ComponentRef, ComponentSnippet, ComponentSnippetReturn, ComponentStyles, ScenaApi, ScenaButtonComponentClasses, ScenaButtonComponentStyles, ScenaButtonElements, ScenaButtonEvents, ScenaButtonProps, ScenaButtonSnippets, ScenaCloseButtonComponentClasses, ScenaCloseButtonComponentStyles, ScenaCloseButtonElements, ScenaCloseButtonProps, ScenaCloseButtonRef, ScenaComponents, ScenaConfig, ScenaConfigFeatures, ScenaConfigOverrides, ScenaContainerCustomClasses, ScenaContainerCustomStyles, ScenaContainerElements, ScenaContainerProps, ScenaContainerRef, ScenaContainerSnippets, ScenaContext, ScenaCtaButtonAdaptive, ScenaCtaButtonComponentClasses, ScenaCtaButtonComponentStyles, ScenaCtaButtonElements, ScenaCtaButtonProps, ScenaCtaButtonRef, ScenaElementTag, ScenaEventEmitter, ScenaEventHandler, ScenaEventMap, ScenaFeatures, ScenaIconCustomClasses, ScenaIconCustomStyles, ScenaIconElements, ScenaIconProps, ScenaIconSnippets, ScenaInstance, ScenaLoaderCustomClasses, ScenaLoaderCustomStyles, ScenaLoaderElements, ScenaLoaderProps, ScenaOverrides, ScenaPreviewApi, ScenaPreviewConfig, ScenaProgressCircleComponentClasses, ScenaProgressCircleComponentStyles, ScenaProgressCircleElements, ScenaProgressCircleEvents, ScenaProgressCircleProps, ScenaProgressComponentThickness, ScenaProgressLineComponentClasses, ScenaProgressLineComponentStyles, ScenaProgressLineElements, ScenaProgressLineEvents, ScenaProgressLineProps, ScenaProgressThickness, ScenaProps, ScenaRef, ScenaResponsiveApi, ScenaResponsiveConfig, ScenaTarget, ScenaVideoCallbacks, ScenaVideoComponentClasses, ScenaVideoComponentStyles, ScenaVideoContainerCustomClasses, ScenaVideoContainerCustomStyles, ScenaVideoContainerElements, ScenaVideoContainerProps, ScenaVideoContainerRef, ScenaVideoContainerSnippets, ScenaVideoContext, ScenaVideoControlsComponentAria, ScenaVideoControlsComponentClasses, ScenaVideoControlsComponentStyles, ScenaVideoControlsElements, ScenaVideoControlsProps, ScenaVideoControlsRef, ScenaVideoData, ScenaVideoElements, ScenaVideoEventOptions, ScenaVideoEventOptionsWithError, ScenaVideoEventOptionsWithEvent, ScenaVideoLoaderComponentClasses, ScenaVideoLoaderComponentStyles, ScenaVideoLoaderElements, ScenaVideoLoaderProps, ScenaVideoLoaderRef, ScenaVideoMethods, ScenaVideoProgressComponentClasses, ScenaVideoProgressComponentStyles, ScenaVideoProgressComponentThickness, ScenaVideoProgressElements, ScenaVideoProgressProps, ScenaVideoProgressRef, ScenaVideoProgressThickness, ScenaVideoProgressThicknessMap, ScenaVideoProps, ScenaVideoRef, ScenaVideoSnippets, ScenaVideoVolumeComponentAria, ScenaVideoVolumeComponentClasses, ScenaVideoVolumeComponentStyles, ScenaVideoVolumeElements, ScenaVideoVolumeProps, ScenaVideoVolumeRef, ScenaVisibilityApi, ScenaVisibilityConfig, UseProgressCircleEvents, UseProgressCircleProps, UseProgressCircleReturn, UseProgressCircleReturnEvents, UseProgressLineEvents, UseProgressLineProps, UseProgressLineReturn, UseProgressLineReturnEvents, UseScenaConfigReturns, UseScenaOverridesReturns, UseScenaPreviewOptions, UseScenaPreviewReturns, UseScenaResponsiveReturns, UseScenaReturns, UseScenaVisibilityReturns, UseVideoControllerOptions, UseVideoControllerReturns };
+export type { ComponentAriaProps, ComponentClasses, ComponentRef, ComponentSnippet, ComponentSnippetReturn, ComponentStyles, ScenaApi, ScenaButtonComponentClasses, ScenaButtonComponentStyles, ScenaButtonElements, ScenaButtonEvents, ScenaButtonProps, ScenaButtonSnippets, ScenaCloseButtonComponentClasses, ScenaCloseButtonComponentHtml, ScenaCloseButtonComponentStyles, ScenaCloseButtonElements, ScenaCloseButtonProps, ScenaCloseButtonRef, ScenaComponents, ScenaConfig, ScenaConfigFeatures, ScenaConfigOverrides, ScenaContainerCustomClasses, ScenaContainerCustomStyles, ScenaContainerElements, ScenaContainerProps, ScenaContainerRef, ScenaContainerSnippets, ScenaContext, ScenaCtaButtonAdaptive, ScenaCtaButtonComponentClasses, ScenaCtaButtonComponentHtml, ScenaCtaButtonComponentStyles, ScenaCtaButtonElements, ScenaCtaButtonProps, ScenaCtaButtonRef, ScenaElementTag, ScenaEventEmitter, ScenaEventHandler, ScenaEventMap, ScenaFeatures, ScenaIconCustomClasses, ScenaIconCustomStyles, ScenaIconElements, ScenaIconProps, ScenaIconSnippets, ScenaInstance, ScenaLoaderCustomClasses, ScenaLoaderCustomStyles, ScenaLoaderElements, ScenaLoaderProps, ScenaOverrides, ScenaPreviewApi, ScenaPreviewConfig, ScenaProgressCircleComponentClasses, ScenaProgressCircleComponentStyles, ScenaProgressCircleElements, ScenaProgressCircleEvents, ScenaProgressCircleProps, ScenaProgressComponentThickness, ScenaProgressLineComponentClasses, ScenaProgressLineComponentStyles, ScenaProgressLineElements, ScenaProgressLineEvents, ScenaProgressLineProps, ScenaProgressThickness, ScenaProps, ScenaRef, ScenaResponsiveApi, ScenaResponsiveConfig, ScenaTarget, ScenaVideoCallbacks, ScenaVideoComponentClasses, ScenaVideoComponentStyles, ScenaVideoContainerCustomClasses, ScenaVideoContainerCustomStyles, ScenaVideoContainerElements, ScenaVideoContainerProps, ScenaVideoContainerRef, ScenaVideoContainerSnippets, ScenaVideoContext, ScenaVideoControlsComponentAria, ScenaVideoControlsComponentClasses, ScenaVideoControlsComponentHtml, ScenaVideoControlsComponentStyles, ScenaVideoControlsElements, ScenaVideoControlsProps, ScenaVideoControlsRef, ScenaVideoData, ScenaVideoElements, ScenaVideoEventOptions, ScenaVideoEventOptionsWithError, ScenaVideoEventOptionsWithEvent, ScenaVideoLoaderComponentClasses, ScenaVideoLoaderComponentHtml, ScenaVideoLoaderComponentStyles, ScenaVideoLoaderElements, ScenaVideoLoaderProps, ScenaVideoLoaderRef, ScenaVideoMethods, ScenaVideoProgressComponentClasses, ScenaVideoProgressComponentStyles, ScenaVideoProgressComponentThickness, ScenaVideoProgressElements, ScenaVideoProgressProps, ScenaVideoProgressRef, ScenaVideoProgressThickness, ScenaVideoProgressThicknessMap, ScenaVideoProps, ScenaVideoRef, ScenaVideoSnippets, ScenaVideoVolumeComponentAria, ScenaVideoVolumeComponentClasses, ScenaVideoVolumeComponentHtml, ScenaVideoVolumeComponentStyles, ScenaVideoVolumeElements, ScenaVideoVolumeProps, ScenaVideoVolumeRef, ScenaVisibilityApi, ScenaVisibilityConfig, UseProgressCircleEvents, UseProgressCircleProps, UseProgressCircleReturn, UseProgressCircleReturnEvents, UseProgressLineEvents, UseProgressLineProps, UseProgressLineReturn, UseProgressLineReturnEvents, UseScenaConfigReturns, UseScenaOverridesReturns, UseScenaPreviewOptions, UseScenaPreviewReturns, UseScenaResponsiveReturns, UseScenaReturns, UseScenaVisibilityReturns, UseVideoControllerOptions, UseVideoControllerReturns };