此接口用于显示一个弱提示,可选择多少秒之后消失。

toast 接口的使用方法

AlipayJSBridge.call('toast', {
  content: '操作成功',
  type: 'success',
  duration: 2000
}, function() {
  alert("toast消失后执行");
});

// 可以通过 hideToast 接口隐藏已经弹出的 toast

AlipayJSBridge.call('hideToast', {}, function() {
});

代码示例

<h1>点击以下按钮看不同效果</h1>
<a href="javascript:void(0)" class="btn success">显示成功信息</a>
<a href="javascript:void(0)" class="btn fail">显示失败信息</a>
<a href="javascript:void(0)" class="btn exception">显示异常信息</a>
<a href="javascript:void(0)" class="btn none">只显示信息</a>
<a href="javascript:void(0)" class="btn duration">3.5s信息显示</a>

<script>
function toast(config, callback){
  AlipayJSBridge.call('toast',config, callback);
}

function ready(callback) {
  // 如果 jsbridge 已经注入则直接调用
  if (window.AlipayJSBridge) {
    callback && callback();
  } else {
    // 如果没有注入则监听注入的事件
    document.addEventListener('AlipayJSBridgeReady', callback, false);
  }
}
ready(function() {
  document.querySelector('.success').addEventListener('click', function() {
    toast({
      content: '操作成功',
      type: 'success'
    });
  });

  document.querySelector('.fail').addEventListener('click', function() {
    toast({
      content: '网络繁忙,请稍后再试',
      type: 'fail'
    });
  });

  document.querySelector('.exception').addEventListener('click', function() {
    toast({
      content: '发生异常,请注意',
      type: 'exception'
    });
  });

  document.querySelector('.none').addEventListener('click', function() {
    toast({
      content: '欢迎光临',
    });
  });

  document.querySelector('.duration').addEventListener('click', function() {
    toast({
      content: '请稍等',
      duration: 3500,
    }, function(e){
      alert('toast消失回调');
    });
  });
});
</script>

API 说明

重要
  • toast 虽然会自动关闭,但是也可以通过 hideLoading 来关闭,这种使用方式不常见,但是要防止被 hideLoading 关闭。

  • 对于 Android 系统,如果系统通知关闭,则此弹框不会出现。

  • 在 Android 10.1.2 以下版本中,duration 显示时长只支持 2000/3500 两种,小于或等于 2000 的选择 2000,大于 2000 的选择 3500。

AlipayJSBridge.call('toast', {
  content, type, duration
}, fn)

入参

属性

类型

描述

必填

默认值

content

string

文字内容。

Y

“”

type

string

参数值可以是 none、success、fail、exception。 当为 excption 类型时,必须传递文案。

N

“none”

duration

int

显示时长,单位为毫秒。

N

2000

xOffset

float

左为正方向,单位为 px。

N

0

yOffset

float

上为正方向,单位为 px。

N

0

fn

function

回调函数,当 toast 消失后被调用。

N

-