@bendyline/squisq-react

React component library for playing, rendering, and interacting with Squisq documents. Includes a full-featured doc player, SVG-based block renderer, media layers, and playback hooks.

Part of the Squisq monorepo.

Install

npm install @bendyline/squisq-react @bendyline/squisq

Peer dependencies: react and react-dom (v18 or v19).

Quick Start

import { DocPlayer } from '@bendyline/squisq-react';
import '@bendyline/squisq-react/styles';

function App() {
  return <DocPlayer markdown={'# Hello\n\nWelcome to Squisq.'} />;
}

DocPlayer accepts either raw markdown (parsed and converted internally) or a parsed doc; if you already have a Doc, pass <DocPlayer doc={doc} />. basePath is optional (default '.') and is the base URL for resolving relative media paths. With neither markdown nor doc, the player renders a themed empty state rather than crashing.

v1.5 breaking changes: the old script prop is now doc, and the audioProvider prop is now audioController (its type AudioProvider was renamed to AudioController). LinearDocView gained the same markdown prop.

Components

Fenced-code copy control

MarkdownRenderer and the linear document surfaces keep code-copy UI off by default. Opt in with showCodeCopyButton. Web hosts can rely on navigator.clipboard; Electron or native embeddings can provide their own clipboard bridge:

<LinearDocView
  markdown={'```\n$ node packages/tooling/dist/cli.mjs components\n```'}
  showCodeCopyButton
  onCopyCode={(code, { language }) => hostClipboard.writeText(code)}
/>

The same two props are available on DocPlayer (for linear mode), and on the standalone static mount() options. The callback receives the exact fence contents, without the backtick delimiters.

Layers

Blocks are composed of typed layers rendered as SVG:

Hooks

useDocPlayback takes configuration as an options object:

useDocPlayback(doc, currentTime, { viewport, theme, onSeek });

Standalone Player

A global build is available for non-React environments. It exposes a SquisqPlayer global with mount, getHandle, unmount, and version. mount returns an instance handle. Load the package stylesheet alongside the raw global build so authored Font Awesome icons can use the shared webfonts.

The default build is the light player and omits Mermaid's multi-megabyte parser and layout engines. Documents that contain Mermaid fences should use the full variant at dist/squisq-player.full.global.js (also exported as @bendyline/squisq-react/standalone/full). Other diagrams are supported by both variants.

The former mountStatic() shortcut was removed; pass mode: 'static' to mount(). Render methods are instance-scoped and are no longer copied to top-level window.seekTo / window.getDuration properties.

Interactive mount:

<link rel="stylesheet" href="https://unpkg.com/@bendyline/squisq-react/dist/styles/index.css" />
<script src="https://unpkg.com/@bendyline/squisq-react/dist/squisq-player.global.js"></script>
<div id="player"></div>
<script>
  // docJson is a Doc (e.g. produced by markdownToDoc and serialized)
  const root = document.getElementById('player');
  const handle = SquisqPlayer.mount(root, docJson, {
    mode: 'slideshow', // or 'static' for a scrollable document view
    basePath: '/',
  });

  // In render mode: const api = await handle.renderAPI;
  // The same handle is available later as SquisqPlayer.getHandle(root).
</script>

For headless capture, add renderMode: true, then await handle.renderAPI before calling seekTo() or reading render metadata. seekTo() resolves only after React has committed the requested visual time, CSS animations have been positioned, active video has produced its sought frame, and one final paint opportunity has completed. getRenderedTime() returns the timeline time represented by the committed DOM. TypeScript hosts can import MountOptions and SquisqPlayerHandle from the package root.

Set animationsEnabled: false on DocPlayer, BlockRenderer, or standalone mount() to render authored layer animations and block transitions as static content. Embedded video, timed media, captions, audio, and document timing stay active; this makes the option suitable for compact MP4 and animated-GIF export.

For build-time embedding, @bendyline/squisq-react/standalone-source exports the player as a self-contained string constant (PLAYER_BUNDLE) with the shared icon styles composed once. It is used by @bendyline/squisq-formats and the CLI to produce single-file HTML and rendered video exports.

Diagram Pictures

@bendyline/squisq-react/diagram-pictures draws diagrams as PNG for document exports (browser only): renderMermaidPicture, renderSquisqDiagramPicture (ASCII diagrams and timelines, drawing, layout and diagram blocks, cropped to their content without slide chrome), renderTreePicture, and createDiagramPictureRenderer, the renderer rasterizeDiagrams in @bendyline/squisq-formats/diagrams takes. Pictures are plain SVG drawn to a canvas — Mermaid with SVG-text labels, no <foreignObject> — so the read-back works in every browser, and text uses system fonts because a picture cannot load the page's web fonts.

Styles

Import the package CSS for block transitions and Font Awesome inline icons:

import '@bendyline/squisq-react/styles';

Full API Reference

See docs/API.md for the complete prop tables, hook signatures, and types.

Related Packages

License

MIT