For AI agents: the complete documentation index is available at /apps-plugin/docs/llms.txt, the full documentation bundle is available at /apps-plugin/docs/llms-full.txt, and this page is available as Markdown at /apps-plugin/docs/js-api/ui/interaction/showModal.md.

showModal

显示模态对话框。

扫码预览

扫码预览 showModal

支持版本

前端库版本不低于 0.0.26。

支持平台

平台支持情况
Android支持
iOS支持
PC不支持
HarmonyOS不支持

支持场景

场景支持情况
页面支持
卡片支持

使用说明

  • 仅当 showCancel 为 true 时展示取消按钮;仅当 tapMaskToDismiss 为 true 时点击蒙层可关闭;editable 为 true 且用户确认时返回输入 content。

调用方式

异步 API

showModal(params?: ShowModalParams): Promise<ShowModalResult>

入参

名称类型必填默认值约束说明
cancelColorstring否#000000必须是 16 进制格式的颜色字符串。取消按钮的文字颜色。
cancelTextstring否取消最多 4 个字符。取消按钮的文字。
confirmColorstring否#F85959必须是 16 进制格式的颜色字符串。确认按钮的文字颜色。
confirmTextstring否确定最多 4 个字符。确认按钮的文字。
contentstring否--模态对话框的内容。
editableboolean否false-是否显示输入框。
placeholderTextstring否--显示输入框时的提示文本。
showCancelboolean否true-是否显示取消按钮。
tapMaskToDismissboolean否true-是否允许点击蒙层关闭对话框。
titlestring否--模态对话框的标题。

调用示例

import { showModal } from '@doubao-dev/framework/api';

const result = await showModal({
  title: '提示',
  content: '确认删除这条记录吗?',
  confirmText: '删除',
  cancelText: '取消'
});

if (result.action === 'confirm') {
  console.log('用户确认删除');
}

成功返回

名称类型必返说明
action"confirm" | "cancel" | "mask"是用户点击的动作。
contentstring否`editable` 为 true 时,用户点击确认后输入的文本。

返回示例

{
  "action": "confirm"
}

错误处理

错误对象和通用错误码见 通用错误处理。

错误码

通用错误码

errNoerrMsg说明平台
102internal error内部错误Android、iOS