---
title: DataList
description: "`DataList`は、データ項目のリストを表示するために使用されます。"
links:
  - style: https://github.com/yamada-ui/yamada-ui/tree/main/packages/react/src/components/data-list/data-list.style.ts
  - source: https://github.com/yamada-ui/yamada-ui/tree/main/packages/react/src/components/data-list
  - storybook: https://yamada-ui.github.io/yamada-ui?path=/story/components-datalist--basic
---

```tsx
<DataList.Root>
  <DataList.Item>
    <DataList.Term>白石うらら</DataList.Term>
    <DataList.Description>入れ替わりの魔女</DataList.Description>
  </DataList.Item>

  <DataList.Item>
    <DataList.Term>小田切寧々</DataList.Term>
    <DataList.Description>虜の魔女</DataList.Description>
  </DataList.Item>

  <DataList.Item>
    <DataList.Term>大塚芽子</DataList.Term>
    <DataList.Description>思念（テレパシー）の魔女</DataList.Description>
  </DataList.Item>

  <DataList.Item>
    <DataList.Term>猿島マリア</DataList.Term>
    <DataList.Description>未来視の魔女</DataList.Description>
  </DataList.Item>

  <DataList.Item>
    <DataList.Term>滝川ノア</DataList.Term>
    <DataList.Description>過去視の魔女</DataList.Description>
  </DataList.Item>

  <DataList.Item>
    <DataList.Term>飛鳥美琴</DataList.Term>
    <DataList.Description>透明の魔女</DataList.Description>
  </DataList.Item>

  <DataList.Item>
    <DataList.Term>西園寺リカ</DataList.Term>
    <DataList.Description>記憶操作の魔女</DataList.Description>
  </DataList.Item>
</DataList.Root>
```

## 使い方

```tsx
import { DataList } from "@yamada-ui/react"
```

```tsx
import { DataList } from "@/components/ui"
```

```tsx
import { DataList } from "@workspaces/ui"
```

```tsx
<DataList.Root>
  <DataList.Item>
    <DataList.Term />
    <DataList.Description />
  </DataList.Item>
</DataList.Root>
```

### itemsを使う

```tsx
const items = useMemo<DataList.Item[]>(
  () => [
    { description: "入れ替わりの魔女", term: "白石うらら" },
    { description: "虜の魔女", term: "小田切寧々" },
    { description: "思念（テレパシー）の魔女", term: "大塚芽子" },
    { description: "未来視の魔女", term: "猿島マリア" },
    { description: "過去視の魔女", term: "滝川ノア" },
    { description: "透明の魔女", term: "飛鳥美琴" },
    { description: "記憶操作の魔女", term: "西園寺リカ" },
  ],
  [],
)

return <DataList.Root items={items} />
```

### バリアントを変更する

```tsx
const items = useMemo<DataList.Item[]>(
  () => [
    { description: "入れ替わりの魔女", term: "白石うらら" },
    { description: "虜の魔女", term: "小田切寧々" },
    { description: "思念（テレパシー）の魔女", term: "大塚芽子" },
    { description: "未来視の魔女", term: "猿島マリア" },
    { description: "過去視の魔女", term: "滝川ノア" },
    { description: "透明の魔女", term: "飛鳥美琴" },
    { description: "記憶操作の魔女", term: "西園寺リカ" },
  ],
  [],
)

return (
  <VStack alignItems="start" separator={<Separator />}>
    <DataList.Root variant="subtle" items={items} />

    <DataList.Root variant="bold" items={items} />

    <DataList.Root variant="grid" items={items} />
  </VStack>
)
```

### サイズを変更する

```tsx
const items = useMemo<DataList.Item[]>(
  () => [
    { description: "入れ替わりの魔女", term: "白石うらら" },
    { description: "虜の魔女", term: "小田切寧々" },
    { description: "思念（テレパシー）の魔女", term: "大塚芽子" },
    { description: "未来視の魔女", term: "猿島マリア" },
    { description: "過去視の魔女", term: "滝川ノア" },
    { description: "透明の魔女", term: "飛鳥美琴" },
    { description: "記憶操作の魔女", term: "西園寺リカ" },
  ],
  [],
)

return (
  <VStack alignItems="start" separator={<Separator />}>
    <DataList.Root size="sm" items={items} />

    <DataList.Root size="md" items={items} />

    <DataList.Root size="lg" items={items} />
  </VStack>
)
```

### 方向を変更する

方向を変更する場合は、`orientation`に`"horizontal"`または`"vertical"`を設定します。デフォルトでは、`"horizontal"`が設定されています。

