Toast 轻提示

概述

一种轻量级反馈/提示,可以用来显示不会打断用户操作的内容,适合用于页面转场、数据交互的等场景中。

使用指南

在 .json 中引入组件

  1. "usingComponents": {
  2. "i-toast": "../../dist/toast/index"
  3. }

示例

Toast 组件主要依靠 JavaScript 主动调用,所以只需在 wxml 中添加一个组件,并设置 id,其余配置在 .js 里完成。

如果只有一个 Toast 组件,建议将 id 设置为 #toast,否则需要额外配置 selector 属性来指定。

  1. <i-button type="ghost" bind:click="handleText">只显示文本</i-button>
  2. <i-button type="ghost" bind:click="handleSuccess">成功</i-button>
  3. <i-button type="ghost" bind:click="handleWarning">警告</i-button>
  4. <i-button type="ghost" bind:click="handleError">错误</i-button>
  5. <i-button type="ghost" bind:click="handleLoading">Loading</i-button>
  6. <i-button type="ghost" bind:click="handleIcon">使用图标</i-button>
  7. <i-button type="ghost" bind:click="handleImage">使用自定义图片</i-button>
  8. <i-button type="ghost" bind:click="handleMask">无遮罩层</i-button>
  9. <i-toast id="toast" />
  1. const { $Toast } = require('../../dist/base/index');
  2. Page({
  3. handleText () {
  4. $Toast({
  5. content: '这是文本提示'
  6. });
  7. },
  8. handleSuccess () {
  9. $Toast({
  10. content: '成功的提示',
  11. type: 'success'
  12. });
  13. },
  14. handleWarning () {
  15. $Toast({
  16. content: '警告的提示',
  17. type: 'warning'
  18. });
  19. },
  20. handleError () {
  21. $Toast({
  22. content: '错误的提示',
  23. type: 'error'
  24. });
  25. },
  26. handleLoading () {
  27. $Toast({
  28. content: '加载中',
  29. type: 'loading'
  30. });
  31. },
  32. handleIcon () {
  33. $Toast({
  34. content: '使用内置的图标',
  35. icon: 'praise'
  36. });
  37. },
  38. handleImage () {
  39. $Toast({
  40. content: '使用自定义图片',
  41. image: 'https://i.loli.net/2017/08/21/599a521472424.jpg'
  42. });
  43. },
  44. handleMask () {
  45. $Toast({
  46. content: '5秒后自动关闭',
  47. icon: 'prompt',
  48. duration: 0,
  49. mask: false
  50. });
  51. setTimeout(() => {
  52. $Toast.hide();
  53. }, 5000);
  54. },
  55. });

API

$Toast properties

属性说明类型默认值
content内容String-
type内置的类型,可选值为 default、success、warning、error、loadingStringdefault
duration持续时间,单位秒,设置为 0 则不自动关闭,需调用 $Toast.hide() 方法手动关闭Number2
icon自定义图标String-
image自定义图片地址String-
mask是否显示一个隐藏的遮罩层,点击遮罩层可立即关闭组件Booleantrue
selector组件标识String#toast