button组件添加到桌面能力
收藏
我的收藏

基础库 2.92.0 开始支持本能力。支持小程序添加桌面快捷方式，需要将 button 组件 open-type 的值设置为 addShortcut。
button 组件常规属性请参考对外文档。

该能力需申请权限使用，满足申请条件后，开发者需登录控制台，在小程序应用中筛选“能力-互动能力-系统能力”，申请添加到桌面能力。

属性说明

属性名	类型	默认值	必填	说明	最低支持版本
open-type	string		是	用于调用开放能力，此场景下需要设置为 "addShortcut"	2.92.0
bindaddshortcut	EventHandle		否	监听添加快捷方式的回调，open-type=addShortcut时有效	2.92.0

bindaddshortcut 事件对象的 detail

回调成功

Object 类型，属性如下：

参数	参数类型	说明
errMsg	string	跳转成功信息，恒为`'addShortCut:ok'`
errNo	number	恒为0

回调失败

Object 类型，属性如下：

参数	参数类型	说明
errMsg	string	跳转失败信息，以`'addShortCut:fail'`开头
errNo	number	错误代码

扫码体验

代码示例

开发者工具中预览

HTML复制
<button open-type="addShortcut" bindaddshortcut="eventHandler">
  添加到桌面
</button>

JavaScript复制
Page({
  data: {},

  eventHandler(e) {
    if (e.detail.errNo) {
      console.log("添加到桌面失败", e.detail);
    } else {
      console.log("添加到桌面成功");
    }
  },
});