API reference
components/data-list
Import
Section titled “Import”import * as api from "@fungi.computer/caps/components/data-list";Exports
Section titled “Exports”| Kind | Export | Description |
|---|---|---|
| type alias | DataListProps | Props accepted by DataList. |
| type alias | DataListHeadingProps | Props accepted by DataListHeading. |
| constant | DataList | A list wrapper for caller-provided rows. |
| constant | DataRow | A list row for a caller-provided label and value. |
| constant | DataListHeading | A quiet small-caps section label that groups the rows below it. |
DataListPropstype alias
Section titled “DataListProps”type DataListProps = HTMLAttributes<HTMLUListElement> & object;Props accepted by DataList.
Type Declaration
Section titled “Type Declaration”| Name | Type |
|---|---|
density? |
"regular" | "compact" |
DataListHeadingPropstype alias
Section titled “DataListHeadingProps”type DataListHeadingProps = HTMLAttributes<HTMLHeadingElement> & object;Props accepted by DataListHeading.
Type Declaration
Section titled “Type Declaration”| Name | Type | Description |
|---|---|---|
level? |
2 | 3 |
Heading level; the host keeps its document outline. |
aside? |
ReactNode |
Optional trailing count or status, such as a Badge. |
DataListconstant
Section titled “DataList”const DataList: ForwardRefExoticComponent< HTMLAttributes<HTMLUListElement> & object & RefAttributes<HTMLUListElement>>;A list wrapper for caller-provided rows.
DataRowconstant
Section titled “DataRow”const DataRow: ForwardRefExoticComponent< LiHTMLAttributes<HTMLLIElement> & RefAttributes<HTMLLIElement>>;A list row for a caller-provided label and value.
DataListHeadingconstant
Section titled “DataListHeading”const DataListHeading: ForwardRefExoticComponent< HTMLAttributes<HTMLHeadingElement> & object & RefAttributes<HTMLHeadingElement>>;A quiet small-caps section label that groups the rows below it.