安装

tnpm install --save @alipay/mas-prompting-add-home

组件介绍

行业小程序新版添加到首页提示组件，支持疲劳度控制，并已处理好添加事件的监听和移除操作，功能强大。 基于添加到首页基础能力接口文档，若无法正常使用，请先查看文档，是否权限问题。

避免组件被其他组件或原生组件覆盖，支持useNativeRender使用原生组件cover-view绘制，zIndex设置为9999999

参数说明

属性 | 必填 | 参数类型 | 参数说明 | 默认值 | 示例 --|:--:|:--:|:--:|:--: | :-: appId | false | string | 小程序appId，可不传，不传时使用my.getAppIdSync自动获取，建议传入 | --- | -- text | false | string | 提示文案 | 添加至首页，下次使用更便捷 | -- expiresControlType | false | 'close'、'appear' | 疲劳度控制时机，可选点击关闭或者展示曝光 | close | -- expiresTimeType | false | 'month'、'week'、'day'、'custom' | 疲劳度控制，支持月(30天)、周、天或自定义 | week | -- expiresTime | false | number | 自定义疲劳度custom时需传入，疲劳度控制周期，单位为ms，比如需20天一次，设置为20 * 7 * 24 * 60 * 60 * 1000 | --- | -- useNativeRender | false | bool | 使用native组件(cover-view)渲染，层级最高，默认关闭 | false | -- expiresCacheKey | false | string | 前端控制疲劳度的缓存key | PROMPTING_ADD_HOME_KEY | -- transparentTitle | false | bool | 页面是否透明头，计算提示距离顶部距离使用，auto/always时设置为true | false | -- onNotSupport | false | Fn | 检测到不支持此api触发 | --- | -- onAppear | false | Fn | 曝光事件 | --- | -- onInMyApps | false | Fn | 检测到已在首页事件 | --- | -- onClose | false | Fn | 点击右侧x关闭事件 | --- | -- onSuccess | false | Fn | 添加成功事件 | --- | -- onFail | false | Fn | 添加失败事件 | --- | -- onCancel | false | Fn | 点击取消按钮 | --- | -- onGoEdit | false | string | 去编辑页面 | --- | --

在小程序中使用

{
  "usingComponents": {
    "mas-prompting-add-home": "@alipay/mas-prompting-add-home/es/index"
  }
}

在 page.axml 中引用组件

<!-- 页面使用方式 -->
 <mas-prompting-add-home appId="appId" onClose="onClose" onAppear="onAppear"/>

Badges

[![install size][install-size-image]][install-size-url]