List

Render an Astryx list from item records.

Astryx Props

JSON-safe List props forwarded to Astryx.

Supported Astryx props include:

children (ReactNode): List items (ListItem components).
density ('compact' or 'balanced' or 'spacious'): Spacing density for items.
hasDividers (boolean): Show dividers between items.
header (ReactNode): Header content, associated with the list via aria-labelledby.
listStyle ('none' or 'disc' or 'decimal' or 'circle'): List marker style. 'decimal' renders an <ol> element instead of <ul>.
start (number): Starting number for ordered lists (listStyle='decimal'). Sets the CSS counter to begin at this value.
xstyle (StyleXStyles): StyleX styles for layout customization (margins, positioning, sizing). Must be a stylex.create() value: not an inline style object like style={{}}.

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/List.

Functions

constructor__init__(items, *, header='', density=None, dividers=None, list_style=None, start=None, **props) -> None

paramitemsIterable[Any]

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

paramheaderstr

= ''

Optional header text or content.

paramdensitystr | None

= None

Item spacing density.

paramdividersbool | None

= None

Whether to show dividers between items.

paramlist_stylestr | None

= None

List marker style.

paramstartint | None

= None

Starting number for ordered lists.

parampropsAny

= {}

Returns

None

Functions

On this page