Examples
Props
SimpleList
| Name | Type | Default | Description |
|---|---|---|---|
| aria-label | string | aria-label for the <ul> element that wraps the SimpleList items. | |
| children | React.ReactNode | null | Content rendered inside the SimpleList |
| className | string | '' | Additional classes added to the SimpleList container |
| isControlled | boolean | true | Indicates whether component is controlled by its internal state |
| onSelect | ( ref: React.RefObject<HTMLButtonElement> | React.RefObject<HTMLAnchorElement>, props: SimpleListItemProps ) => void | Callback when an item is selected |
SimpleListGroup
| Name | Type | Default | Description |
|---|---|---|---|
| children | React.ReactNode | null | Content rendered inside the SimpleList group |
| className | string | '' | Additional classes added to the SimpleList <ul> |
| id | string | '' | ID of SimpleList group |
| title | React.ReactNode | '' | Title of the SimpleList group |
| titleClassName | string | '' | Additional classes added to the SimpleList group title |
SimpleListItem
| Name | Type | Default | Description |
|---|---|---|---|
| children | React.ReactNode | null | Content rendered inside the SimpleList item |
| className | string | '' | Additional classes added to the SimpleList <li> |
| component | 'button' | 'a' | 'button' | Component type of the SimpleList item |
| componentClassName | string | '' | Additional classes added to the SimpleList <a> or <button> |
| componentProps | any | Additional props added to the SimpleList <a> or <button> | |
| href | string | '' | Default hyperlink location |
| isActive | boolean | false | Indicates if the link is current/highlighted |
| itemId | number | string | id for the item. | |
| onClick | (event: React.MouseEvent | React.ChangeEvent) => void | () => {} | OnClick callback for the SimpleList item |
| type | 'button' | 'submit' | 'reset' | 'button' | Type of button SimpleList item |
CSS variables
| Expand or collapse column | Selector | Variable | Value |
|---|
View source on GitHub