```tsx
const items = useMemo<DataList.Item[]>(
  () => [
    { description: "入れ替わりの魔女", term: "白石うらら" },
    { description: "虜の魔女", term: "小田切寧々" },
    { description: "思念（テレパシー）の魔女", term: "大塚芽子" },
    { description: "未来視の魔女", term: "猿島マリア" },
    { description: "過去視の魔女", term: "滝川ノア" },
    { description: "透明の魔女", term: "飛鳥美琴" },
    { description: "記憶操作の魔女", term: "西園寺リカ" },
  ],
  [],
)

return (
  <VStack alignItems="start" separator={<Separator />}>
    <DataList.Root items={items} orientation="horizontal" />

    <DataList.Root items={items} orientation="vertical" />
  </VStack>
)
```

### 複数の用語を表示する

複数の用語を表示する場合は、`term`に配列を設定します。

```tsx
const items = useMemo<DataList.Item[]>(
  () => [
    { description: "入れ替わりの魔女", term: ["白石うらら", "清集院桃子"] },
    { description: "虜の魔女", term: ["小田切寧々", "紺野つばさ"] },
    {
      description: "思念（テレパシー）の魔女",
      term: ["大塚芽子", "萌黄ことり"],
    },
    { description: "未来視の魔女", term: ["猿島マリア", "筑紫愛子"] },
    { description: "過去視の魔女", term: ["滝川ノア", "姫川そら"] },
    { description: "透明の魔女", term: ["飛鳥美琴", "菊池アカネ"] },
    { description: "記憶操作の魔女", term: ["西園寺リカ", "虹野晴子"] },
  ],
  [],
)

return <DataList.Root w="fit-content" items={items} />
```

```tsx
<DataList.Root w="fit-content" orientation="vertical">
  <DataList.Item>
    <DataList.Term>白石うらら</DataList.Term>
    <DataList.Term>清集院桃子</DataList.Term>
    <DataList.Description>入れ替わりの魔女</DataList.Description>
  </DataList.Item>

  <DataList.Item>
    <DataList.Term>小田切寧々</DataList.Term>
    <DataList.Term>紺野つばさ</DataList.Term>
    <DataList.Description>虜の魔女</DataList.Description>
  </DataList.Item>

  <DataList.Item>
    <DataList.Term>大塚芽子</DataList.Term>
    <DataList.Term>萌黄ことり</DataList.Term>
    <DataList.Description>思念（テレパシー）の魔女</DataList.Description>
  </DataList.Item>

  <DataList.Item>
    <DataList.Term>猿島マリア</DataList.Term>
    <DataList.Term>筑紫愛子</DataList.Term>
    <DataList.Description>未来視の魔女</DataList.Description>
  </DataList.Item>

  <DataList.Item>
    <DataList.Term>滝川ノア</DataList.Term>
    <DataList.Term>姫川そら</DataList.Term>
    <DataList.Description>過去視の魔女</DataList.Description>
  </DataList.Item>

  <DataList.Item>
    <DataList.Term>飛鳥美琴</DataList.Term>
    <DataList.Term>菊池アカネ</DataList.Term>
    <DataList.Description>透明の魔女</DataList.Description>
  </DataList.Item>

  <DataList.Item>
    <DataList.Term>西園寺リカ</DataList.Term>
    <DataList.Term>虹野晴子</DataList.Term>
    <DataList.Description>記憶操作の魔女</DataList.Description>
  </DataList.Item>
</DataList.Root>
```

### 複数の説明を表示する

複数の説明を表示する場合は、`description`に配列を設定します。

```tsx
const items = useMemo<DataList.Item[]>(
  () => [
    {
      description: ["入れ替わりの魔女", "絶望的味覚音痴"],
      term: "白石うらら",
    },
    { description: ["虜の魔女", "得意教科は自称全教科"], term: "小田切寧々" },
    {
      description: ["思念（テレパシー）の魔女", "若干腐女子の気がある"],
      term: "大塚芽子",
    },
    {
      description: ["未来視の魔女", "服のセンスが独特な弟がいる"],
      term: "猿島マリア",
    },
    {
      description: ["過去視の魔女", "数々の問題を起こしている"],
      term: "滝川ノア",
    },
    { description: ["透明の魔女", "サディストの気がある"], term: "飛鳥美琴" },
    {
      description: ["記憶操作の魔女", "学校でもノーパンで過ごしている"],
      term: "西園寺リカ",
    },
  ],
  [],
)

return <DataList.Root w="fit-content" items={items} />
```

