---
title: Skeleton
description: "`Skeleton`は、コンテンツが読み込まれるまでのプレースホルダーとして機能するコンポーネントです。"
links:
  - style: https://github.com/yamada-ui/yamada-ui/tree/main/packages/react/src/components/skeleton/skeleton.style.ts
  - source: https://github.com/yamada-ui/yamada-ui/tree/main/packages/react/src/components/skeleton
  - storybook: https://yamada-ui.github.io/yamada-ui?path=/story/components-skeleton--basic
---

```tsx
<VStack>
  <Skeleton />
  <SkeletonCircle />
  <SkeletonText />
</VStack>
```

## 使い方

```tsx
import { Skeleton, SkeletonCircle, SkeletonText } from "@yamada-ui/react"
```

```tsx
import { Skeleton, SkeletonCircle, SkeletonText } from "@/components/ui"
```

```tsx
import { Skeleton, SkeletonCircle, SkeletonText } from "@workspaces/ui"
```

```tsx
<Skeleton />
<SkeletonCircle />
<SkeletonText />
```

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

```tsx
<VStack>
  <HStack>
    <For each={["pulse", "shine"]}>
      {(variant) => (
        <VStack key={variant}>
          <SkeletonCircle variant={variant} />
          <SkeletonText variant={variant} lineClamp={2} />
          <Skeleton variant={variant} h="4xs" />
        </VStack>
      )}
    </For>
  </HStack>
</VStack>
```

### サイズを変更する

```tsx
<VStack>
  <HStack>
    <SkeletonCircle boxSize="14" />
    <SkeletonText h="6" lineClamp={2} />
  </HStack>
  <Skeleton h="20" />
</VStack>
```

また、子要素を設定することで、幅と高さを合わせることができます。

```tsx
<VStack lineHeight="1">
  <HStack>
    <Skeleton>
      <Badge>Badge</Badge>
    </Skeleton>

    <Skeleton loading={false}>
      <Badge>Badge</Badge>
    </Skeleton>
  </HStack>

  <HStack>
    <SkeletonCircle>
      <Avatar
        name="プリン"
        src="https://zukan.pokemon.co.jp/zukan-api/up/images/index/c8e0b40c9ec85d0218754642a64cc047.png"
      />
    </SkeletonCircle>

    <SkeletonCircle loading={false}>
      <Avatar
        name="プリン"
        src="https://zukan.pokemon.co.jp/zukan-api/up/images/index/c8e0b40c9ec85d0218754642a64cc047.png"
      />
    </SkeletonCircle>
  </HStack>
</VStack>
```

### カラーを変更する

カラーを変更する場合は、`startColor`と`endColor`に値を設定します。

```tsx
<VStack>
  <Skeleton variant="shine" startColor="pink.500" endColor="orange.500" />
  <SkeletonCircle variant="shine" startColor="pink.500" endColor="orange.500" />
  <SkeletonText variant="shine" startColor="pink.500" endColor="orange.500" />
</VStack>
```

### テキストの間隔を変更する

テキスト行間の間隔を変更する場合は、`gap`に値を設定します。

```tsx
<SkeletonText gap="md" />
```

### 行数を指定する

行数を指定する場合は、`lineClamp`に数値を設定します。

```tsx
<SkeletonText lineClamp={5} />
```

### 所要時間を変更する

所要時間を変更する場合は、`duration`に数値(秒)を設定します。

```tsx
<VStack>
  <Skeleton duration={1} />
  <SkeletonCircle duration={2} />
  <SkeletonText duration={2} />
</VStack>
```

### 子要素を表示する

子要素を表示する場合は、`loading`に`false`を渡します。

```tsx
const { loading } = useAsync(() => wait(3000))

return (
  <VStack>
    <HStack>
      <SkeletonCircle loading={loading}>
        <Avatar
          name="プリン"
          src="https://zukan.pokemon.co.jp/zukan-api/up/images/index/c8e0b40c9ec85d0218754642a64cc047.png"
          size="xl"
        />
      </SkeletonCircle>

      <SkeletonText
        lineClamp={2}
        loading={loading}
        _loading={{ h: "5" }}
        lineHeight="moderate"
      >
        <Text fontWeight="bold" lineClamp={1}>
          プリン
        </Text>
        <Text lineClamp={1}>
          つぶらな 瞳が 揺れるとき 眠たくなるような 不思議で 気持ちの良い 歌を
          歌う。
        </Text>
      </SkeletonText>
    </HStack>
  </VStack>
)
```

### フェードインの所要時間を変更する

フェードインの所要時間を変更する場合は、`fadeDuration`に数値(秒)を設定します。

