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/showBottomSheet.md.

showBottomSheet

显示豆包底部弹窗。

扫码预览

扫码预览 showBottomSheet

使用限制

WARNING

Android、iOS:iOS 无法展示弹窗或不支持三按钮时返回 errNo 103 失败,Android 无法展示弹窗时返回 action=cancel、source=hostUnavailable 的成功结果,且不检测三按钮能力;调用方无法用统一逻辑处理弹窗不可用场景。

支持版本

前端库版本不低于 0.0.36。

支持平台

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

支持场景

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

使用说明

content 接收受限 HTML 字符串,当前支持段落、加粗和链接;危险标签、事件属性和危险链接协议会被拦截。 链接会在豆包内打开,不会关闭弹窗。 Promise 在用户点击按钮或点击蒙层关闭后 resolve。

  • content 为受限 HTML,仅支持段落、加粗和链接,危险标签、事件属性和非 http(s) 链接会被拦截并触发失败;链接点击打开 H5,不关闭弹窗。
  • buttons 需 1-3 个且语义不重复;用户点击蒙层或下拉手势关闭时返回 action=cancel。当豆包无法展示弹窗时,iOS 返回失败、Android 返回 action=cancel 且 source=hostUnavailable,请对两种结果都做降级处理。

调用方式

异步 API

showBottomSheet(params: ShowBottomSheetParams): Promise<ShowBottomSheetResult>

入参

名称类型必填默认值约束说明
behaviorBottomSheetBehavior否--弹窗行为配置。
behavior.dismissOnMaskTapboolean否true-是否允许点击蒙层关闭弹窗。
buttonsBottomSheetButtons是--按钮配置,支持 1-3 个,展示顺序与数组顺序一致,按钮语义不可重复。
contentstring是--受限 HTML 字符串,支持段落、加粗和链接。
titlestring是--弹窗标题。

调用示例

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

const result = await showBottomSheet({
  title: '隐私协议提示',
  content:
    '<p>感谢您使用当前应用插件。</p><p><b>•</b> 详情请见<a href="https://www.doubao.com/chat/"><b>《应用插件条款》</b></a></p>',
  buttons: [
    { role: 'agreeMain', text: '同意并继续' },
    { role: 'reject', text: '暂不同意' }
  ]
});

if (result.action === 'buttonClick') {
  console.log(result.role);
}

成功返回

action = "buttonClick"

名称类型必返说明
action"buttonClick"是弹窗结束动作。
roleBottomSheetButtonRole是被点击按钮的语义。

action = "cancel"

名称类型必返说明
action"cancel"是弹窗结束动作。
sourceBottomSheetCancelSource是取消来源。

返回示例

{
  "action": "buttonClick",
  "role": "agreeMain"
}

错误处理

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

失败示例

{
  "errNo": 104,
  "errMsg": "invalid parameter"
}

错误码

errNoerrMsg平台触发条件处理建议
104invalid parameterAndroid、iOStitle 或 content 为空、content 含被拦截的标签/事件属性/危险链接、buttons 数量不在 1-3 范围;iOS 还会在按钮语义重复或按钮文案为空时返回修正参数后重试。
103feature not supportiOS豆包 iOS 无法展示底部弹窗,或不支持包含 3 个按钮的弹窗降级到自定义弹窗;同场景 Android 返回 action=cancel、source=hostUnavailable 的成功结果,请一并做降级处理。

平台差异

  • iOS:无法展示底部弹窗或不支持三按钮时返回 errNo 103 失败;Android 无法展示底部弹窗时返回 action=cancel、source=hostUnavailable 的成功结果,且不校验三按钮能力。