List
Lists are a visual representation of a dataset, based on groups of related content, that is organized vertically.
install | yarn add @clayui/list |
---|---|
version | 3.123.0 |
Stable3.123.0View in LexiconCHANGELOG
List
Property | Description |
---|---|
children TLIAttributes | Array<TLIAttributes> | |
showQuickActionsOnHover boolean | The default value is true |
List.Header
Extends from React.HTMLAttributes<HTMLLIElement>
List.Item
Property | Description |
---|---|
action
| The default value is false |
active
| The default value is false |
disabled
| The default value is false |
flex
| The default value is false |
header
| The default value is false |
List.ItemField
Property | Description |
---|---|
containerElement | string
| React.JSXElementConstructor<{
className: string;
[key: string]: any;
}> | Element or component to render for container The default value is 'div' |
expand boolean | |
float literal | Provides the benefit of aligning content via flexbox without losing the behavior of floated elements at the expense of extra markup. |
gutters boolean | Applies the autofit-col-gutters class |
shrink boolean | Applies the autofit-col-shrink class. |
List.ItemText
Property | Description |
---|---|
subtext boolean | 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 | Description |
---|---|
href string | Value of path the item should link to. |
spritemap string | Path to icon spritemap. |
symbol string | Name of icon symbol |
ListWithItems
Property | Description |
---|---|
itemIdentifier string | 'id' | Property of item that makes it unique from other items.
Defaults to 'id'. The default value is 'id' |
items Array<IListItem> | Items to show in list. The default value is [] |
onSelectedItemsChange (map: IBooleanMap) => void | Callback for when selected items change. |
selectedItemsMap IBooleanMap | Map of items that are currently selected. The default value is {} |
spritemap string | Path to spritemap for icon symbol. |