Modal 模态框

创建一个模态框,用于强调特定的页面元素,并阻止用户进行其他操作。

代码演示

基础用法

title 提示标题,content 提示内容。

<hd-modal id="hd-modal"></hd-modal>
<hd-button @click="open">打开对话框</hd-button>
// uni_modules
import { showModal } from '@/uni_modules/fant-mini'
// npm
import { showModal } from 'fant-mini'
export default {
  data() {
    return {
      showCancel: false
    }
  },
  methods: {
    open() {
      showModal({
        title: '提示',
        showCancel: this.showCancel,
        content: '哈喽啊,树先生'
      })
    }
  }
}

取消

showCancel 是否显示取消按钮,默认为 true,cancelText 取消按钮的文字,默认为"取消",cancelColor 取消按钮的文字颜色,默认为"#000000"。

<hd-modal id="hd-modal"></hd-modal>
<hd-button @click="open">打开对话框</hd-button>
export default {
  data() {
    return {
      showCancel: false
    }
  },
  methods: {
    open() {
      showModal({
        title: '提示',
        content: '哈喽啊,树先生',
        showCancel: this.showCancel,
        cancelText: '返回',
        cancelColor: '#333'
      })
    }
  }
}

确认

confirmText 确定按钮的文字,默认为"确定",confirmText 确认按钮的文字颜色,默认为"#3CC51F"。

<hd-modal id="hd-modal"></hd-modal>
<hd-button @click="open">打开对话框</hd-button>
export default {
  data() {
    return {
      showCancel: false
    }
  },
  methods: {
    open() {
      showModal({
        title: '提示',
        content: '哈喽啊,树先生',
        confirmText: '提交',
        confirmText: '#333'
      })
    }
  }
}

事件

success 调用成功的回调函数,fail 调用失败的回调函数,complete 调用结束的回调函数(调用成功、失败都会执行)。

<hd-modal id="hd-modal"></hd-modal>
<hd-button @click="open">打开对话框</hd-button>
export default {
  data() {
    return {
      showCancel: false
    }
  },
  methods: {
    open() {
      showModal({
        title: '提示',
        content: '哈喽啊,树先生',
        success: (action) => {
          if (action.confirm) {
            // 点击的确认按钮
            console.log('确认')
          }
        },
        fail() => {},
        complete() => {},
      })
    }
  }
}

方法

fant-mini 中导出了以下 Modal 相关的辅助函数:

方法名说明参数返回值
showModal展示对话框ModalOptionsModal

ModalOptions 数据结构

参数说明类型是否必填默认值
title提示的标题。Stringfalse提示
content提示的内容。Stringfalse-
showCancel是否显示取消按钮。Booleanfalsetrue
cancelText取消按钮的文字Stringfalse取消
cancelColor取消按钮的文字颜色Stringfalse#282C34
confirmText确认按钮的文字Stringfalse确定
confirmColor确认按钮的文字颜色Stringfalse#1C64FD
success方法调用成功的回调函数Functionfalse返回值:result:ModalRes
fail方法调用失败的回调函数Functionfalse返回值:result:ModalRes
complete调用结束的回调函数(调用成功、失败都会执行)Functionfalse返回值:result:ModalRes

ModalRes 数据结构

参数说明类型
confirm用户是否点击了确定按钮。Boolean
cancel用户是否点击了取消。Boolean

Events

Event NameDescriptionParameters
input消息展示状态变更时触发value:Boolean 消息展示状态,建议通过v-model双向绑定输入值,而不是监听此事件的形式

Slots

NameDescriptionDefault Slot Content
title标题-
content内容区-
operation操作按钮-