纷享销客开发者手册 纷享销客开发者手册
  • APL开发手册
  • PWC开发手册
  • OpenAPI 文档
  • 快速入门
  • API 授权流程
  • API 基础说明
  • OpenAPI
  • 免登集成方案
  • 客户端开发
  • 常见问题
  • OpenApi V1版本 (opens new window)
  • 简体中文
  • English
  • 快速入门
  • API 授权流程
  • API 基础说明
  • OpenAPI
  • 免登集成方案
  • 客户端开发
  • 常见问题
  • OpenApi V1版本 (opens new window)
  • 简体中文
  • English
  • 快速入门

  • API授权流程

  • API基础说明

  • OpenAPI

  • 免登集成方案

  • 客户端开发

    • 接入指南

    • JavaScript

      • 容器
      • 设备
      • 启动器
      • Webview
      • 弹层
        • 纷享服务
        • 媒体
        • 通用
      • UI

    • 常见问题

    目录

    弹层

    # 弹层

    接口名 接口描述
    widget.showActionSheet 显示弹出菜单
    widget.showAlert 显示警告窗口
    widget.showConfirm 显示确认窗口
    widget.showPreloader 显示加载提示
    widget.hidePreloader 隐藏加载提示
    widget.showModal 显示模态窗口
    widget.showPrompt 显示带输入框的窗口
    widget.showToast 显示Toast
    widget.showDateTimePicker 显示日期选择控件
    widget.showEditor 显示文本编辑器

    # 显示单选菜单

    代码样例

    FSOpen.widget.showActionSheet({
        title: '标题',
        cancelBtnLabel: '取消',
        actionBtnLabels: ['湖人', '马刺', '火箭'],
        onSuccess: function(resp) {
            if (resp.actionIndex == 0) {
                alert('选择了湖人');
            } else if (resp.actionIndex == 1) {
                alert('选择了马刺');
            } else {
                alert('选择了火箭');
            }
        },
        onFail: function(error) {
            alert('获取失败,错误码:' + error.errorCode);
        }
    });
    

    方法名:FSOpen.widget.showActionSheet JS版本:2.0.0 客户端支持版本:5.4.0及以上

    调用参数说明:

    参数 类型 必须 说明
    title String 否 控件标题。如果为空,Android系统默认显示“选项”,ios系统不显示。
    cancelBtnLabel String 否 取消选项文本,默认为“取消”,点击后收起单选列表。
    actionBtnLabels Array[String] 是 选项文本列表

    成功回调返回参数:

    参数 类型 说明
    actionIndex Number 选择的索引号,从0开始,从上到下依次递增+1。

    # 显示警告窗口

    代码样例

    FSOpen.widget.showAlert({
        title: '标题',
        content: '消息内容',
        btnLabel: '我知道了',
        onSuccess: function(resp) {
            // return nothing
        },
        onFail: function(error) {
            alert('操作失败,错误码:' + error.errorCode);
        }
    });
    

    方法名:FSOpen.widget.showAlert JS版本:2.0.0 客户端支持版本:5.4.0及以上

    调用参数说明:

    参数 类型 必须 说明
    title String 否 弹窗标题
    content String 否 弹窗消息内容
    btnLabel String 否 弹窗按钮文本,默认“OK”。

    # 显示确认窗口

    代码样例

    FSOpen.widget.showConfirm({
        title: '标题',
        content: '消息内容',
        btnLabels: ['取消','确定'],
        onSuccess: function(resp) {
            if (resp.btnIndex == 0) {
                alert('取消');
            } else {
                alert('确定');
            }
        },
        onFail: function(error) {
            alert('操作失败,错误码:' + error.errorCode);
        }
    });
    

    方法名:FSOpen.widget.showConfirm JS版本:2.0.0 客户端支持版本:5.4.0及以上

    调用参数说明:

    参数 类型 必须 说明
    title String 否 弹窗标题
    content String 否 弹窗消息内容
    btnLabels String 是 弹窗左右按钮的文本,最多两个。

    成功回调返回参数:

    参数 类型 说明
    btnIndex Number 点击的按钮索引,从0开始,从左到右分别为0、1

    # 显示加载提示

    代码样例

    FSOpen.widget.showPreloader({
        text: '正在加载中',
        icon: true,
        onSuccess: function(resp) {
            // do sth
        },
        onFail: function(error) {
            // do sth
        }
    });
    

    方法名:FSOpen.widget.showPreloader JS版本:2.0.0 客户端支持版本:5.4.0及以上

    调用参数说明:

    参数 类型 必须 说明
    text String 否 loading显示的文本,空表示不显示文字
    icon Boolean 否 是否显示图标,默认为true;若text为空,则强制为true。

    # 隐藏加载提示

    代码样例

    FSOpen.widget.hidePreloader();
    

    方法名:FSOpen.widget.hidePreloader JS版本:2.0.0 客户端支持版本:5.4.0及以上

    # 显示模态提示

    代码样例

    FSOpen.widget.showModal({
        title: '升级提示',
        imgUrl: 'https://open.fxiaoke.com/fscdn/img?imgId=group1/M00/02/04/rBEiBVfZFl6AOJ6eAABPHGYzNOo452.png',
        content: '有很多新功能哦~',
        btnLabels: ['我知道了','升级'],
        onSuccess: function(resp) {
            if (resp.btnIndex == 0) {
                alert('取消');
            } else {
                alert('确定');
            }
        },
        onFail: function(error) {
            alert('操作失败,错误码:' + error.errorCode);
        }
    });
    

    方法名:FSOpen.widget.showModal JS版本:2.0.0 客户端支持版本:5.4.0及以上

    调用参数说明:

    参数 类型 必须 说明
    title String 否 弹窗标题
    imgUrl String 否 弹窗图片内容,默认为空不显示
    content String 否 弹窗文本内容,默认为空
    btnLabels String 是 弹窗左右按钮的文本,最多两个。

    成功回调返回参数:

    参数 类型 说明
    btnIndex Number 点击的按钮索引,从0开始,从左到右分别是0、1

    # 显示带输入框的窗口

    代码样例

    FSOpen.widget.showPrompt({
        title: '标题',
        content: '消息内容',
        btnLabels: ['取消','确定'],
        onSuccess: function(resp) {
            if (resp.btnIndex == 0) {
                alert('取消');
            } else {
                alert('确定');
            }
        },
        onFail: function(error) {
            alert('操作失败,错误码:' + error.errorCode);
        }
    });
    

    方法名:FSOpen.widget.showPrompt JS版本:2.0.0 客户端支持版本:5.4.0及以上

    调用参数说明:

    参数 类型 必须 说明
    title String 否 弹窗标题说明
    content String 否 弹窗消息内容
    btnLabels String 是 弹窗左右按钮的文本,最多两个。

    成功回调返回参数:

    参数 类型 说明
    btnIndex Number 点击的按钮索引,从0开始,从左到右分别是0、1
    value String 弹窗输入框的值

    # 显示Toast

    代码样例

    FSOpen.widget.showToast({
        icon: 'success',
        text: '提示信息',
        duration: 3000,
        delay: 1000,
        onSuccess: function(resp) {
            // do sth
        },
        onFail: function(error) {
            // do sth
        }
    });
    

    方法名:FSOpen.widget.showToast JS版本:2.0.0 客户端支持版本:5.4.0及以上

    调用参数说明:

    参数 类型 必须 说明
    text String 否 要显示的提示信息,默认为空
    icon String 否 要显示的图标样式,有success和error。默认为success
    duration Number 否 显示持续时间,单位毫秒,默认按系统规范
    delay Number 否 延迟显示时间,单位毫秒,默认0

    # 显示日期选择控件

    FSOpen.widget.showDateTimePicker({
        dateType: 'month',
        defaultValue: '2015-03-24',
        onSuccess: function(resp) {
            alert('选择的时间值:' + resp.value);
        },
        onFail: function(error) {
            alert('获取失败,错误码:' + error.errorCode);
        }
    });
    

    方法名:FSOpen.widget.showDateTimePicker JS版本:2.0.0 客户端支持版本:5.4.0及以上

    调用参数说明:

    参数 类型 必须 说明
    dateType String 是 时间选择器的选择类型。此类型将决定输入和输出的格式类型
    defaultValue String 否 时间默认值,若为空将根据dateType获取当前时间的对应值,如dateType是time(时分)类型,则为24小时制。

    dateType参数说明:

    值 输入输出格式 说明
    month yyyy-MM 年月
    day yyyy-MM-dd 年月日
    time HH:mm 时分,24小时制
    week yyyy-MM-dd~yyyy-MM-dd 周
    day|time yyyy-MM-dd HH:mm 年月日 时分

    成功回调返回参数:

    参数 类型 说明
    value String 选择的时间字符串,与dateType对应。如果有时分秒,则为24小时制。

    # 显示文本编辑器

    代码样例

    FSOpen.widget.showEditor({
        min: 1,
        max: 140,
        placeholder: '请输入内容',
        navbar: {
            title: '标题',
            leftLabel: '返回',
            leftArrow: true,
            rightLabel: '发送'
        },
        backFillData: {
            content: '我是输入',
        },
        components: ['emoji', 'at'],
        onSuccess: function(resp) {
            alert('你的输入是:' + resp.content);
        },
        onFail: function(error) {
            alert('操作失败,错误码:' + error.errorCode);
        }
    });
    

    方法名:FSOpen.widget.showEditor JS版本:2.0.0 客户端支持版本:5.4.0及以上

    调用参数说明:

    参数 类型 必须 说明
    min Number 否 最小输入字符限制,不区分中英文。默认不做限制(可以为空)
    max Number 否 最大输入字符限制,不区分中英文。系统最多支持3000字。
    placeholder String 否 占位符。默认为空
    navbar Object 否 输入框标题栏控制,具体说明见下面。
    backFillData Object 否 回填数据内容,仅支持文本数据回填,具体说明见下面。默认为空
    components Array[String] 否 快捷输入组件。目前支持:emoji-表情,at-@功能

    navbar参数字段说明:

    参数 类型 说明
    title String 顶部中间抬头文本
    leftLabel String 顶部左侧按钮文本
    leftArrow Boolean 顶部左侧按钮是否使用箭头图标,iOS适用。
    rightLabel String 顶部右侧按钮文本

    backFillData参数字段说明:

    参数 类型 说明
    content String 需要回填的文本内容

    成功回调返回参数:

    参数 类型 说明
    content String 输入纯文本内容,如“批准[微笑],@北京研发中心”。Emoji表情由H5端自行解析
    Webview
    纷享服务

    ← Webview 纷享服务 →

    • 跟随系统
    • 浅色模式
    • 深色模式
    • 阅读模式