# 导航栏

# 关闭当前页面

# 使用说明

移动端调用此接口可以关闭当前浏览器窗口, PC 端调用可以关闭当前页面的 tab 页。

Android iOS PC 是否需要鉴权
支持 支持 支持 v3.2.1 支持 pc 不需要

// 全量引入调用方式
yy.biz.navigation.close({
  onSuccess: function (result) {
    /*result结构
        {}
    */
  },
  onFail: function (err) {},
});

// 按需加载调用方式,参数与全量引入相同
close({...});

# 返回说明

# 调试

biz.navigation.close

# 返回上一级页面 v3.2.1

# 使用说明

调用此接口可以返回上一级页面。

Android iOS PC 是否需要鉴权
支持 支持 不支持 不需要

# 返回说明


// 全量引入调用方式
yy.biz.navigation.goBack({
  onSuccess: function (result) {
    /*result结构
        {}
    */
  },
  onFail: function (err) {},
});

// 按需加载调用方式,参数与全量引入相同
goBack({...});

# 调试

biz.navigation.goBack

# 替换页面

# 使用说明

使用新的页面替换当前页面,当前页面会被立即销毁,展示新页面,无动画。

Android iOS PC 是否需要鉴权
支持 支持 不支持 不需要

# 返回说明

// 全量引入调用方式
yy.biz.navigation.replace({
  url: "http://yach.zhiyinlou.com",
  onSuccess: function (result) {
    /*
      {}
      */
  },
  onFail: function (err) {},
});

// 按需加载调用方式,参数与全量引入相同
replacePage({...});

# 参数说明

参数 参数类型 必传 说明
url String 新的页面链接

# 调试

biz.navigation.replace

# 设置导航栏标题

# 使用说明

Android iOS PC 是否需要鉴权
支持 支持 支持 不需要

此 JSSDK 在 iOS 和 Android 上的显示不同:
(1)iOS/Android
标题在导航栏正中央。

(2)PC 端
注意,只在 SlidePanel 和 Modal 里起作用。

# 返回说明

// 全量引入调用方式
yy.biz.navigation.setTitle({
  title: "邮箱正文",
  onSuccess: function (result) {
    /*结构
        {
        }*/
  },
  onFail: function (err) {},
});

// 按需加载调用方式,参数与全量引入相同
setTitle({...});

# 参数说明

参数 参数类型 必传 说明
title String
控制标题文本,空字符串表示显示默认文本

# 调试

biz.navigation.setTitle

# 关闭页面

# 使用说明

注意:只在 SlidePanel 和 Modal 里起作用。

Android iOS PC 是否需要鉴权
不支持 不支持 支持 不需要
// 全量引入调用方式
yy.biz.navigation.quit({
  message: "quit message",
  onSuccess: function (result) {
    /**/
  },
  onFail: function () {},
});

// 按需加载调用方式,参数与全量引入相同
quit({...});

# 参数说明

参数 参数类型 必传 说明
message String 退出信息,传递给 openSlidePanel 的 onSuccess 函数的 result 参数
1. message 参数仅支持字符串或者数字
2. 如果未传入 message,则传递给 openModal 的值为随机值

# 返回说明

# 调试

biz.navigation.quit

# 设置左侧导航按钮文本

# 使用说明

Android iOS PC 是否需要鉴权
支持 支持 支持(只在 SlidePanel 里起作用) 不需要

# 返回说明

# iOS/Android

// 全量引入调用方式
yy.biz.navigation.setLeft({
  control: true,
  text: "",
  onSuccess: function (result) {
     //如果 control 为 true,则 onSuccess 将在发生按钮点击事件被回调
    /*
      {}
      */
  },
  onFail: function (err) {},
});

// 按需加载调用方式,参数与全量引入相同
setLeft({...});
参数 参数类型 说明
contorl Boolean 是否控制点击事件,true 控制,false 不控制,默认 false
为 true 时,按钮点击触发 onSuccess 回调
text String 显示文本,默认 '返回'

# 调试

biz.navigation.setLeft

# PC

只在 SlidePanel 里起作用

// 全量引入调用方式
yy.biz.navigation.setLeft({
  text: "lalala",
  onSuccess: function (result) {
    /**/
  },
  onFail: function () {},
});

// 按需加载调用方式,参数与全量引入相同
setLeft({...});
参数 参数类型 说明
text String 显示文本(支持简单 html)

# 调试

biz.navigation.setLeft

# 事件监听

# 使用说明

Android iOS PC 是否需要鉴权
支持 支持 不支持 不需要

# 返回说明

yy.on("leftBtnClick", () => {});

# 调试

on

# 设置导航栏右侧单个按钮

# 使用说明

调用 setRight 可以设置导航栏最右侧按钮的文字,并且接收点击事件,只能设置文本按钮,需要设置按钮的 icon 请查看设置下面的导航栏右侧多个按钮。

