AnyLumino
API referenceastryxsurfaces

TabList

Render an Astryx tab list.

Astryx Props

JSON-safe TabList props forwarded to Astryx.

Supported Astryx props include:

  • value (string; required): The currently selected tab value.
  • onChange ((value: string) => void; required): Callback fired when a tab is selected.
  • size ('sm' or 'md' or 'lg'): Size variant applied to all child tabs.
  • layout ('hug' or 'fill'): Layout mode for tab sizing. 'hug': each tab hugs its content width. 'fill': tabs stretch equally to fill the container width.
  • hasDivider (boolean): Whether to show a bottom border divider under the tab list.
  • orientation ('horizontal' or 'vertical'): Orientation of the tab strip, controlling which arrow keys move focus between tabs and the reported aria-orientation. 'horizontal': ArrowLeft/ArrowRight. 'vertical': ArrowUp/ArrowDown. Both axes' arrows are accepted regardless.
  • children (ReactNode; required): Tab and TabMenu items to render inside the nav.
  • 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/TabList.

Functions

constructor__init__(items, value, *, size=None, layout=None, divider=None, orientation=None, **props) -> None
paramitemsIterable[Any]

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

paramvaluestr

Synchronized component value.

paramsizestr | None
= None

Tab size.

paramlayoutstr | None
= None

Hug or fill tab layout.

paramdividerbool | None
= None

Whether to show the tab-list divider.

paramorientationstr | None
= None

Horizontal or vertical tab orientation.

parampropsAny
= {}

Returns

None

On this page