```tsx
const { loading } = useAsync(() => wait(3000))

return (
  <VStack>
    <HStack>
      <SkeletonCircle fadeDuration={2} loading={loading}>
        <Avatar
          name="プリン"
          src="https://zukan.pokemon.co.jp/zukan-api/up/images/index/c8e0b40c9ec85d0218754642a64cc047.png"
          size="xl"
        />
      </SkeletonCircle>

      <SkeletonText
        fadeDuration={2}
        lineClamp={2}
        loading={loading}
        _loading={{ h: "5" }}
        lineHeight="moderate"
      >
        <Text fontWeight="bold" lineClamp={1}>
          プリン
        </Text>
        <Text lineClamp={1}>
          つぶらな 瞳が 揺れるとき 眠たくなるような 不思議で 気持ちの良い 歌を
          歌う。
        </Text>
      </SkeletonText>
    </HStack>
  </VStack>
)
```

## Props

### Skeleton

| 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.                                                                          |
| `variant`      | `"pulse"` | `"none" \| "pulse" \| "shine"`                                                                                                                                    | The variant of the component.                                                                        |
| `duration`     | -         | `number \| string`                                                                                                                                                | The animation duration in seconds.                                                                   |
| `endColor`     | -         | `"-moz-initial" \| "ActiveBorder" \| "ActiveCaption" \| "aliceblue" \| "amber.100" \| "amber.200" \| "amber.300" \| "amber.400" \| "amber.50" \| "amber.500" ...` | The color at the animation end.                                                                      |
| `fadeDuration` | -         | `number \| string`                                                                                                                                                | The fade in duration in seconds. Requires `loaded` toggled to `true` in order to see the transition. |
| `fitContent`   | `false`   | `boolean`                                                                                                                                                         | If `true`, the skeleton will take the width of it's children.                                        |
| `loading`      | `true`    | `boolean`                                                                                                                                                         | If `false`, it'll render its children with a nice fade transition.                                   |
| `startColor`   | -         | `"-moz-initial" \| "ActiveBorder" \| "ActiveCaption" \| "aliceblue" \| "amber.100" \| "amber.200" \| "amber.300" \| "amber.400" \| "amber.50" \| "amber.500" ...` | The color at the animation start.                                                                    |

### SkeletonCircle

| 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.                                                                          |
| `variant`      | -       | `"none" \| "pulse" \| "shine"`                                                                                                                                    | The variant of the component.                                                                        |
| `duration`     | -       | `number \| string`                                                                                                                                                | The animation duration in seconds.                                                                   |
| `endColor`     | -       | `"-moz-initial" \| "ActiveBorder" \| "ActiveCaption" \| "aliceblue" \| "amber.100" \| "amber.200" \| "amber.300" \| "amber.400" \| "amber.50" \| "amber.500" ...` | The color at the animation end.                                                                      |
| `fadeDuration` | -       | `number \| string`                                                                                                                                                | The fade in duration in seconds. Requires `loaded` toggled to `true` in order to see the transition. |
| `fitContent`   | `false` | `boolean`                                                                                                                                                         | If `true`, the skeleton will take the width of it's children.                                        |
| `loading`      | `true`  | `boolean`                                                                                                                                                         | If `false`, it'll render its children with a nice fade transition.                                   |
| `startColor`   | -       | `"-moz-initial" \| "ActiveBorder" \| "ActiveCaption" \| "aliceblue" \| "amber.100" \| "amber.200" \| "amber.300" \| "amber.400" \| "amber.50" \| "amber.500" ...` | The color at the animation start.                                                                    |

### SkeletonText

| 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.                                                                          |
| `variant`      | -       | `"none" \| "pulse" \| "shine"`                                                                                                                                    | The variant of the component.                                                                        |
| `duration`     | -       | `string \| number`                                                                                                                                                | The animation duration in seconds.                                                                   |
| `endColor`     | -       | `"-moz-initial" \| "ActiveBorder" \| "ActiveCaption" \| "aliceblue" \| "amber.100" \| "amber.200" \| "amber.300" \| "amber.400" \| "amber.50" \| "amber.500" ...` | The color at the animation end.                                                                      |
| `fadeDuration` | -       | `string \| number`                                                                                                                                                | The fade in duration in seconds. Requires `loaded` toggled to `true` in order to see the transition. |
| `fitContent`   | `false` | `boolean`                                                                                                                                                         | If `true`, the skeleton will take the width of it's children.                                        |
| `lineClamp`    | -       | `number`                                                                                                                                                          | The number of lines to display.                                                                      |
| `loading`      | `true`  | `boolean`                                                                                                                                                         | If `false`, it'll render its children with a nice fade transition.                                   |
| `rootProps`    | -       | `HTMLStyledProps`                                                                                                                                                 | Props for the root element.                                                                          |
| `startColor`   | -       | `"-moz-initial" \| "ActiveBorder" \| "ActiveCaption" \| "aliceblue" \| "amber.100" \| "amber.200" \| "amber.300" \| "amber.400" \| "amber.50" \| "amber.500" ...` | The color at the animation start.                                                                    |