typstream

Theming and styling

Light and dark themes, the CSS variables and classes typstream exposes, extra stylesheets, and the word fade-in and caret while streaming.

typstream's HTML output follows your app's look: its colors are CSS variables, every built-in rule has zero specificity so yours win, and dark mode works without extra code. The paged target shows pages as paper, and you style the frame around them. This page covers both, and the streaming effects: words fading in and a caret.

Light, dark or automatic

The theme prop sets the HTML target's colors:

themeColors
"auto" (default)Follow the page's color-scheme.
"light"Always light.
"dark"Always dark.
<Typstream source={text} theme="dark" />

"auto" uses CSS light-dark(), which follows the color-scheme of the element. Most pages never set one, and then it's light. To follow the reader's system setting, declare both on your page:

:root {
  color-scheme: light dark;
}

If your app has its own dark mode toggle, set color-scheme: dark while it's on, and typstream follows.

theme applies to the HTML target and to standalone HTML exports (which default to light, since files get printed). The paged target draws pages as white paper in either theme.

CSS variables

The theme sets these on the renderer's root element (.typstream):

VariableDefault (light, dark)Used for
--typstream-foreground#1c1c1e, #e8e8eaText.
--typstream-muted#5c5c63, #a4a4abFigure captions, and secondary text in plugins' styles (edu's subject line).
--typstream-link#1d4ed8, #8ab4ffLinks.
--typstream-highlight#fff2a8, #6b5b00The background of #highlight[…].
--typstream-caret-colorcurrentColorThe streaming caret.
--typstream-caret"▋"The caret's character (CSS content).

Plugins add their own. @typstream/edu's stylesheet defines --edu-ink (answers in the teacher's copy), --edu-rule and --edu-faint (lines and borders), and a color per callout kind: --edu-note, --edu-tip, --edu-warning, --edu-definition, --edu-example and --edu-remember.

Override them on the root element. Use light-dark() to keep both modes:

app.css
.answer .typstream {
  --typstream-foreground: light-dark(#0f172a, #e2e8f0);
  --typstream-link: light-dark(#7c3aed, #c4b5fd);
  --typstream-highlight: light-dark(#fde68a, #78350f);
  --edu-ink: light-dark(#be123c, #fda4af);
  font-family: "Inter", sans-serif;
}
<Typstream source={text} className="answer" />

Set them on .typstream itself, not on an ancestor: the theme declares them on that element, so a value inherited from further up would be overridden.

Classes and structure

HTML target. <Typstream> renders a div.typstream-host (with your className, style and id), and inside it the renderer's root:

SelectorWhat it is
.typstreamThe root. Typst's HTML goes inside it. It carries the document's lang and dir, and clips what the document draws to its box (Security).
.typstream[data-typstream-theme]Set to light or dark when theme forces one.
[data-typstream-animate]A word fading in.
.typstream-pagesThe root as the renderer lays the document out on pages: its sheets (.typstream-paged > .typstream-page, as the paged view's), the document over them (.typstream-flow), headers and footers (.typstream-marginals). Pages are white with black text, as on the paged view, in either theme.
.typstream-caretThe caret, drawn by its ::after.

Inside the root is Typst's own HTML: h1–h6, p, ul, table, figure, math and so on, which you can style like any content. @typstream/html-compat and @typstream/edu add elements of their own with ts- and edu- class names. Other classes a document writes are dropped, so your page's own classes never apply to it; a plugin that writes classes for your CSS lists them in its sanitize facet (allowClasses).

Paged target.

SelectorWhat it is
.typstream-pagedThe column of pages, with data-layout: "fit-width" and "reflow" fill the width (reflow without gaps between pages).
.typstream-pageOne page, with data-page (1-based). White, sized from the page.
.typstream-text-layerTransparent, selectable text over a page.
.typstream-linksA canvas page's links, over its text layer.

A page is a <canvas> (or, for SVG pages, an SVG in its own shadow root), so your CSS doesn't reach what it draws. Style the frame instead:

.answer .typstream-paged {
  gap: 24px;
}
.answer .typstream-page {
  box-shadow: 0 1px 3px rgb(0 0 0 / 0.15), 0 8px 24px rgb(0 0 0 / 0.08);
}

Your rules win

Every rule of the HTML renderer, @typstream/html-compat and @typstream/edu is scoped to the root and wrapped in :where():

:where(.typstream) a {
  color: var(--typstream-link);
}

:where() has zero specificity, so any selector of yours beats it, whatever the order of the stylesheets, with no !important. A plain .answer a { … } is enough. The paged target's few rules (.typstream-page, .typstream-paged) are single-class selectors: override them with one more class, as above.

Extra stylesheets

The stylesheets prop adds CSS for the HTML target:

const css = `
:where(.typstream) h1 {
  letter-spacing: -0.02em;
}
:where(.typstream) table {
  font-variant-numeric: tabular-nums;
}
`;

<Typstream source={text} stylesheets={[css]} />;

Stylesheets apply in this order: the renderer's own, then each plugin's stylesheets (in plugin order, dependencies first), then yours. Each is added once per document (or per shadow root, if the renderer is inside one), however many <Typstream>s use it.

Use stylesheets rather than your global CSS for rules that should travel with the document: they are also written into standalone HTML exports, where <body> is the .typstream root. Scope them to .typstream as above, so they match in both places and stay out of the rest of your page. Rules for your app's chrome around the preview belong in your own CSS.

Stylesheets are added as constructed stylesheets (adoptedStyleSheets) where the browser supports them, which a Content-Security-Policy without style-src 'unsafe-inline' allows. The paged renderer does the same, and Typst's inline styles are applied through the CSSOM, so typstream needs no 'unsafe-inline' for styles. See Security for the whole policy.

With @typstream/dom's createHtmlRenderer, injectStyles: false turns the injection off, for apps that ship the CSS themselves: the renderer's is exported as htmlRendererCss, and plugins carry theirs in stylesheets.

Word fade-in and the caret

While a document streams in the HTML target, new words can fade in, and a caret can blink after the last one:

<Typstream source={text} isStreaming={isStreaming} animated caret />

Only words that are new are animated. Blocks the stream didn't change are left alone, and a block that changed keeps the words already on screen. When the stream runs ahead, the delay between words shrinks so the animation never falls far behind the text.

animated takes true for the defaults, or options:

<Typstream source={text} isStreaming={isStreaming} animated={{ animation: "blurIn", duration: 200, stagger: 30 }} />

Prop

Type

Your own keyframes need a typstream- prefix: animation: "pop" plays @keyframes typstream-pop, which you add with stylesheets. Keyframes named just pop aren't used:

const pop = `@keyframes typstream-pop {
  from {
    opacity: 0;
    transform: scale(0.96);
  }
}`;

<Typstream source={text} isStreaming={isStreaming} animated={{ animation: "pop" }} stylesheets={[pop]} />;

The caret is a character drawn after the last text. Change it with --typstream-caret and its color with --typstream-caret-color:

.answer .typstream {
  --typstream-caret: "_";
  --typstream-caret-color: var(--brand);
}

Both effects respect prefers-reduced-motion: words appear without animating and the caret stops blinking. Both are off once the document is finished, and neither applies to the paged target.

Dark mode and the document's own colors

Typst documents can set fills: a highlighted box, a shaded table cell, a code block. The author chose those fills for dark text, as on paper. So in the dark theme, anything the document filled keeps the light theme's text color inside it, and stays readable. Labels that @typstream/html-compat places outside a shape (a dimension under a drawing) sit on the page, not on the fill, so they follow the theme.

The paged target shows the document as printed, and doesn't change with the theme: pages are white with the colors the document set.

On this page