```tsx
<DataList.Root w="fit-content" orientation="vertical">
  <DataList.Item>
    <DataList.Term>白石うらら</DataList.Term>
    <DataList.Description>入れ替わりの魔女</DataList.Description>
    <DataList.Description>絶望的味覚音痴</DataList.Description>
  </DataList.Item>

  <DataList.Item>
    <DataList.Term>小田切寧々</DataList.Term>
    <DataList.Description>虜の魔女</DataList.Description>
    <DataList.Description>得意教科は自称全教科</DataList.Description>
  </DataList.Item>

  <DataList.Item>
    <DataList.Term>大塚芽子</DataList.Term>
    <DataList.Description>思念（テレパシー）の魔女</DataList.Description>
    <DataList.Description>若干腐女子の気がある</DataList.Description>
  </DataList.Item>

  <DataList.Item>
    <DataList.Term>猿島マリア</DataList.Term>
    <DataList.Description>未来視の魔女</DataList.Description>
    <DataList.Description>服のセンスが独特な弟がいる</DataList.Description>
  </DataList.Item>

  <DataList.Item>
    <DataList.Term>滝川ノア</DataList.Term>
    <DataList.Description>過去視の魔女</DataList.Description>
    <DataList.Description>数々の問題を起こしている</DataList.Description>
  </DataList.Item>

  <DataList.Item>
    <DataList.Term>飛鳥美琴</DataList.Term>
    <DataList.Description>透明の魔女</DataList.Description>
    <DataList.Description>サディストの気がある</DataList.Description>
  </DataList.Item>

  <DataList.Item>
    <DataList.Term>西園寺リカ</DataList.Term>
    <DataList.Description>記憶操作の魔女</DataList.Description>
    <DataList.Description>学校でもノーパンで過ごしている</DataList.Description>
  </DataList.Item>
</DataList.Root>
```

### 用語をカスタマイズする

```tsx
const items = useMemo<DataList.Item[]>(
  () => [
    {
      description: "入れ替わりの魔女",
      term: "白石うらら",
      termProps: { color: "blue" },
    },
    { description: "虜の魔女", term: "小田切寧々" },
    { description: "思念（テレパシー）の魔女", term: "大塚芽子" },
    { description: "未来視の魔女", term: "猿島マリア" },
    { description: "過去視の魔女", term: "滝川ノア" },
    { description: "透明の魔女", term: "飛鳥美琴" },
    { description: "記憶操作の魔女", term: "西園寺リカ" },
  ],
  [],
)

return (
  <DataList.Root
    w="fit-content"
    items={items}
    termProps={{ textDecoration: "line-through" }}
  />
)
```

```tsx
<DataList.Root w="fit-content">
  <DataList.Item>
    <DataList.Term color="blue">白石うらら</DataList.Term>
    <DataList.Description>入れ替わりの魔女</DataList.Description>
  </DataList.Item>

  <DataList.Item>
    <DataList.Term>小田切寧々</DataList.Term>
    <DataList.Description>虜の魔女</DataList.Description>
  </DataList.Item>

  <DataList.Item>
    <DataList.Term>大塚芽子</DataList.Term>
    <DataList.Description>思念（テレパシー）の魔女</DataList.Description>
  </DataList.Item>

  <DataList.Item>
    <DataList.Term>猿島マリア</DataList.Term>
    <DataList.Description>未来視の魔女</DataList.Description>
  </DataList.Item>

  <DataList.Item>
    <DataList.Term>滝川ノア</DataList.Term>
    <DataList.Description>過去視の魔女</DataList.Description>
  </DataList.Item>

  <DataList.Item>
    <DataList.Term>飛鳥美琴</DataList.Term>
    <DataList.Description>透明の魔女</DataList.Description>
  </DataList.Item>

  <DataList.Item>
    <DataList.Term>西園寺リカ</DataList.Term>
    <DataList.Description>記憶操作の魔女</DataList.Description>
  </DataList.Item>
</DataList.Root>
```

### 説明をカスタマイズする

```tsx
const items = useMemo<DataList.Item[]>(
  () => [
    {
      description: "入れ替わりの魔女",
      term: "白石うらら",
      descriptionProps: { color: "blue" },
    },
    { description: "虜の魔女", term: "小田切寧々" },
    { description: "思念（テレパシー）の魔女", term: "大塚芽子" },
    { description: "未来視の魔女", term: "猿島マリア" },
    { description: "過去視の魔女", term: "滝川ノア" },
    { description: "透明の魔女", term: "飛鳥美琴" },
    { description: "記憶操作の魔女", term: "西園寺リカ" },
  ],
  [],
)

return (
  <DataList.Root
    w="fit-content"
    items={items}
    descriptionProps={{ textDecoration: "line-through" }}
  />
)
```

