ListViewProps
Defined in: react/components/data/list-view.tsx:7
Props for ListView.
Extends
Section titled “Extends”Omit<ComponentProps,"children">
Properties
Section titled “Properties”className?
Section titled “className?”
optionalclassName?:string
Defined in: react/components/types.ts:24
Space-separated class names (currently advisory; no CSS cascade).
Inherited from
Section titled “Inherited from”disabled?
Section titled “disabled?”
optionaldisabled?:boolean
Defined in: react/components/types.ts:52
Marks the widget (and its descendants) as inert: not focusable, ignores key/mouse input, and interactive controls render in a muted style. A disabled container propagates to every control inside it.
Inherited from
Section titled “Inherited from”focusable?
Section titled “focusable?”
optionalfocusable?:boolean
Defined in: react/components/types.ts:40
Allow this widget to take keyboard focus.
Inherited from
Section titled “Inherited from”focusOnClick?
Section titled “focusOnClick?”
optionalfocusOnClick?:boolean
Defined in: react/components/types.ts:46
When a click lands on this container (its padding, border, or a non-focusable
child), move focus to its first focusable descendant — so clicking a
Form/Panel/Box hands focus to its first field. Off by default.
Inherited from
Section titled “Inherited from”groups?
Section titled “groups?”
optionalgroups?:RowGroup<ListItem>[]
Defined in: react/components/data/list-view.tsx:14
Grouped mode: each group renders a non-interactive title row followed by
its items; clicking a title (or ←/→ on a row) collapses/expands it.
hoverInterest?
Section titled “hoverInterest?”
optionalhoverInterest?:boolean
Defined in: react/components/types.ts:66
Opt-in hint that this widget cares about passive hover movement.
Inherited from
Section titled “Inherited from”
optionalid?:string
Defined in: react/components/types.ts:22
Stable identifier, handy for tests and lookups.
Inherited from
Section titled “Inherited from”items?
Section titled “items?”
optionalitems?:ListItem[]
Defined in: react/components/data/list-view.tsx:9
Items to display (flat mode). Ignored when groups is set.
label?
Section titled “label?”
optionallabel?:string
Defined in: react/components/types.ts:36
Structural/accessible label (also the tab title inside TabContainer).
Inherited from
Section titled “Inherited from”mutedColor?
Section titled “mutedColor?”
optionalmutedColor?:string
Defined in: react/components/data/list-view.tsx:24
Color used for disabled rows and detail text.
onActivate?
Section titled “onActivate?”
optionalonActivate?: (item) =>void
Defined in: react/components/data/list-view.tsx:28
Item activated — Enter, Space, or double-click.
Parameters
Section titled “Parameters”ListItem
Returns
Section titled “Returns”void
onClick?
Section titled “onClick?”
optionalonClick?: (ev) =>void
Defined in: react/components/types.ts:54
Pointer click.
Parameters
Section titled “Parameters”any
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”onDragEnd?
Section titled “onDragEnd?”
optionalonDragEnd?: (x,y,moved) =>void
Defined in: react/components/types.ts:72
Drag released; moved is false for a tap with no movement.
Parameters
Section titled “Parameters”number
number
boolean
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”onDragMove?
Section titled “onDragMove?”
optionalonDragMove?: (x,y) =>void
Defined in: react/components/types.ts:70
Pointer moved while dragging from this widget.
Parameters
Section titled “Parameters”number
number
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”onDragStart?
Section titled “onDragStart?”
optionalonDragStart?: (x,y) =>void
Defined in: react/components/types.ts:68
Pointer-drag lifecycle; moved is false for a tap with no movement.
Parameters
Section titled “Parameters”number
number
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”onKey?
Section titled “onKey?”
optionalonKey?: (ev) =>void
Defined in: react/components/types.ts:58
Key event while focused; set ev.handled to consume it.
Parameters
Section titled “Parameters”any
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”onMouseDown?
Section titled “onMouseDown?”
optionalonMouseDown?: (ev) =>void
Defined in: react/components/types.ts:56
Pointer pressed (any button); the event carries button and x/y.
Parameters
Section titled “Parameters”any
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”onMouseEnter?
Section titled “onMouseEnter?”
optionalonMouseEnter?: (ev) =>void
Defined in: react/components/types.ts:62
Pointer entered this widget’s region.
Parameters
Section titled “Parameters”any
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”onMouseLeave?
Section titled “onMouseLeave?”
optionalonMouseLeave?: (ev) =>void
Defined in: react/components/types.ts:64
Pointer left this widget’s region.
Parameters
Section titled “Parameters”any
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”onScroll?
Section titled “onScroll?”
optionalonScroll?: (ev) =>void
Defined in: react/components/types.ts:60
Wheel / scroll event.
Parameters
Section titled “Parameters”any
Returns
Section titled “Returns”void
Inherited from
Section titled “Inherited from”onSelect?
Section titled “onSelect?”
optionalonSelect?: (item) =>void
Defined in: react/components/data/list-view.tsx:26
Selection changed (arrow navigation or single click).
Parameters
Section titled “Parameters”ListItem
Returns
Section titled “Returns”void
onToggleGroup?
Section titled “onToggleGroup?”
optionalonToggleGroup?: (id,collapsed) =>void
Defined in: react/components/data/list-view.tsx:16
A group was collapsed or expanded (grouped mode).
Parameters
Section titled “Parameters”string
collapsed
Section titled “collapsed”boolean
Returns
Section titled “Returns”void
optionalref?:Ref<Widget>
Defined in: react/components/types.ts:30
Captures the underlying widget instance (React 19 ref-as-prop). Defaults to
the base Widget; narrow it with a cast when you need a subclass field,
e.g. ref={inputRef as React.Ref<InputWidget>}.
Inherited from
Section titled “Inherited from”rowHeight?
Section titled “rowHeight?”
optionalrowHeight?:number
Defined in: react/components/data/list-view.tsx:18
Height of each row in cells.
selectedBackground?
Section titled “selectedBackground?”
optionalselectedBackground?:string
Defined in: react/components/data/list-view.tsx:22
Background color painted across the selected row.
selectedId?
Section titled “selectedId?”
optionalselectedId?:string|null
Defined in: react/components/data/list-view.tsx:20
Selected item id, or null.
style?
Section titled “style?”
optionalstyle?:WidgetStyles
Defined in: react/components/types.ts:32
Inline styles for this widget — see the Styling guide.
Inherited from
Section titled “Inherited from”theme?
Section titled “theme?”
optionaltheme?:string
Defined in: react/components/types.ts:34
Re-theme this subtree; descendants resolve $tokens against it.