swan.showFavoriteGuide

引导组件有统一的策略，若用户未执行过关注操作，则 3 天内不再出现引导组件；若用户执行过关注操作，则引导组件对该用户将不再出现。最低支持版本 3.20.4 。工具和真机中的实现有区别，详见 API 实现差异。

解释：支持在小程序内调起关注小程序引导组件，引导用户关注小程序。引导组件设计文档详见：关注小程序引导。如需更多自定义关注引导样式，可使用 Smart UI 组件，详见 mask 关注引导蒙层。
Web 态说明：Web 态暂不支持关注小程序引导功能，调用该 API 会触发 fail 回调。

方法参数

Object object

object 参数说明

属性名类型必填默认值说明

type

String

否

引导组件类型，有效值：tip ；必须填写该字段方能使用引导气泡

content

String

否

“关注小程序，下次使用更便捷”

引导组件文字，不支持开发者自定义

success

Function

否

接口调用成功的回调

fail

Function

否

接口调用失败的回调函数

complete

Function

否

接口调用结束的回调函数（调用成功、失败都会执行）

示例

跳转编辑工具

在开发者工具中打开

在 WEB IDE 中打开

扫码体验

代码示例

百度智能小程序

请使用百度APP扫码

代码示例：气泡引导（type = tip）

引导组件 5s 后自动消失，组件箭头指向小程序菜单。

  • JS
  1. swan.showFavoriteGuide({
  2.     type: 'tip',
  3.     content: '关注小程序，下次使用更便捷。'
  4. })