> Leaf UI 0.17.3 · Package: @ifhover/leaf-ui · Source: c3221834f84f2f48481a2054026b713456f8e5dc
> Browser documentation: https://ifhover.github.io/leaf-ui/components/alert.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.

# Alert 警告提示

在页面中提示操作结果或需要关注的信息。


## 基础用法

使用 `title` 设置提示内容，`description` 补充说明。


有新的版本可用

刷新页面后即可使用最新版本。

basic.tsx

复制代码

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

export function AlertBasic() {
  return <Alert title="有新的版本可用" description="刷新页面后即可使用最新版本。" />;
}
```

展开代码


## 示例

### 提示类型

通过 `type` 区分信息、成功、警告和危险提示。新代码使用 `danger`；`error` 仅作为兼容别名保留。


信息

有新的版本可用

成功

项目已保存

警告

存储空间即将用完

危险

保存失败，请稍后重试

types.tsx

复制代码

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

export function AlertTypes() {
  return (
    <Flex direction="column" gap="lg">
      <Flex direction="column" gap="sm">
        <Text tone="muted">信息</Text>
        <Alert type="info" title="有新的版本可用" />
      </Flex>
      <Flex direction="column" gap="sm">
        <Text tone="muted">成功</Text>
        <Alert type="success" title="项目已保存" />
      </Flex>
      <Flex direction="column" gap="sm">
        <Text tone="muted">警告</Text>
        <Alert type="warning" title="存储空间即将用完" />
      </Flex>
      <Flex direction="column" gap="sm">
        <Text tone="muted">危险</Text>
        <Alert type="danger" title="保存失败，请稍后重试" />
      </Flex>
    </Flex>
  );
}
```

展开代码

### 右侧内容

通过 `extra` 在右侧放置按钮、链接等元素，可与关闭按钮同时使用；内容显示在关闭按钮之前。


草稿已自动保存

查看详情

extra.tsx

复制代码

```tsx lineNumbers file="../../src/examples/alert/extra.tsx"
import { Alert, Button } from '@ifhover/leaf-ui';
import { useState } from 'react';

export function AlertExtra() {
  const [showDetails, setShowDetails] = useState(false);

  return (
    <Alert
      title="草稿已自动保存"
      description={showDetails ? '重新打开页面时可以继续编辑。' : undefined}
      extra={
        <Button variant="link" onClick={() => setShowDetails((value) => !value)}>
          {showDetails ? '收起详情' : '查看详情'}
        </Button>
      }
      closable
    />
  );
}
```

展开代码

### 可关闭提示

设置 `closable` 显示关闭按钮。关闭后需重新挂载才能再次显示，本例通过改变 `key` 实现。


草稿已自动保存

重新显示

closable.tsx

复制代码

```tsx lineNumbers file="../../src/examples/alert/closable.tsx"
import { Alert, Button, Flex } from '@ifhover/leaf-ui';
import { useState } from 'react';

export function AlertClosable() {
  const [version, setVersion] = useState(0);

  return (
    <Flex direction="column" gap="md">
      <Alert key={version} title="草稿已自动保存" closable />
      <Flex>
        <Button onClick={() => setVersion((value) => value + 1)}>重新显示</Button>
      </Flex>
    </Flex>
  );
}
```

展开代码

### 图标

使用 `icon` 替换图标，或设置 `showIcon={false}` 隐藏图标。


自定义图标

访问权限已更新

隐藏图标

访问权限已更新

icons.tsx

复制代码

```tsx lineNumbers file="../../src/examples/alert/icons.tsx"
import { Alert, Flex, Text } from '@ifhover/leaf-ui';
import { ShieldCheck } from 'lucide-react';

export function AlertIcons() {
  return (
    <Flex direction="column" gap="lg">
      <Flex direction="column" gap="sm">
        <Text tone="muted">自定义图标</Text>
        <Alert type="success" title="访问权限已更新" icon={<ShieldCheck size={20} />} />
      </Flex>
      <Flex direction="column" gap="sm">
        <Text tone="muted">隐藏图标</Text>
        <Alert type="success" title="访问权限已更新" showIcon={false} />
      </Flex>
    </Flex>
  );
}
```

展开代码


## API

### Alert API

提示内容、反馈类型与关闭行为的配置。

| 属性            | 类型                        | 默认值      | 说明                 |
| ------------- | ------------------------- | -------- | ------------------ |
| `title`       | `ReactNode`               | 必填       | 提示内容               |
| `description` | `ReactNode`               | —        | 补充说明               |
| `extra`       | `ReactNode`               | —        | 尾部的补充内容。           |
| `type`        | `FeedbackType \| 'error'` | `'info'` | 提示类型；`error` 为兼容别名 |
| `icon`        | `ReactNode`               | —        | 图标内容。              |
| `showIcon`    | `boolean`                 | `true`   | 展示语义图标             |
| `closable`    | `boolean`                 | `false`  | 允许关闭当前提示           |
| `onClose`     | `() => void`              | —        | 点击关闭按钮时触发。         |
