List
yarn add @clayui/list
Lists are a visual representation of a dataset, based on groups of related content, that is organized vertically.
Stable3.4.5View in LexiconCHANGELOG
List
| Property | Type | Required | Default | Description |
|---|---|---|---|---|
children | TLIAttributes | Array<TLIAttributes> | false | ||
showQuickActionsOnHover | boolean | false | true |
List.Header
Extends from React.HTMLAttributes<HTMLLIElement>List.Item
| Property | Type | Required | Default | Description |
|---|---|---|---|---|
action | false | false | ||
active | false | false | ||
disabled | false | false | ||
flex | false | false | ||
header | false | false |
List.ItemField
[APITable "clay-list/src/ItemField.tsx"]
List.ItemText
| Property | Type | Required | Default | Description |
|---|---|---|---|---|
subtext | boolean | false | Flag to indicate if content should be styled as subtext. |
List.ItemTitle
Extends from React.HTMLAttributes<HTMLHeadingElement>List.QuickActionMenu
Extends from React.HTMLAttributes<HTMLDivElement>List.QuickActionMenu.Item
| Property | Type | Required | Default | Description |
|---|---|---|---|---|
href | string | false | Value of path the item should link to. | |
spritemap | string | false | Path to icon spritemap. | |
symbol | string | true | Name of icon symbol |
ListWithItems
| Property | Type | Required | Default | Description |
|---|---|---|---|---|
itemIdentifier | string | 'id' | false | 'id' | Property of item that makes it unique from other items. Defaults to 'id'. |
items | Array<IListItem> | false | [] | Items to show in list. |
onSelectedItemsChange | (map: IBooleanMap) => void | false | Callback for when selected items change. | |
selectedItemsMap | IBooleanMap | false | {} | Map of items that are currently selected. |
spritemap | string | false | Path to spritemap for icon symbol. |