@bendyline/squisq-react 2.7.2 → 2.8.0

package/dist/index.d.ts

@@ -1,18 +1,18 @@
 import { SquisqRenderAPI, VideoPresentation as VideoPresentation$1, PipSize, PipShape, PipPosition } from './player/index.js';
 export { BlockMarker, BlockRenderer, CaptionMode, CaptionOverlay, CaptionStyle, ControlsLayout, DisplayMode, DocControlsBottom, DocControlsOverlay, DocControlsSidebar, DocControlsSlideshow, DocPlayer, DocPlayerProps, DocPlayerWithSidebar, DocProgressBar, InlineAudioPlayer, InlineAudioPlayerProps, InlineVideoPlayer, InlineVideoPlayerProps, MediaClipLayer, MediaClipLayerProps, PlaybackActions, PlaybackState, RenderAudioSegmentInfo, RenderBlockInfo, RenderCaptionInfo, RenderChapterInfo, SlideNavActions, SocialCaptionOverlay, formatTime } from './player/index.js';
 import { Theme, VideoPresentation, VideoPipSize, VideoPipShape, VideoPipPosition, Doc, ScheduledClip, MediaProvider } from '@bendyline/squisq/schemas';
+import { DashboardStyleId, ViewportConfig, CoverSlideTemplate, CoverSlidePlayback } from '@bendyline/squisq/doc';
+export { getAnimationStyle, getTransitionClass } from '@bendyline/squisq/doc';
 import { C as CodeBlockCopyHandler } from './MarkdownRenderer-CC9dOc6b.js';
 export { a as CodeBlockCopyContext, M as MarkdownRenderer, b as MarkdownRendererProps } from './MarkdownRenderer-CC9dOc6b.js';
 export { FenceRendererContext, MermaidDiagram, MermaidDiagramProps, useFenceRenderers } from './markdown/index.js';
 export { CanvasSection, CanvasSectionProps, ImageDisplayMode, LinearDocView, LinearDocViewProps, PageSectionView, PageSectionViewProps, PageViewContext, PageViewContextValue, usePageView } from './page/index.js';
+import * as react_jsx_runtime from 'react/jsx-runtime';
 export { ImageLayer, MapLayer, MermaidLayer, PathLayer, ShapeLayer, TableLayer, TextLayer, TreeLayer, VideoLayer } from './layers/index.js';
-import { CoverSlideTemplate, CoverSlidePlayback } from '@bendyline/squisq/doc';
-export { getAnimationStyle, getTransitionClass } from '@bendyline/squisq/doc';
 export { MediaContext, MediaScheduleController, ModalDialogOptions, ResourcePolicyContext, UseDocPlaybackOptions, useAudioSync, useAutoSurface, useDocPlayback, useMediaProvider, useMediaSchedule, useMediaUrl, useModalDialog, useResourcePolicy, useViewportOrientation } from './hooks/index.js';
 export { FenceRenderContext, FenceRenderer, FenceRendererMap } from '@bendyline/squisq/fence';
 export { A as AudioActions, a as AudioController, b as AudioState } from './AudioController-DwMsPe38.js';
 export { JsonFormFenceAction, JsonFormFenceRendererOptions, JsonView, JsonViewProps, createJsonFormFenceRenderer } from './json-view/index.js';
-import 'react/jsx-runtime';
 import 'react';
 import '@bendyline/squisq/markdown';
 import '@bendyline/squisq/jsonForm';
