itube-modern-player 0.2.3 → 0.3.1

package/dist/types.d.ts

@@ -103,6 +103,11 @@ export interface VideoSource {
      * "most replayed"). Sparse — only the moments you have data for.
      */
     heatmap?: HeatmapPoint[];
+    /**
+     * Short info lines shown in the "next video" hover preview (and reusable in
+     * other previews), e.g. `["2.3K views", "User uploaded"]`. Free text.
+     */
+    previewMeta?: string[];
     /** Free-form user data, carried around untouched. */
     meta?: Record<string, unknown>;
 }
@@ -164,12 +169,18 @@ export interface AdsOptions {
      */
     playOn?: 'every' | 'first';
 }
-/** A consumer-defined entry in the ⋯ actions dropdown. */
+/** A consumer-defined entry in the actions UI. */
 export interface CustomAction {
     id: string;
     title: string;
-    /** Icon: image URL or raw `<svg>` markup. Optional. */
+    /** Icon: image URL or raw `<svg>` markup. Required when `placement: "bar"`. */
     icon?: string;
+    /**
+     * Where the action lives:
+     * - `"menu"` (default): an item in the ⋯ dropdown;
+     * - `"bar"`: a dedicated icon button in the control bar (tooltip = `title`).
+     */
+    placement?: 'menu' | 'bar';
 }
 export type BuiltinActionId = 'like' | 'dislike' | 'addTo' | 'share' | 'report';
 /**
@@ -196,6 +207,24 @@ export interface ActionsOptions {
     /** Extra dropdown entries. Click emits `customaction` with the entry id. */
     custom?: CustomAction[];
 }
