markdown-flow-ui 0.1.129 → 0.2.0

package/dist/components/Slide/Player.d.ts

@@ -1,4 +1,6 @@
 import { default as React } from 'react';
+import { MarkdownFlowLocale } from '../../lib/locale';
+import { SlidePlayerLocaleTexts } from './slideI18n';
 import { SlideAudioItem } from './useSlide';
 import { SlidePlayerCustomActionContext, SlidePlayerCustomActions } from './types';
 import { MobileViewMode } from './utils/mobileScreenMode';
@@ -6,40 +8,15 @@ import { SubtitleCueJumpTarget } from './utils/subtitleCue';
 /**
  * Labels and accessibility text used by the slide player controls.
  *
- * Missing fields fall back to `DEFAULT_SLIDE_PLAYER_TEXTS`; pass a `texts`
- * object when a consumer needs localized control labels or tooltip text.
+ * Missing fields fall back to the selected `locale`; pass a `texts` object when
+ * a consumer needs custom control labels or tooltip text.
  *
  * @example
  * ```tsx
- * <Player texts={{ playLabel: "播放", nextLabel: "下一页" }} />
+ * <Player locale="zh-CN" texts={{ playLabel: "播放", nextLabel: "下一页" }} />
  * ```
  */
-export interface SlidePlayerTexts {
-    closeSettingsLabel?: string;
-    enterFullscreenLabel?: string;
-    exitFullscreenLabel?: string;
-    moreOptionsAriaLabel?: string;
-    nextLabel?: string;
-    /** Accessible label/title for the next-subtitle jump control. */
-    nextSubtitleLabel?: string;
-    notesLabel?: string;
-    pauseAutoplayLabel?: string;
-    pauseLabel?: string;
-    playAutoplayLabel?: string;
-    playLabel?: string;
-    previousLabel?: string;
-    /** Accessible label/title for the previous-subtitle jump control. */
-    previousSubtitleLabel?: string;
-    screenModeLabel?: string;
-    settingsTitle?: string;
-    subtitleLabel?: string;
-    subtitleToggleAriaLabel?: string;
-    volumeAriaLabel?: string;
-    screenLabel?: string;
-    nonFullscreenLabel?: string;
-    fullscreenLabel?: string;
-    fullscreenHintText?: string;
-}
+export type SlidePlayerTexts = Partial<SlidePlayerLocaleTexts>;
 export type SlidePlayerLoadingReason = "loadingAudio" | "waitingForMoreAudio";
 export interface SlidePlayerNavigationContext {
     shouldContinuePlayback: boolean;
@@ -89,7 +66,12 @@ export type PlayerProps = Omit<React.ComponentProps<"div">, "onEnded"> & {
     isSubtitleEnabled?: boolean;
     prevDisabled?: boolean;
     nextDisabled?: boolean;
+    /** Shows or hides the visual controls without disabling audio, callbacks, or keyboard shortcuts. */
     showControls?: boolean;
+    /** Fired when the pointer enters the controls container to pause auto-hide. */
+    onControlsPointerEnter?: React.PointerEventHandler<HTMLDivElement>;
+    /** Fired when the pointer leaves the controls container to resume auto-hide. */
+    onControlsPointerLeave?: React.PointerEventHandler<HTMLDivElement>;
     /**
      * Enables document-level keyboard shortcuts for existing player actions.
      *
@@ -106,7 +88,9 @@ export type PlayerProps = Omit<React.ComponentProps<"div">, "onEnded"> & {
     subtitleSeekRequest?: SlidePlayerSubtitleSeekRequest | null;
     customActions?: SlidePlayerCustomActions;
     customActionContext?: SlidePlayerCustomActionContext;
+    /** Locale used for built-in control labels when `texts` does not provide them. */
+    locale?: MarkdownFlowLocale;
     texts?: SlidePlayerTexts;
 };
-declare const MemoizedPlayer: React.MemoExoticComponent<({ audioList, className, currentAudioIndex, defaultPlaying, isPlaybackPaused, isAutoAdvanceEnabled, useAutoAdvanceToggle, onLoadingChange, onPlaybackPreferenceChange, onPlaybackStarted, onPlaybackTimeChange, onSubtitleToggle, onPrev, onNext, onSubtitleJump, canJumpToSubtitleTarget, onFullscreen, isFullscreen, mobileViewMode, settingsPortalContainer, onMobileViewModeChange, onEnded, onAutoAdvanceToggle, onInteractionToggle, hasInteraction, isInteractionOpen, isSubtitleEnabled, prevDisabled, nextDisabled, showControls, enableKeyboardShortcuts, subtitleSeekRequest, customActions, customActionContext, texts, onFocusCapture, onPointerDown, ...props }: PlayerProps) => React.JSX.Element>;
+declare const MemoizedPlayer: React.MemoExoticComponent<({ audioList, className, currentAudioIndex, defaultPlaying, isPlaybackPaused, isAutoAdvanceEnabled, useAutoAdvanceToggle, onLoadingChange, onPlaybackPreferenceChange, onPlaybackStarted, onPlaybackTimeChange, onSubtitleToggle, onPrev, onNext, onSubtitleJump, canJumpToSubtitleTarget, onFullscreen, isFullscreen, mobileViewMode, settingsPortalContainer, onMobileViewModeChange, onEnded, onAutoAdvanceToggle, onInteractionToggle, hasInteraction, isInteractionOpen, isSubtitleEnabled, prevDisabled, nextDisabled, showControls, onControlsPointerEnter, onControlsPointerLeave, enableKeyboardShortcuts, subtitleSeekRequest, customActions, customActionContext, locale, texts, onFocusCapture, onPointerDown, ...props }: PlayerProps) => React.JSX.Element>;
 export default MemoizedPlayer;