File size: 1,745 Bytes
1e92f2d |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 |
---
title: DataList
description: Used to display a list of similar data items.
links:
source: components/data-list
storybook: components-data-list--basic
recipe: data-list
---
<ExampleTabs name="data-list-basic" />
## Usage
```tsx
import { DataList } from "@chakra-ui/react"
```
```tsx
<DataList.Root>
{data.map((item) => (
<DataList.Item key={item.label}>
<DataList.ItemLabel>{item.label}</DataList.ItemLabel>
<DataList.ItemValue>{item.value}</DataList.ItemValue>
</DataList.Item>
))}
</DataList.Root>
```
:::info
If you prefer a closed component composition, check out the
[snippet below](#closed-component).
:::
## Examples
### Sizes
Use the `size` prop to change the size of the datalist component.
<ExampleTabs name="data-list-with-sizes" />
### Variants
Use the `variant` prop to change the variant of the datalist component.
> Added in `v3.1.x`
<ExampleTabs name="data-list-with-variants" />
### Orientation
Use the `orientation` prop to change the orientation of the datalist component.
<ExampleTabs name="data-list-vertical" />
### Info Tip
Render the `InfoTip` component within `DataList.Item` to provide additional
context to the datalist.
<ExampleTabs name="data-list-with-info" />
### Separator
Use the `divideY` prop on the `DataList.Root` to add a separator between items.
<ExampleTabs name="data-list-with-separator" />
### Closed Component
Here's how to setup the Data List for a closed component composition.
<ExampleCode name="data-list-closed-component" />
If you want to automatically add the closed component to your project, run the
command:
```bash
npx @chakra-ui/cli snippet add data-list
```
## Props
### Root
<PropTable component="DataList" part="Root" />
|