TreeList

Render hierarchical notebook data as an expandable tree.

Astryx Props

JSON-safe TreeList props forwarded to Astryx.

Supported Astryx props include:

items (TreeListItemData[]; required): Recursive tree item data; nested children arrays create hierarchy.
density ('compact' or 'balanced' or 'spacious'; default 'balanced'): Spacing density for tree list items.
header (ReactNode): Header content rendered above the tree and associated with aria-labelledby.
data-testid (string): Test selector for automated testing.
xstyle (StyleXStyles): StyleX styles for the root element.
className (string): CSS class names for the root element.
style (CSSProperties): Inline styles for the root 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/TreeList.

Functions

constructor__init__(items, *, header='', density='balanced', **props) -> None

paramitemsIterable[Mapping[str, Any]]

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

paramheaderstr

= ''

Optional header text or content.

paramdensitystr

= 'balanced'

Astryx density or spacing mode.

parampropsAny

= {}

Returns

None

Functions

On this page