+/**
+ * Where a settings-type control lives:
+ * - `"gear"` (default): a section inside the unified ⚙ settings dropdown;
+ * - `"bar"`: its own dedicated button in the control bar;
+ * - `false`: off. `true` is an alias for `"gear"`.
+ */
+export type SettingPlacement = boolean | 'gear' | 'bar';
+/** What the "next video" hover preview shows. `true`/`false` toggle all of it. */
+export interface NextPreviewOptions {
+    /** Thumbnail (next source's `poster`). Default true. */
+    thumbnail?: boolean;
+    /** Title (next source's `title`). Default true. */
+    title?: boolean;
+    /** Duration badge (next source's `duration`). Default true. */
+    duration?: boolean;
+    /** Extra info lines from the next source's `previewMeta`. Default true. */
+    meta?: boolean;
+}
 export interface ControlsOptions {
     play?: boolean;
     progress?: boolean;
@@ -203,22 +232,43 @@ export interface ControlsOptions {
     volume?: boolean;
     fullscreen?: boolean;
     pip?: boolean;
-    /** Playback-speed menu (speedometer icon). */
-    settings?: boolean;
-    /** Quality menu (gear icon). OFF by default; needs `source.qualities` or an HLS source. */
-    quality?: boolean;
+    /** Playback speed. Default `"gear"` (inside the settings dropdown). */
+    speed?: SettingPlacement;
+    /** @deprecated alias for `speed`. */
+    settings?: SettingPlacement;
+    /** Quality. Default `"gear"`; needs `source.qualities` or an HLS source to appear. */
+    quality?: SettingPlacement;
     /** Scene list button — appears when the source has chapters. Default true. */
     scenes?: boolean;
     /** Popularity heatmap above the progress bar (needs `source.heatmap` data). Default true. */
     heatmap?: boolean;
-    subtitles?: boolean;
+    /** Subtitles. Default `"gear"` (inside the settings dropdown). */
+    subtitles?: SettingPlacement;
     /** Skip-back / skip-forward buttons. Pass an object to change the step (seconds). */
     seekButtons?: boolean | {
         back?: number;
         forward?: number;
     };
+    /**
+     * Where the prev/seek/play/next cluster lives:
+     * - `"overlay"` (default): big buttons centered over the video, on every viewport;
+     * - `"bar"`: seek buttons in the bottom control bar (the cluster still appears
+     *   over the video on mobile). This is the pre-0.3 desktop behaviour.
+     */
+    seekPlacement?: 'overlay' | 'bar';
     /** Previous / next / list buttons (only rendered when a playlist is present). */
     playlist?: boolean;
+    /**
+     * Hide the "previous" button in the control bar (the bar keeps only "next").
+     * Default true. The mobile center cluster still shows prev. Set false to bring
+     * the bar prev button back.
+     */
+    hidePrev?: boolean;
+    /**
+     * Hover preview of the next playlist item over the "next" button (desktop).
+     * Default true when a playlist is present. Pass an object to pick fields.
+     */
+    nextPreview?: boolean | NextPreviewOptions;
     /** ms of pointer inactivity before controls fade out during playback. Default 2500. */
     hideDelay?: number;
 }
@@ -235,6 +285,15 @@ export interface PlaylistOptions {
     /** Panel placement: `"sidebar"` (right, default) or `"bottom"` (horizontal strip). */
     layout?: 'sidebar' | 'bottom';
 }
+/** Which parts of the default pause-screen overlay to render (all default true). */
+export interface PauseScreenContent {
+    /** Video title. */
+    title?: boolean;
+    /** Video description. */
+    description?: boolean;
+    /** Sponsor / promo link. */
+    sponsor?: boolean;
+}
 /** Scene (chapter) list panel — timecodes with sprite previews. */
 export interface ScenesOptions {
     /** Panel placement. Default `"bottom"`. */
@@ -270,6 +329,8 @@ export interface PlayerLabels {
     more: string;
     seekForward: string;
     seekBack: string;
+    /** Short unit appended to the seek-step caption, e.g. the "s" in "+15s". */
+    secondsShort: string;
     live: string;
     related: string;
     adLabel: string;
@@ -297,10 +358,13 @@ export interface PlayerOptions {
     keyboard?: boolean;
     controls?: ControlsOptions;
     /**
-     * Pause-screen "slot". `true` renders the default title/description overlay,
-     * an element or a factory lets you inject arbitrary markup.
+     * Pause-screen "slot":
+     * - `true` (default) / `false` — show or hide the default title/description overlay;
+     * - an `HTMLElement` or factory — inject arbitrary markup;
+     * - a `PauseScreenContent` object — default overlay with specific parts hidden
+     *   (e.g. `{ title: false, description: false }` when the page renders them itself).
      */
-    pauseScreen?: boolean | HTMLElement | ((player: unknown) => HTMLElement);
+    pauseScreen?: boolean | HTMLElement | ((player: unknown) => HTMLElement) | PauseScreenContent;
     related?: RelatedOptions;
     /** Ad configuration: pre/mid/post rolls, skip timer, playlist frequency. */
     adConfig?: AdsOptions;

package/dist/ui/controls.d.ts

@@ -26,6 +26,14 @@ export declare class Controls {
     private moreWrap;
     private qualityBtn;
     private qualityMenu;
+    /** Unified ⚙ dropdown holding the settings placed in `"gear"`. */
+    private gearBtn;
+    private gearMenu;
+    /** Which settings live in the gear menu (vs their own bar button / off). */
+    private gear;
+    /** Next-up hover preview (desktop). */
+    private nextPreviewEl;
+    private nextPreviewOpts;
     private scenesBtn;
     private likeBtn;
     private dislikeBtn;
@@ -40,8 +48,6 @@ export declare class Controls {
     private centerPlayBtn;
     private centerPrevBtn;
     private centerNextBtn;
-    /** Controls that live in the center cluster on mobile (not in the bottom bar). */
-    private static readonly CENTER_KEYS;
     private collapsibles;
     private overflowed;
     private resizeObserver;
@@ -55,6 +61,17 @@ export declare class Controls {
     private registerCollapsible;
     /** Center-cluster button — deliberately NOT `.imp-btn` (own sizing/look). */
     private makeCenterButton;
+    /** Caption under the seek arrow showing the signed step, e.g. "−15s" / "+15s". */
+    private addStepBadge;
+    /** Sections for the gear when overflowed into ⋯ (expanded, no drill-down). */
+    private gearSections;
+    /** Gear drill-down rows: one per setting, each showing its current value. */
+    private gearEntries;
+    private toggleGearMenu;
+    private setupNextPreview;
+    private bindNextPreview;
+    private showNextPreview;
+    private hideNextPreview;
     /** like/dislike — visible buttons (collapsible), highlightable via `setLikeState`. */
     private buildLikeDislike;
     private attachCountTooltip;

package/dist/ui/menu.d.ts

@@ -10,6 +10,15 @@ export interface MenuSection {
     items: MenuItem[];
     onSelect(value: string): void;
 }
+/** One row in the settings (gear) drill-down: label + current value → options. */
+export interface SettingEntry {
+    key: string;
+    label: string;
+    /** Current value shown on the row, e.g. "Auto", "1×", "Off". */
+    value: string;
+    /** The options panel to drill into when the row is clicked. */
+    section(): MenuSection;
+}
 /**
  * Popup menu anchored above a control button. One instance per button;
  * rebuilt from data on every open, closed on outside click / Escape.
@@ -24,6 +33,15 @@ export declare class Menu {
     get open(): boolean;
     toggle(sections: MenuSection[]): void;
     show(sections: MenuSection[]): void;
+    /** Settings (gear) drill-down: a root list of rows, each opening its options. */
+    toggleSettings(title: string, entries: SettingEntry[]): void;
+    showSettings(_title: string, entries: SettingEntry[]): void;
+    private renderSettingsRoot;
+    private renderSettingsDetail;
+    /** Build one option block (radio items) from a section. */
+    private renderSection;
+    /** Reveal the populated menu + backdrop and arm the outside-click listener. */
+    private reveal;
     close(): void;
     destroy(): void;
 }

package/dist/ui/overlays.d.ts

@@ -29,10 +29,18 @@ export declare class PauseScreen {
     private sponsorLabel;
     private sponsorText;
     private custom;
+    /** Which parts the consumer allows (a hidden part stays hidden even with data). */
+    private visible;
     constructor(labels: PlayerLabels);
     setCustomContent(element: HTMLElement | null): void;
     /** True while consumer-provided custom content is mounted. */
     get hasCustom(): boolean;
+    /** Hide specific parts of the default overlay (consumer renders them itself). */
+    setVisibility(parts: {
+        title?: boolean;
+        description?: boolean;
+        sponsor?: boolean;
+    }): void;
     setSource(source: VideoSource | null): void;
     show(): void;
     hide(): void;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "itube-modern-player",
-  "version": "0.2.3",
+  "version": "0.3.1",
   "description": "Lightweight, framework-agnostic HTML5 video player: HLS streams, playlists, chapters, VTT subtitles, sprite previews, VAST ads. Ships with a Vue 3 wrapper.",
   "type": "module",
   "main": "./dist/index.cjs",

package/dist/labels-C3gAZEm-.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"labels-C3gAZEm-.js","sources":["../src/core/labels.ts"],"sourcesContent":["import type { PlayerLabels } from '../types'\n\nexport const defaultLabels: PlayerLabels = {\n  play: 'Play',\n  pause: 'Pause',\n  replay: 'Replay',\n  mute: 'Mute',\n  unmute: 'Unmute',\n  fullscreen: 'Fullscreen',\n  exitFullscreen: 'Exit fullscreen',\n  pip: 'Picture-in-picture',\n  settings: 'Playback speed',\n  scenes: 'Scenes',\n  shuffle: 'Shuffle',\n  repeat: 'Repeat',\n  subtitles: 'Subtitles',\n  subtitlesOff: 'Off',\n  speed: 'Speed',\n  quality: 'Quality',\n  qualityAuto: 'Auto',\n  next: 'Next',\n  previous: 'Previous',\n  playlist: 'Playlist',\n  like: 'Like',\n  dislike: 'Dislike',\n  addTo: 'Save to…',\n  share: 'Share',\n  report: 'Report',\n  more: 'More actions',\n  seekForward: 'Seek forward',\n  seekBack: 'Seek back',\n  live: 'LIVE',\n  related: 'More videos',\n  adLabel: 'Ad',\n  skipAd: 'Skip ad',\n  skipAdIn: 'Skip in',\n  visitAdvertiser: 'Visit advertiser',\n  sponsored: 'Sponsored',\n}\n"],"names":["defaultLabels"],"mappings":"AAEO,MAAMA,IAA8B;AAAA,EACzC,MAAM;AAAA,EACN,OAAO;AAAA,EACP,QAAQ;AAAA,EACR,MAAM;AAAA,EACN,QAAQ;AAAA,EACR,YAAY;AAAA,EACZ,gBAAgB;AAAA,EAChB,KAAK;AAAA,EACL,UAAU;AAAA,EACV,QAAQ;AAAA,EACR,SAAS;AAAA,EACT,QAAQ;AAAA,EACR,WAAW;AAAA,EACX,cAAc;AAAA,EACd,OAAO;AAAA,EACP,SAAS;AAAA,EACT,aAAa;AAAA,EACb,MAAM;AAAA,EACN,UAAU;AAAA,EACV,UAAU;AAAA,EACV,MAAM;AAAA,EACN,SAAS;AAAA,EACT,OAAO;AAAA,EACP,OAAO;AAAA,EACP,QAAQ;AAAA,EACR,MAAM;AAAA,EACN,aAAa;AAAA,EACb,UAAU;AAAA,EACV,MAAM;AAAA,EACN,SAAS;AAAA,EACT,SAAS;AAAA,EACT,QAAQ;AAAA,EACR,UAAU;AAAA,EACV,iBAAiB;AAAA,EACjB,WAAW;AACb;"}