Skip to content

setNavigationButton

描述

自定义导航栏左侧按钮。

网页应用需要完成鉴权后调用该接口。
按钮点击事件通过 onSuccess 通知。
注意:当左侧存在返回按钮时,该按钮会放到返回按钮的右边,多次调用时会覆盖之前的自定义。

支持说明

客户端平台WPS协作版本要求
iOS>=3.10.0
Android>=3.10.0
PC>=3.10.0

输入

名称数据类型是否必填描述
paramsobject
∟ autoResetNavigationBarboolean当前应用容器内页面发生跳转后是否重置导航栏设置,默认值为 false(仅移动端支持)
• false:跳转后不重置导航栏设置
• true:跳转后重置导航栏为标准样式
∟ defaultBehaviorboolean点击按钮时是否走默认行为,默认值为 false。
当传入值为true时,则不再执行回调后的前端业务逻辑,而是执行下面默认行为:
• home:则跳转到应用首页,homepage
• share:则调起客户端通讯录组件,执行分享逻辑
∟ directionstringPC端,不传默认是左侧(left),右侧:right(pc支持版本2.10.0)
∟ iconIdstring目前支持的 iconId 只有:
• home:返回首页样式。
• share:分享按钮样式。
传1个时,则在原有导航栏样式按钮后新增展示(现有交互)。
当传其他icon时,隐藏上次传入的自定义按钮。
注意:当按钮点击后,通过onSuccess回调告知前端页面进行处理
当defaultBehavior为true时,则不再执行回调后的前端业务逻辑,而是执行客户端默认行为:
∟ tipstringPC端,hover上去的提示
传入1个时,如:首页;

输出

  • 无返回值

示例代码

ts
window.ksoxz_sdk.setNavigationButton({
params:{
  iconId: 'home',
  tip: 'tip',
  direction: 'direction'
  defaultBehavior: true,
  autoResetNavigationBar: true
},
onSuccess,
onError
})

错误码

参考:公共错误码