Outline

Render a table-of-contents outline.

Astryx Props

JSON-safe Outline props forwarded to Astryx.

Supported Astryx props include:

items (OutlineItem[]; required): Ordered heading items to render as table-of-contents links.
activeId (string): Currently active item id. When provided, disables built-in scroll spy state ownership.
onActiveIdChange ((id: string) => void): Called when the active item changes from scroll spy or click.
label (string; default 'Table of contents'): Accessible label for the nav landmark.
density ('default' or 'compact'; default 'default'): Controls item padding density.
data-testid (string): Test selector for automated testing.
xstyle (StyleXStyles): StyleX styles for layout customization.
className (string): CSS class names for the nav element.
style (CSSProperties): Inline styles for the nav element.

Props typed as React nodes, render functions, event handlers, refs, or StyleX styles are documented for Astryx parity but cannot be serialized directly from Python unless the wrapper adapts them.

See Astryx component docs: https://astryx.atmeta.com/components/Outline.

Functions

constructor__init__(items, *, active_id='', label='Table of contents', density='compact', **props) -> None

paramitemsIterable[Mapping[str, Any]]

Item records used by generated child components or static search sources.

paramactive_idstr

= ''

Currently active outline item id.

paramlabelstr

= 'Table of contents'

Visible or accessible label for the component.

paramdensitystr

= 'compact'

Astryx density or spacing mode.

parampropsAny

= {}

Returns

None

Functions

On this page