createModal
API_LEVEL
2.0
开始支持,API 兼容性请参考 API_LEVEL。
创建 Modal 确认提示框。
类型
function createModal(option: Option): Modal
参数
Option
属性 | 类型 | 必填 | 默认值 | 说明 | API_LEVEL |
---|---|---|---|---|---|
content | string | 是 | - | Modal 对话框的标题 | 2.0 |
title | string | 否 | - | Modal 对话框的标题,content 的别名 | 3.6 |
show | boolean | 否 | false | 完成创建后是否立即显示 Modal 对话框 | 2.0 |
onClick | (keyObj: KeyObj) => void | 否 | - | 点击确认或者取消的回调函数 | 2.0 |
autoHide | boolean | 否 | true | 点击确认或者取消按钮后,是否自动关闭 Modal 对话框 | 2.0 |
subtitle | string | 否 | - | 子标题 | 3.6 |
src | string | 否 | - | icon 图标路径 | 3.6 |
text | string | 否 | - | 文本内容 | 3.6 |
textColor | number | 否 | 0xFFFFFF | 文本颜色 | 3.6 |
textAlpha | number | 否 | 255 | 文本透明度,透明度[0-255],0 为全透明 | 3.6 |
okButton | string | 否 | - | 确认按钮的 icon 图标路径 | 3.6 |
cancelButton | string | 否 | - | 取消按钮的 icon 图标路径 | 3.6 |
capsuleButton | Array<string> | 否 | - | 胶囊按钮配置,为字符串数组,点击返回的 KeyObj 中的 type 从 10 开始 | 3.6 |
KeyObj
属性 | 类型 | 说明 | API_LEVEL |
---|---|---|---|
type | number | Modal 按键名,值参考 Modal 按键名常量 | 2.0 |
Modal
属性 | 类型 | 说明 | API_LEVEL |
---|---|---|---|
show | (isShow: boolean) => void | 显示或隐藏 Modal 对话框 | 2.0 |
常量
Modal 按键名常量
常量 | 说明 | API_LEVEL |
---|---|---|
MODAL_CONFIRM | Modal 确认按键 | 2.0 |
MODAL_CANCEL | Modal 取消按键 | 2.0 |
代码示例
import { createModal, MODAL_CONFIRM } from '@zos/interaction'
const dialog = createModal({
content: 'hello world',
autoHide: false,
onClick: (keyObj) => {
const { type } = keyObj
if (type === MODAL_CONFIRM) {
console.log('confirm')
} else {
dialog.show(false)
}
},
})
dialog.show(true)