Android iOS PC 是否需要鉴权
支持 支持 支持(只在 SlidePanel 里起作用) 不需要

# 返回说明

// 全量引入调用方式
yy.biz.navigation.setRight({
  show: false,
  control: true,
  text: "发送",
  color: "#fff",
  onSuccess: function (result) {
    //如果control为true,则onSuccess将在发生按钮点击事件被回调
    /*
      {}
      */
  },
  onFail: function (err) {},
});

// 按需加载调用方式,参数与全量引入相同
setRight({...});

# 参数说明

参数 参数类型 说明
show Boolean 控制按钮显示,true 显示,false 隐藏,默认 true
control Boolean 是否控制点击事件,true 控制,false 不控制,默认 false
text String 控制显示文本,空字符串表示显示默认文本
color String 控制文本颜色
btnColor String 控制按钮背景颜色

# 调试

biz.navigation.setRight

# PC

只在 SlidePanel 里起作用

// 全量引入调用方式
yy.biz.navigation.setRight({
  text: "lalala",
  onSuccess: function (result) {
    /**/
  },
  onFail: function () {},
});

// 按需加载调用方式,参数与全量引入相同
setRight({...});
参数 参数类型 说明
text String 显示文本(支持简单 html)

# 调试

biz.navigation.setRight

# 事件监听

# 使用说明

Android iOS PC 是否需要鉴权
支持 支持 不支持 不需要

# 返回说明

yy.on("leftBtnClick", () => {});

# 调试

on

# 设置导航栏右侧多个按钮

# 使用说明

Android iOS PC 是否需要鉴权
支持 支持 不支持 不需要

# 返回说明

// 全量引入调用方式
yy.biz.navigation.setMenu({
  backgroundColor: "#ADD8E6",
  textColor: "#ADD8E611",
  items: [
    {
      id: "1",
      url: "图标地址",
      text: "帮助",
    },
    {
      id: "2",
      url: "https://www...",
      text: "dierge",
    },
    {
      id: "3",
      url: "图标地址",
      text: "disange",
    },
  ],
  onSuccess: function (data) {
    /*
      {"id":"1"}
      */
  },
  onFail: function (err) {},
});

// 按需加载调用方式,参数与全量引入相同
setMenu({...});

# 参数说明

参数 参数类型 必传 说明
backgroundColor String 下拉菜单背景色
textColor String 下拉菜单文字颜色
items JSONArray 多个按钮的属性数组
item.id String 每一个 item 的唯一标识
item.url String 图标的网络地址
item.text String item 的文字属性
item.badge String 小红点上的数字 5.0.0
item.showRedDot Boolean 是否显示小红点 5.0.0

# 调试

biz.navigation.setMenu

# 返回说明

点击任意一个按钮将会回调 onSuccess,并返回被点击 item 的 id。

多个按钮排序规则
items 个数小于等于两个,将在右上角直接排列,如下图:

items 个数大于两个,第一个按钮将在右上角显示,其他按钮在下拉菜单中显示。

每个按钮显示规则
每个 item 中的“text”字段是必填项。
(1)导航栏上的按钮显示规则(优先级从上至下)
url 对应的图片
text 对应的文本

# 设置下拉 title

# 使用说明

用来设置头部下拉 title

Android iOS PC 是否需要鉴权
支持 支持 不支持 不需要

# 返回说明

# iOS/Android

// 全量引入调用方式
yy.biz.navigation.setTitleExpandIcon({
  isShowIcon: true,
  title: "",
  onSuccess: function (result) {
    // onSuccess 第一调用不触发,之后每次点击 title 都会触发 onSuccess 回调;
    /*
      {}
      */
  },
  onFail: function (err) {},
});

// 按需加载调用方式,参数与全量引入相同
setTitleExpandIcon({...});
参数 参数类型 说明
isShowIcon Boolean 控制右侧图标是否显示,true :展示标题右边 icon ,false :隐藏标题右边 icon
title String 设置 title 内容

# 配合 biz.navigation.updateExpandTitle 来实现下图日志的下拉

# image.png

# 更新 title

# 使用说明

和 biz.navigation.setTitleExpandIcon 结合使用来实现 title 切换

Android iOS PC 是否需要鉴权
支持 支持 不支持 不需要

# 返回说明

# 调试

biz.navigation.setTitleExpandIcon

# iOS/Android

// 全量引入调用方式
yy.biz.navigation.updateExpandTitle({
  title: "", //需要更新的标题内容
  onSuccess: function (result) {
    /*
        {}
        */
  },
  onFail: function (err) {},
});

// 按需加载调用方式,参数与全量引入相同
updateExpandTitle({...});
参数 参数类型 说明
title String 需要更新的标题内容

# 调试

biz.navigation.updateExpandTitle
上次更新: 7/31/2020, 11:49:31 AM
foo