@@ -42,8 +42,22 @@ import '@bendyline/squisq/jsonForm';
  */
 
 interface MountOptions {
-    /** Rendering mode: 'slideshow' (interactive, default) or 'static' (scrollable) */
-    mode?: 'slideshow' | 'static';
+    /**
+     * Rendering mode: 'slideshow' (interactive, default), 'static'
+     * (scrollable page), or 'dashboard' (one canvas of arranged blocks).
+     */
+    mode?: 'slideshow' | 'static' | 'dashboard';
+    /** Dashboard-mode options (ignored by the other modes). */
+    dashboard?: {
+        /** Layout id or 'auto'. Overrides doc frontmatter. */
+        layout?: string;
+        /** Title-band override. Overrides doc frontmatter. */
+        title?: boolean;
+        /** Cell style variant ('basic' | 'card' | 'panel' | 'accent'). */
+        style?: DashboardStyleId;
+        /** Host-supplied title fallback (typically the file name). */
+        documentTitle?: string;
+    };
     /** Base path for resolving relative media URLs */
     basePath?: string;
     /**
@@ -104,6 +118,37 @@ interface SquisqPlayerHandle {
     unmount(): void;
 }
 
+interface DashboardViewProps {
+    doc: Doc;
+    /** Resolved theme; defaults to the doc's own theme resolution. */
+    theme?: Theme;
+    /** Canvas viewport (default: the landscape preset). */
+    viewport?: ViewportConfig;
+    /** Layout override: an id or `'auto'`. Overrides doc frontmatter. */
+    layout?: string;
+    /** Title-band override. Overrides doc frontmatter (default true). */
+    showTitle?: boolean;
+    /**
+     * Cell style variant (`basic` | `card` | `panel` | `accent`). Overrides
+     * doc frontmatter; all variants take their colors from the active theme.
+     */
+    style?: DashboardStyleId;
+    /** Host-supplied title fallback (typically the file name). */
+    documentTitle?: string;
+    /** Base path for resolving media URLs (default `'.'`). */
+    basePath?: string;
+    /** Render ambient/authored layer animations (default true). */
+    animationsEnabled?: boolean;
+    /** Silence audio carried by cell video layers (default true). */
+    muted?: boolean;
+    /** Publish the capture-readiness render API (headless export). */
+    renderMode?: boolean;
+    /** Receives the minimal render API, and `null` on cleanup. */
+    onRenderAPIReady?: (api: SquisqRenderAPI | null) => void;
+    className?: string;
+}
+declare function DashboardView({ doc, theme, viewport, layout, showTitle, style, documentTitle, basePath, animationsEnabled, muted, renderMode, onRenderAPIReady, className, }: DashboardViewProps): react_jsx_runtime.JSX.Element;
+
 interface DocPlayerAppearanceOverrides {
     theme?: Theme;
     videoPresentation?: VideoPresentation$1;
@@ -154,4 +199,4 @@ declare function resolveDocPlayerAppearance(doc: Doc, overrides?: DocPlayerAppea
  */
 declare function useMediaClipDurations(schedule: ScheduledClip[], basePath: string, mediaProviderOverride?: MediaProvider | null): Map<string, number>;
 
-export { CodeBlockCopyHandler, type DocPlayerAppearanceOverrides, type MountOptions, PipPosition, PipShape, PipSize, type ResolvedDocPlayerAppearance, type SquisqPlayerHandle, SquisqRenderAPI, VideoPresentation$1 as VideoPresentation, resolveDocPlayerAppearance, useMediaClipDurations };
+export { CodeBlockCopyHandler, DashboardView, type DashboardViewProps, type DocPlayerAppearanceOverrides, type MountOptions, PipPosition, PipShape, PipSize, type ResolvedDocPlayerAppearance, type SquisqPlayerHandle, SquisqRenderAPI, VideoPresentation$1 as VideoPresentation, resolveDocPlayerAppearance, useMediaClipDurations };

package/dist/index.js

@@ -1,5 +1,6 @@
 import {
   CaptionOverlay,
+  DashboardView,
   DocControlsBottom,
   DocControlsOverlay,
   DocControlsSidebar,
@@ -12,7 +13,7 @@ import {
   formatTime,
   resolveDocPlayerAppearance,
   useMediaClipDurations
-} from "./chunk-KXYE4AGL.js";
+} from "./chunk-LAL43UUN.js";
 import {
   BlockRenderer,
   CanvasSection,
@@ -71,6 +72,7 @@ export {
   BlockRenderer,
   CanvasSection,
   CaptionOverlay,
+  DashboardView,
   DocControlsBottom,
   DocControlsOverlay,
   DocControlsSidebar,

package/dist/player/index.d.ts

@@ -1,6 +1,6 @@
 import * as react_jsx_runtime from 'react/jsx-runtime';
 import { Block, VideoPresentation as VideoPresentation$1, VideoPipSize, VideoPipShape, VideoPipPosition, Doc, Theme, SurfaceScheme, Transition, CaptionTrack, ViewportConfig as ViewportConfig$1, ScheduledClip } from '@bendyline/squisq/schemas';
-import { ViewportConfig, CoverSlideTemplate, CoverSlidePlayback } from '@bendyline/squisq/doc';
+import { ViewportConfig, DashboardStyleId, CoverSlideTemplate, CoverSlidePlayback } from '@bendyline/squisq/doc';
 import { FenceRendererMap } from '@bendyline/squisq/fence';
 import { a as AudioController } from '../AudioController-DwMsPe38.js';
 import { C as CodeBlockCopyHandler } from '../MarkdownRenderer-CC9dOc6b.js';
@@ -57,8 +57,11 @@ type PipPosition = VideoPipPosition;
  *   implement this mode; it is owned by the editor package
  *   (`@bendyline/squisq-editor-react`), which renders its own
  *   voice-paced teleprompter view for it.
+ * - `'dashboard'` — One static canvas that arranges every block into a
+ *   layout's cells (grids, hero mosaics). No timeline, no navigation;
+ *   overflow blocks beyond the layout's capacity are not rendered.
  */
-type DisplayMode = 'video' | 'slideshow' | 'linear' | 'page' | 'narrate';
+type DisplayMode = 'video' | 'slideshow' | 'linear' | 'page' | 'narrate' | 'dashboard';
 /**
  * Caption display style.
  *
@@ -223,8 +226,16 @@ interface DocPlayerProps {
     forceViewport?: ViewportConfig;
     theme?: Theme;
     surface?: SurfaceScheme | 'auto';
-    /** Video, manual slideshow, or long-scrolling linear rendition. */
+    /** Video, manual slideshow, long-scrolling linear, or dashboard rendition. */
     displayMode?: DisplayMode;
+    /** Dashboard mode: layout id or `'auto'`. Overrides doc frontmatter. */
+    dashboardLayout?: string;
+    /** Dashboard mode: title-band override. Overrides doc frontmatter. */
+    dashboardShowTitle?: boolean;
+    /** Dashboard mode: cell style variant. Overrides doc frontmatter. */
+    dashboardStyle?: DashboardStyleId;
+    /** Dashboard mode: host-supplied title fallback (typically the file name). */
+    dashboardDocumentTitle?: string;
     showCoverSlide?: boolean;
     /** Visual template used to materialize the managed cover. */
     coverSlideTemplate?: CoverSlideTemplate;

package/dist/player/index.js

@@ -10,7 +10,7 @@ import {
   MediaClipLayer,
   SocialCaptionOverlay,
   formatTime
-} from "../chunk-KXYE4AGL.js";
+} from "../chunk-LAL43UUN.js";
 import {
   BlockRenderer
 } from "../chunk-IQGW6SA6.js";