```tsx
<DataList.Root w="fit-content">
  <DataList.Item>
    <DataList.Term>白石うらら</DataList.Term>
    <DataList.Description color="blue">入れ替わりの魔女</DataList.Description>
  </DataList.Item>

  <DataList.Item>
    <DataList.Term>小田切寧々</DataList.Term>
    <DataList.Description>虜の魔女</DataList.Description>
  </DataList.Item>

  <DataList.Item>
    <DataList.Term>大塚芽子</DataList.Term>
    <DataList.Description>思念（テレパシー）の魔女</DataList.Description>
  </DataList.Item>

  <DataList.Item>
    <DataList.Term>猿島マリア</DataList.Term>
    <DataList.Description>未来視の魔女</DataList.Description>
  </DataList.Item>

  <DataList.Item>
    <DataList.Term>滝川ノア</DataList.Term>
    <DataList.Description>過去視の魔女</DataList.Description>
  </DataList.Item>

  <DataList.Item>
    <DataList.Term>飛鳥美琴</DataList.Term>
    <DataList.Description>透明の魔女</DataList.Description>
  </DataList.Item>

  <DataList.Item>
    <DataList.Term>西園寺リカ</DataList.Term>
    <DataList.Description>記憶操作の魔女</DataList.Description>
  </DataList.Item>
</DataList.Root>
```

## Props

### DataList.Root

| Prop               | Default        | Type                                                                                                                      | Description                                        |
| ------------------ | -------------- | ------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------- |
| `as`               | -              | `As`                                                                                                                      | The HTML element to render.                        |
| `asChild`          | -              | `boolean`                                                                                                                 | Merges its props onto its immediate child.         |
| `css`              | -              | `CSSObject \| CSSObject[]`                                                                                                | The CSS object.                                    |
| `colorScheme`      | -              | `"amber" \| "black" \| "blackAlpha" \| "blue" \| "cyan" \| "danger" \| "emerald" \| "error" \| "flashy" \| "fuchsia" ...` | Set color scheme variables.                        |
| `size`             | `"md"`         | `"lg" \| "md" \| "sm"`                                                                                                    | The size of the component.                         |
| `variant`          | `"subtle"`     | `"bold" \| "grid" \| "subtle"`                                                                                            | The variant of the component.                      |
| `descriptionProps` | -              | `DataListDescriptionProps`                                                                                                | The props for the data list description component. |
| `items`            | -              | `DataListItemProps[]`                                                                                                     | If provided, generate elements based on items.     |
| `orientation`      | `"horizontal"` | `"horizontal" \| "vertical"`                                                                                              | The orientation of the data list.                  |
| `termProps`        | -              | `DataListTermProps`                                                                                                       | The props for the data list term component.        |

### DataList.Description

| Prop          | Default | Type                                                                                                                      | Description                                |
| ------------- | ------- | ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------ |
| `as`          | -       | `As`                                                                                                                      | The HTML element to render.                |
| `asChild`     | -       | `boolean`                                                                                                                 | Merges its props onto its immediate child. |
| `css`         | -       | `CSSObject \| CSSObject[]`                                                                                                | The CSS object.                            |
| `colorScheme` | -       | `"amber" \| "black" \| "blackAlpha" \| "blue" \| "cyan" \| "danger" \| "emerald" \| "error" \| "flashy" \| "fuchsia" ...` | Set color scheme variables.                |

### DataList.Item

| Prop               | Default | Type                                                                                                                      | Description                                        |
| ------------------ | ------- | ------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------- |
| `as`               | -       | `As`                                                                                                                      | The HTML element to render.                        |
| `asChild`          | -       | `boolean`                                                                                                                 | Merges its props onto its immediate child.         |
| `css`              | -       | `CSSObject \| CSSObject[]`                                                                                                | The CSS object.                                    |
| `colorScheme`      | -       | `"amber" \| "black" \| "blackAlpha" \| "blue" \| "cyan" \| "danger" \| "emerald" \| "error" \| "flashy" \| "fuchsia" ...` | Set color scheme variables.                        |
| `description`      | -       | `ReactNode \| ReactNode[]`                                                                                                | The data list description to use.                  |
| `descriptionProps` | -       | `DataListDescriptionProps`                                                                                                | The props for the data list description component. |
| `term`             | -       | `ReactNode \| ReactNode[]`                                                                                                | The data list term to use.                         |
| `termProps`        | -       | `DataListTermProps`                                                                                                       | The props for the data list term component.        |

### DataList.Term

| Prop          | Default | Type                                                                                                                      | Description                                |
| ------------- | ------- | ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------ |
| `as`          | -       | `As`                                                                                                                      | The HTML element to render.                |
| `asChild`     | -       | `boolean`                                                                                                                 | Merges its props onto its immediate child. |
| `css`         | -       | `CSSObject \| CSSObject[]`                                                                                                | The CSS object.                            |
| `colorScheme` | -       | `"amber" \| "black" \| "blackAlpha" \| "blue" \| "cyan" \| "danger" \| "emerald" \| "error" \| "flashy" \| "fuchsia" ...` | Set color scheme variables.                |