Skip to main content

Function: List()

List(__namedParameters): Element

Defined in: components/List/List.tsx:98

A content list with real list semantics.

Entity = Structure. Use it wherever a set of items reads as a list: feature lists, summaries, key points. A Stack renders a <div>, so the same content announces as unrelated blocks; this announces as a list with a count.

For a list the user operates — selects from, reorders, acts on — use ListBox or GridList: those are Collection entities with keyboard navigation, and this is presentation.

Parameters

ParameterType
__namedParametersListProps

Returns

Element

Example

<List>
<ListItem>Unlimited projects</ListItem>
<ListItem>Priority support</ListItem>
</List>

<List variant="ordered" gap="md">
<ListItem>Install the CLI</ListItem>
<ListItem>Run `fsl init`</ListItem>
</List>