当前位置: 首页 > 文档资料 > VUX 中文文档 >

Toast 组件使用教程

优质
小牛编辑
132浏览
2023-12-01

安装

import { Toast } from 'vux'

export default {
  components: {
    Toast
  }
}
// 在入口文件全局引入

import Vue from 'vue'
import { Toast } from 'vux'

Vue.component('toast', Toast)

该组件支持以plugin形式调用:

以插件形式调用时,和template中使用不同,属性名请使用小驼峰式,比如isShowMask而不是is-show-mask

import  { ToastPlugin } from 'vux'
Vue.use(ToastPlugin)

// 或者umd方式
// 引入构建的js文件
Vue.use(vuxToastPlugin)

// 默认参数
Vue.use(ToastPlugin, {position: 'top'})
// 显示
this.$vux.toast.show({
 text: 'Loading'
})

// 显示文字
this.$vux.toast.text('hello', 'top')

// 隐藏
this.$vux.toast.hide()

// 获取显示状态
this.$vux.toast.isVisible() // v2.9.1 开始支持

属性

名字类型默认值说明版本要求
valuebooleanfalse是否显示, 使用 v-model 绑定--
timenumber2000显示时间--
typestringsuccess类型,可选值 success, warn, cancel, text--
widthstring7.6em宽度--
is-show-maskbooleanfalse是否显示遮罩,如果显示,用户将不能点击页面上其他元素--
textstring提示内容,支持 html,和默认slot同样功能--
positionstringdefault显示位置,可选值 default, top, middle, bottomv2.1.1-rc.4

事件

名字参数说明版本要求
@on-show--提示弹出时触发--
@on-hide--提示隐藏时触发--

插槽

名字说明版本要求
默认插槽默认slot, 提示内容--

样式变量

名字默认值说明继承自变量
@toast-content-font-size 16px内容文本颜色
@toast-top 180px默认状态下距离顶部的高度
@toast-position-top-offset 10px顶部显示的高度
@toast-position-bottom-offset 10px底部显示的高度
@toast-z-index 5001z-index