sard-uniapp/components/alert/README.md

sard-uniapp 是一套基于 Uniapp + Vue3 框架开发的兼容多端的 UI 组件库

---
title: Alert
subtitle: 警告提示
group: 反馈组件
version: 1.3+
---

## 介绍

突出显示要重点提示用户的信息。警告提示会一直显示，除非用户手动关闭。

## 引入

```js
import Alert from 'sard-uniapp/components/alert/alert.vue'
```

## 代码演示

### 基础使用

<<< @demo/alert/demo/Basic.vue

### 类型

使用 `type` 属性设置不同的类型。

<<< @demo/alert/demo/Type.vue

### 显示图标

设置 `show-icon` 属性显示图标。

<<< @demo/alert/demo/ShowIcon.vue

### 可关闭的

设置 `closable` 属性显示关闭按钮。

<<< @demo/alert/demo/Closable.vue

### 方形警告框 <sup>1.28+</sup>

警告框默认带有圆角，设置 `square` 可去掉其圆角。

<<< @demo/alert/demo/Closable.vue

## API

### AlertProps

| 属性                    | 描述             | 类型                                            | 默认值    |
| ----------------------- | ---------------- | ----------------------------------------------- | --------- |
| root-class              | 组件根元素类名   | string                                          | -         |
| root-style              | 组件根元素样式   | StyleValue                                      | -         |
| type                    | 警告提示样式类型 | 'primary' \| 'success' \| 'warning' \| 'danger' | 'primary' |
| show-icon               | 是否显示图标     | StyleValue                                      | -         |
| closable                | 是否显示关闭按钮 | boolean                                         | false     |
| color                   | 字体颜色         | string                                          | -         |
| background              | 背景颜色         | string                                          | -         |
| square <sup>1.28+</sup> | 方形警告框       | boolean                                         | false     |

### AlertSlots

| 插槽    | 描述           | 属性 |
| ------- | -------------- | ---- |
| default | 自定义默认内容 | -    |
| icon    | 自定义图标     | -    |

### AlertEmits

| 事件  | 描述             | 类型         |
| ----- | ---------------- | ------------ |
| close | 点击关闭按钮触发 | `() => void` |

## 主题定制

### CSS 变量

<<< @comp/alert/variables.scss#variables