> Leaf UI 0.17.3 · Package: @ifhover/leaf-ui · Source: c3221834f84f2f48481a2054026b713456f8e5dc
> Browser documentation: https://ifhover.github.io/leaf-ui/components/skeleton.html

> For AI agents: the complete documentation index is available at https://ifhover.github.io/leaf-ui/llms.txt, the full documentation bundle is available at https://ifhover.github.io/leaf-ui/llms-full.txt.

# Skeleton 骨架屏

在内容加载时展示结构占位。


## 基础用法

在内容加载期间显示默认骨架占位。


basic.tsx

复制代码

```tsx lineNumbers file="../../src/examples/skeleton/basic.tsx"
import { Skeleton } from '@ifhover/leaf-ui';

export function SkeletonBasic() {
  return <Skeleton />;
}
```

展开代码


## 示例

### 展示加载结果

由应用维护 `loading`。加载期间不渲染 `children`，设为 `false` 后才显示内容。若需要保留原内容的挂载状态，请使用 [Loading 加载](https://ifhover.github.io/leaf-ui/components/loading.md)。


显示内容

content.tsx

复制代码

```tsx lineNumbers file="../../src/examples/skeleton/content.tsx"
import { Button, Flex, Skeleton, Text } from '@ifhover/leaf-ui';
import { useState } from 'react';

export function SkeletonContent() {
  const [loading, setLoading] = useState(true);

  return (
    <Flex direction="column" gap="md">
      <Flex>
        <Button onClick={() => setLoading((value) => !value)}>
          {loading ? '显示内容' : '显示占位'}
        </Button>
      </Flex>
      <Skeleton loading={loading}>
        <Text>项目内容已加载完成。</Text>
      </Skeleton>
    </Flex>
  );
}
```

展开代码

### 头像与圆角

使用 `avatar` 增加头像占位。`round` 只改变标题和正文条目的圆角，不影响头像。


默认条目

圆角条目

shapes.tsx

复制代码

```tsx lineNumbers file="../../src/examples/skeleton/shapes.tsx"
import { Flex, Skeleton, Text } from '@ifhover/leaf-ui';

export function SkeletonShapes() {
  return (
    <Flex direction="column" gap="lg">
      <Flex direction="column" gap="sm">
        <Text tone="muted">默认条目</Text>
        <Skeleton avatar />
      </Flex>
      <Flex direction="column" gap="sm">
        <Text tone="muted">圆角条目</Text>
        <Skeleton avatar round />
      </Flex>
    </Flex>
  );
}
```

展开代码

### 行数与宽度

通过 `rows` 设置正文行数，`rowWidths` 设置各行宽度；未指定的行保留默认宽度。


rows.tsx

复制代码

```tsx lineNumbers file="../../src/examples/skeleton/rows.tsx"
import { Skeleton } from '@ifhover/leaf-ui';

export function SkeletonRows() {
  return <Skeleton rows={4} rowWidths={['100%', '80%', '90%', '60%']} />;
}
```

展开代码


## API

### Skeleton API

配置加载占位的行数、形状和动画。

| 属性           | 类型                              | 默认值     | 说明                        |
| ------------ | ------------------------------- | ------- | ------------------------- |
| `loading`    | `boolean`                       | `true`  | 展示占位；false 时才渲染 children。 |
| `active`     | `boolean`                       | `true`  | 启用占位动画。                   |
| `avatar`     | `boolean`                       | `false` | 展示头像占位。                   |
| `title`      | `boolean`                       | `true`  | 标题占位                      |
| `titleWidth` | `number \| string`              | `'38%'` | 标题宽度                      |
| `rows`       | `number`                        | `3`     | 正文行数，最多 20 行              |
| `rowWidths`  | `readonly (number \| string)[]` | —       | 各行宽度                      |
| `round`      | `boolean`                       | `false` | 标题和正文占位使用胶囊圆角，不影响头像。      |
| `children`   | `ReactNode`                     | —       | 加载完成后展示的内容。               |
