文档管理中心
API参考快游戏快游戏界面交互

交互

说明

从1078版本开始,接口前缀由hbs调整为qg,原hbs仍支持。

接口定义

展开

接口

描述

qg.showToast(Object object)

显示消息提示框。

qg.showModal(Object object)

显示模态对话框。

qg.showLoading(Object object)

显示 loading 提示框。

qg.showActionSheet(Object object)

显示操作菜单。

qg.hideToast(Object object)

隐藏消息提示框。

qg.hideLoading(Object object)

隐藏loading提示框。

qg.showToast(Object object)

  • 描述

    显示消息提示框。

  • 参数object
    展开

    参数

    类型

    默认值

    必填(M)/选填(O)

    说明

    title

    string

    -

    O

    提示框的标题。title和message需至少有一个参数赋值。若未传入此参数值,将显示message的参数值。

    icon

    string

    'success'

    O

    展示的图标。设置值如下:

    • success:显示成功图标,此时title文本最多显示 14个字符长度。
    • loading:显示加载图标,此时 title 文本最多显示14个字符长度。
    • none:不显示图标,此时 title 文本最多可显示两行。

    image

    string

    -

    O

    自定义图标路径,image的优先级高于icon。

    message(1078+)

    string

    -

    O

    提示的内容。title和message需至少有一个参数赋值,且优先展示title的参数值。

    duration

    number

    0或者1500

    O

    提示延迟时间。

    • 当title为空,且message有值时,duration的可选值为0(短时)和1(长时),默认值为0。
    • 当title有值时,默认值为1500ms。

    mask

    boolean

    -

    O

    是否显示透明图层:

    • true:屏蔽触摸事件,弹框出现时不可以点击游戏内其它控件。
    • false:默认值。不屏蔽触摸事件,可以点击游戏内其它控件。

    success

    function

    -

    O

    接口调用成功的回调函数。

    fail

    function

    -

    O

    接口调用失败的回调函数。

    complete

    function

    -

    O

    若有函数传入,将在成功、失败后调用该函数。

  • 示例代码
    收起
    自动换行
    深色代码主题
    复制
    1. qg.showToast({
    2. title: '成功',
    3. icon: 'success',
    4. duration: 2000
    5. })

qg.showModal(Object object)

  • 描述

    显示模态对话框。

  • 参数object
    展开

    参数

    类型

    默认值

    必填(M)/选填(O)

    说明

    title

    string

    -

    O

    提示的标题。

    content

    string

    -

    O

    提示的内容。

    showCancel

    boolean

    true

    O

    是否显示取消按钮。

    cancelText

    string

    '取消'

    O

    取消按钮的文字,最多 4 个字符。

    cancelColor

    string

    #576B95

    O

    取消按钮的文字颜色,必须是 16 进制格式的颜色字符串。

    confirmText

    string

    '确定'

    O

    确认按钮的文字,最多 4 个字符。

    confirmColor

    string

    #576B95

    O

    确认按钮的文字颜色,必须是 16 进制格式的颜色字符串。

    success

    function

    -

    O

    接口调用成功的回调函数,请参见success回调函数参数

    fail

    function

    -

    O

    接口调用失败的回调函数。

    complete

    function

    -

    O

    若有函数传入,将在成功、失败后调用该函数。

    • success回调函数参数
      展开

      参数名

      类型

      说明

      confirm(1078+)

      boolean

      true表示用户点击了确定。

      cancel(1078+)

      boolean

      true表示用户点击了取消。

  • 示例代码
    收起
    自动换行
    深色代码主题
    复制
    1. qg.showModal({
    2. title: '提示',
    3. content: '这是一个模态弹窗',
    4. success (res) {
    5. if (res.confirm) {
    6. console.log('用户点击确定')
    7. } else if (res.cancel) {
    8. console.log('用户点击取消')
    9. }
    10. }
    11. })

qg.showLoading(Object object)

  • 描述

    显示 loading 提示框,需主动调用 qg.hideLoading 才能关闭提示框。

  • 参数object
    展开

    参数

    类型

    默认值

    必填(M)/选填(O)

    说明

    title

    string

    -

    M

    提示的内容。

    mask

    boolean

    false

    O

    是否显示透明图层,设置为true,可以屏蔽触摸事件。

    success

    function

    -

    O

    接口调用成功的回调函数,请参见success回调函数参数

    fail

    function

    -

    O

    接口调用失败的回调函数。

    complete

    function

    -

    O

    若有函数传入,将在成功、失败后调用该函数。

    • success回调函数参数
      展开

      参数

      类型

      说明

      cancel

      boolean

      用户是否选择取消loading提示框。若为 true 时,用户按 back 键取消 loading 提示框。

  • 示例代码
    收起
    自动换行
    深色代码主题
    复制
    1. qg.showLoading({
    2. title: '加载中',
    3. })
    4. setTimeout(function () {
    5. qg.hideLoading()
    6. }, 2000)

qg.showActionSheet(Object object)

  • 描述

    显示操作菜单。

  • 参数object
    展开

    参数

    类型

    默认值

    必填(M)/选填(O)

    说明

    itemList

    array string

    -

    M

    按钮的文字数组,数组长度最大为6。

    itemColor

    string

    #000000

    O

    按钮的颜色。

    success

    function

    -

    O

    接口调用成功的回调函数,请参见success回调函数参数

    fail

    function

    -

    O

    接口调用失败的回调函数。

    complete

    function

    -

    O

    若有函数传入,将在成功、失败后调用该函数。

    • success回调函数参数
      展开

      参数

      类型

      说明

      tapIndex

      number

      参数itemList中的索引。用户点击的按钮序号,从上到下的顺序,从0开始。

  • 示例代码
    收起
    自动换行
    深色代码主题
    复制
    1. qg.showActionSheet({
    2. itemList: ['A', 'B', 'C'],
    3. success (res) {
    4. console.log(res)
    5. },
    6. fail (res) {
    7. console.log(res.errMsg)
    8. }
    9. })

qg.hideToast(Object object)

  • 描述

    隐藏消息提示框。

  • 参数object
    展开

    参数

    类型

    默认值

    必填(M)/选填(O)

    说明

    success

    function

    -

    O

    接口调用成功的回调函数。

    fail

    function

    -

    O

    接口调用失败的回调函数。

    complete

    function

    -

    O

    若有函数传入,将在成功、失败后调用该函数。

  • 示例代码
    收起
    自动换行
    深色代码主题
    复制
    1. qg.hideToast ({
    2. success (res) {
    3. console.log('success')
    4. },
    5. fail (res) {
    6. console.log('fail')
    7. }
    8. })

qg.hideLoading(Object object)

  • 描述

    隐藏loading提示框。

  • 参数object
    展开

    参数

    类型

    默认值

    必填(M)/选填(O)

    说明

    success

    function

    -

    O

    接口调用成功的回调函数。

    fail

    function

    -

    O

    接口调用失败的回调函数。

    complete

    function

    -

    O

    若有函数传入,将在成功、失败后调用该函数。

  • 示例代码
    收起
    自动换行
    深色代码主题
    复制
    1. qg.hideLoading ({
    2. success (res) {
    3. console.log('success')
    4. },
    5. fail (res) {
    6. console.log('fail')
    7. }
    8. })
在 API参考 中进行搜索
请输入您想要搜索的关键词