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

Confirm 组件使用教程

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

安装

import { Confirm } from 'vux'

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

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

Vue.component('confirm', Confirm)

建议参照例子使用 v-transfer-dom 将弹窗插入 body 节点下,避免组件非 body 子节点导致的各种问题。

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

以插件形式调用时,和template中使用不同,属性名请使用小驼峰式,比如confirmText而不是confirm-text

import  { ConfirmPlugin } from 'vux'
Vue.use(ConfirmPlugin)
// 显示
const _this = this // 需要注意 onCancel 和 onConfirm 的 this 指向
this.$vux.confirm.show({
  // 组件除show外的属性
  onCancel () {
    console.log(this) // 非当前 vm
    console.log(_this) // 当前 vm
  },
  onConfirm () {}
})

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

// prompt形式调用
this.$vux.confirm.prompt('placeholder', {
  onCancel () {}
  onConfirm () {}
})

// 设置输入值
this.$vux.confirm.setInputValue('value') // 注意需要在 onShow 事件中执行

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

属性

名字类型默认值说明版本要求
valuebooleanfalse是否显示,使用v-model绑定--
show-inputbooleanfalse是否显示输入框,如果为true,slot会失效v2.5.0
placeholderstring输入框的提示(仅在showInput为true的情况下有效)v2.5.0
themestringios弹窗风格,可以是ios或android--
hide-on-blurbooleanfalse是否在点击遮罩时自动关闭弹窗--
titlestring弹窗标题--
contentstring弹窗内容,作为slot默认内容,可以是html片段,如果使用slot该字段会失效--
confirm-textstring确认(confirm)确认按钮的显示文字--
cancel-textstring取消(cancel)取消按钮的显示文字--
mask-transitionstringvux-fade遮罩动画--
dialog-transitionstringvux-dialog弹窗动画--
close-on-confirmbooleantrue是否在点击确认按钮时自动关闭v2.5.0
input-attrsobjectinput 属性v2.5.7
mask-z-indexnumber
string
1000遮罩层 z-index 值v2.6.4
show-cancel-buttonbooleantrue是否显示取消按钮v2.9.2
show-confirm-buttonbooleantrue是否显示确定按钮v2.9.2

事件

名字参数说明版本要求
@on-cancel--点击取消按钮时触发--
@on-confirm(value)点击确定按钮时触发, 参数为prompt中输入的值--
@on-show--弹窗出现时触发--
@on-hide--弹窗隐藏时触发--

插槽

名字说明版本要求
默认插槽弹窗主体内容--

方法

名字参数说明版本要求
setInputValue(value)设置输入值,当 show-input 为 true 时有效v2.5.5