SoneSone

API reference

Generated from Sone's TypeScript declarations — every public prop, every type.

This page is regenerated from dist/node.d.mts on every build via fumadocs-typescript. If you spot a discrepancy with the runtime, the runtime is right — file an issue and we'll re-extract.

For prose-style pages on individual nodes, see the section guides: Layout, Typography, Content nodes, Output.

Jump to a group

Layout

Flexbox-style props shared by every node in a Sone tree — sizing, spacing, alignment, transforms.

LayoutProps

Core layout properties - mirrors CSS Flexbox/Grid with additional visual styling

Prop

Type

Text

Properties on the Text node, plus the TextDefault wrapper.

TextProps

Text block properties extending span properties

Prop

Type

DefaultTextProps

Prop

Type

TextDefaultProps

Prop

Type

Span

Inline runs inside a Text node. Spans inherit the parent Text style and override only what is set.

SpanProps

Text styling properties for spans and text

Prop

Type

Grid

Two-dimensional layout container.

GridProps

Prop

Type

GridTrack

Prop

Type

Photo

Image node — local path, URL, or Buffer.

PhotoProps

Image display properties

Prop

Type

Path

SVG-path node for vector shapes.

PathProps

SVG path drawing properties

Prop

Type

Table

Table, row, and cell properties.

TableProps

Prop

Type

TableRowProps

Prop

Type

TableCellProps

Prop

Type

List

List and list-item properties.

ListProps

List marker and container customization properties

Prop

Type

ClipGroup

Mask the content node with the shape of the clip node.

ClipGroupProps

Layout props for a clip-group container

Prop

Type

Render config

Top-level options passed to sone(tree, config).

SoneRenderConfig

Configuration for rendering

Prop

Type

SoneHeaderFooter

A header or footer value: either a static node (same on every page) or a function that receives page info and returns a node (rendered per-page).

No public properties.

SoneDebugConfig

Debug configuration for development

Prop

Type

On this page