79 lines
2.1 KiB
Markdown
79 lines
2.1 KiB
Markdown
---
|
||
title: Toast 轻提示
|
||
description: 用于轻量级反馈或提示，不会打断用户操作。
|
||
spline: message
|
||
isComponent: true
|
||
---
|
||
|
||
|
||
## 引入
|
||
|
||
可在 `main.ts` 或在需要使用的页面或组件中引入。
|
||
|
||
```js
|
||
import TToast from '@tdesign/uniapp/toast/toast.vue';
|
||
```
|
||
|
||
### 基础提示
|
||
|
||
{{ base }}
|
||
|
||
### 组件状态
|
||
|
||
{{ theme }}
|
||
|
||
### 显示遮罩
|
||
{{ cover }}
|
||
|
||
### 手动关闭
|
||
{{ close }}
|
||
## API
|
||
|
||
### Toast Props
|
||
|
||
名称 | 类型 | 默认值 | 描述 | 必传
|
||
-- | -- | -- | -- | --
|
||
custom-style | Object | - | 自定义样式 | N
|
||
direction | String | row | 图标排列方式。可选项：row/column | N
|
||
duration | Number | 2000 | 弹窗显示毫秒数 | N
|
||
icon | String / Object | - | 自定义图标。传入对象则透传至 Icon 组件 | N
|
||
message | String | - | 弹窗显示文字 | N
|
||
overlay-props | Object | - | 遮罩层属性，透传至 Overlay。TS 类型：`OverlayProps `，[Overlay API Documents](./overlay?tab=api)。[详细类型定义](https://github.com/Tencent/tdesign-miniprogram/tree/develop/packages/uniapp-components/toast/type.ts) | N
|
||
placement | String | middle | 弹窗展示位置。可选项： top/middle/bottom | N
|
||
prevent-scroll-through | Boolean | false | 防止滚动穿透，即不允许点击和滚动 | N
|
||
show-overlay | Boolean | false | 是否显示遮罩层 | N
|
||
theme | String | - | 提示类型。可选项：loading/success/warning/error | N
|
||
using-custom-navbar | Boolean | false | 是否使用了自定义导航栏 | N
|
||
|
||
### Toast Events
|
||
|
||
名称 | 参数 | 描述
|
||
-- | -- | --
|
||
close | \- | 轻提示隐藏的时候触发
|
||
destroy | \- | 轻提示销毁的时候触发
|
||
|
||
### Toast Slots
|
||
|
||
名称 | 描述
|
||
-- | --
|
||
icon | 自定义图标
|
||
message | 弹窗显示文字
|
||
|
||
### Toast External Classes
|
||
|
||
类名 | 描述
|
||
-- | --
|
||
t-class | 根节点样式类
|
||
|
||
### CSS Variables
|
||
|
||
组件提供了下列 CSS 变量，可用于自定义样式。
|
||
名称 | 默认值 | 描述
|
||
-- | -- | --
|
||
--td-toast-bg-color | @mask-active | -
|
||
--td-toast-color | @text-color-anti | -
|
||
--td-toast-column-icon-size | 64rpx | -
|
||
--td-toast-max-width | 370rpx | -
|
||
--td-toast-radius | @radius-default | -
|
||
--td-toast-row-icon-size | 48rpx | -
|