# Toast 轻提示
概述
Toast 轻提示，一种轻量级反馈/提示，适合用于页面转场、数据交互的等场景中。
# 支持平台
| App-vue | App-Nvue | 微信小程序 | 支付宝小程序 | 百度小程序 | 字节小程序 | QQ小程序 | H5 | PC | 快手小程序 | 钉钉小程序 |
|---|---|---|---|---|---|---|---|---|---|---|
| ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ | ✓ |
温馨提示
一般来说我们会通过 z-index + position 来进行层级的设置，但是 weex （Nvue）不支持 z-index 设置层级关系，默认越靠后的元素层级越高。
# 引入
以下介绍两种常用的引入方式。
第一种：在页面中引用、注册
import fuiToast from "@/components/firstui/fui-toast/fui-toast.vue"
export default {
components:{
fuiToast
}
}
1
2
3
4
5
6
2
3
4
5
6
第二种：easycom组件规范
传统vue组件，需要安装、引用、注册，三个步骤后才能使用组件。easycom将其精简为一步。
First UI easycom配置请查看 快速上手。
如果不了解easycom，可先查看 官网文档 (opens new window)。
# 代码演示
部分示例演示，完整使用请参考示例程序以及文档API（以下示例写于.vue页面中）。
无图标提示
通过 ref 来注册组件引用信息，引用信息将会注册在父组件的$refs对象上。注册完成后，通过 this.$refs.toast 访问到对应的组件实例，并调用上面的实例方法 show 来显示提示信息。
<fui-toast ref="toast"></fui-toast>
1
//调用方法showToast显示提示信息
methods: {
showToast(type) {
let options = {}
//提示信息
options.text = '请输入手机号';
this.$refs.toast.show(options)
}
}
1
2
3
4
5
6
7
8
9
10
2
3
4
5
6
7
8
9
10
带图标提示
通过 ref 来注册组件引用信息，引用信息将会注册在父组件的$refs对象上。注册完成后，通过 this.$refs.toast 访问到对应的组件实例，并调用上面的实例方法 show 来显示提示信息。
<fui-toast ref="toast"></fui-toast>
1
//调用方法showToast显示提示信息
methods: {
showToast(type) {
let options = {}
//提示信息
options.text = '请输入手机号';
//图标图片地址
options.src = "/static/images/common/img_logo.png";
this.$refs.toast.show(options)
}
}
1
2
3
4
5
6
7
8
9
10
11
12
2
3
4
5
6
7
8
9
10
11
12
自定义提示内容
将自定义内容放入组件内，调用显示时参数传空对象即可。
<fui-toast ref="toast">
<view class="fui-toast__custom">
<fui-icon name="checkbox" color="#fff"></fui-icon>
<text class="fui-toast__txt">操作成功</text>
</view>
</fui-toast>
1
2
3
4
5
6
2
3
4
5
6
//调用方法showToast显示提示信息
methods: {
showToast(type) {
let options = {}
this.$refs.toast.show(options)
}
}
1
2
3
4
5
6
7
8
2
3
4
5
6
7
8
# Slots
| 插槽名称 | 说明 |
|---|---|
| default | 自定义提示内容 |
# Props
| 属性名 | 类型 | 说明 | 默认值 | 平台差异说明 |
|---|---|---|---|---|
| padding | Array | 提示框padding值，[上,右,下,左] | ['32rpx', '32rpx'] | - |
| background | String | 提示框背景颜色 | rgba(0,0,0,.6) | - |
| width | Number, String | 图标宽度（高度与宽度一致），单位rpx | 64 | - |
| size | Number, String | 提示信息字体大小，单位rpx | 30 | - |
| color | String | 提示信息文本颜色 | #fffF | - |
| zIndex | Number | 提示框z-index值 | 1001 | Nvue端不支持，默认越靠后的元素层级越高 |
# Events
| 事件名 | 说明 | 回调参数 |
|---|---|---|
| - | - | - |
# Methods
通过 ref 来注册组件引用信息，引用信息将会注册在父组件的$refs对象上。注册完成后，通过 this.$refs.XXX 访问到对应的组件实例，并调用上面的实例方法 show 来显示提示信息。
| 方法名 | 说明 | 传入参数 |
|---|---|---|
| show | 显示提示信息 | { text:提示信息, src:提示图标，可选, duration:显示持续时间，单位ms，可选 } |
Toast 轻提示