Function List

You can use the component prop to change the underlying DOM elements and neutralize default HTML list semantics. Use this for standalone ListItemButtons that should not be announced as lists by screen readers. See the List Examples Story for an example.

Accessibility

Warning! Be very careful when using interactive ListItemButtons. Never put other interactive elements such as <Button>, <Radio>, <Checkbox>, <Link> inside a ListItemButton. It is invalid HTML and won't work correctly with keyboard or screen readers!
Refer to the different Stories for examples on how to create complex or interactive list items.

List(props): ReactNode
Parameters
- props: Omit<ListProps, "ref"> & RefAttributes<HTMLUListElement>
Returns ReactNode
- Defined in @sj-ab/component-library.ui.list/dist/List.d.ts:22

Index

Properties

$$typeof defaultProps? displayName? propTypes?

Properties

`Readonly`$$typeof

$$typeof: symbol

`Optional`defaultProps

defaultProps?: Partial<Omit<ListProps, "ref"> & RefAttributes<HTMLUListElement>>

Deprecated

Use values for destructuring assignments instead.

`Optional`displayName

displayName?: string

Used in debugging messages. You might want to set it explicitly if you want to display a different name for debugging purposes.

See

Legacy React Docs

`Optional`propTypes

propTypes?: WeakValidationMap<Omit<ListProps, "ref"> & RefAttributes<HTMLUListElement>>