Toast 吐司请使用手机扫码体验

轻提示。

基本用法

文字提示

  1. javascript
    export default {
  2. mounted() {
  3. this.$toast.text('提示信息');
  4. }
  5. }

成功提示

  1. javascript
    export default {
  2. mounted() {
  3. this.$toast.success('操作成功!');
  4. }
  5. }

失败提示

  1. javascript
    export default {
  2. mounted() {
  3. this.$toast.fail('操作失败!');
  4. }
  5. }

警告提示

  1. javascript
    export default {
  2. mounted() {
  3. this.$toast.warn('确定删除?');
  4. }
  5. }

加载提示

  1. javascript
    // 带文案,显示透明遮罩层(默认),自动消失
  2. this.$toast.loading('加载中...',{
  3. duration:3000
  4. });
  5. //带文案,显示半透明遮罩层,自动消失,点击遮罩层后消失
  6. this.$toast.loading('加载中...',{
  7. duration:3000,
  8. coverColor: "rgba(0,0,0,0.5)",
  9. closeOnClickOverlay: true
  10. });
  11. //不会自动消失(默认),不带遮罩层
  12. this.loading = this.$toast.loading({
  13. cover: false
  14. });
  15. //手动关闭上面的Loading
  16. this.loading.hide();

自定义样式

  1. javascript
    //自定义背景颜色/透明度
  2. this.$toast.text('自定义背景颜色/透明度',{
  3. bgColor:'rgba(50, 50, 50, 0.9)'
  4. });
  5. //自定义class
  6. this.$toast.text('自定义class',{
  7. customClass:'my-class'
  8. });
  9. //自定义Icon
  10. this.$toast.text('自定义Icon',{
  11. icon:"https://img13.360buyimg.com/imagetools/jfs/t1/98294/28/14470/22072/5e65ba08E865683aa/ded7441bdd098511.png"
  12. });

共享实例

如果不设置id,多个Toast将默认拥有相同的id,它们将共享一个实例(loading类型与其他类型实例不共享),新的内容和设置将取代旧的,多个Toast不能同时出现。如果不需要共享实例,可以给其设置id。

  1. javascript
    //二者id不同,不会共享一个实例
  2. this.$toast.success(msg,{
  3. id:123
  4. });
  5. this.$toast.text(msg,{
  6. id:321,
  7. duration:4000
  8. });

支持在JS模块中导入使用

  1. javascript
    import { Toast } from "@nutui/nutui";
  2. Toast.text('在js模块中使用');
  3. // 返回实例,可以手动调用实例中的hide方法关闭提示
  4. const toast = Toast.loading('在js模块中使用');
  5. toast.hide();

修改默认配置

通过Toast.setDefaultOptions函数可以全局修改 Toast 的默认配置,值得注意的是,loading无法支持默认配置的修改和重置

  1. js
    // 更改所有Toast展示时长设置为5000毫秒
  2. Toast.setDefaultOptions({
  3. duration: 5000,
  4. coverColor: "rgba(0, 0, 0, 0.2)",
  5. closeOnClickOverlay: true,
  6. cover: true
  7. });
  8. // 重置所有 Toast 的默认配置
  9. Toast.resetDefaultOptions();
  10. // 更改所有文字提示默认设置
  11. Toast.setDefaultOptions("text", {
  12. size: "large",
  13. cover: true,
  14. coverColor: "rgba(0, 0, 0, 0.2)",
  15. duration: 3000,
  16. closeOnClickOverlay: true
  17. });
  18. // 重置 text Toast 的默认配置
  19. Toast.resetDefaultOptions("text");

API

方法名说明参数返回值
Toast.text展示文字提示options/messagetoast 实例
Toast.loading展示加载提示options/messagetoast 实例
Toast.success展示成功提示options/messagetoast 实例
Toast.fail展示失败提示options/messagetoast 实例
Toast.warn展示警告提示options/messagetoast 实例
Toast.hide关闭提示force:booleanvoid
Toast.setDefaultOptions修改默认配置,对所有 Toast 生效
传入 type 可以修改指定类型的默认配置
type/optionsvoid
Toast.resetDefaultOptions重置默认配置,对所有 Toast 生效
传入 type 可以重置指定类型的默认配置
typevoid

Options

字段说明类型默认值
msg消息文本内容,支持传入HTMLString/VNode“”
id标识符,相同者共用一个实例
loading类型默认使用一个实例,其他类型默认不共用
String/Number-
duration展示时长(毫秒)
值为 0 时,toast 不会自动消失(loading类型默认为0)
Number2000
center是否展示在页面中部(为false时展示在底部)Booleantrue
bottom距页面底部的距离(像素),option.center为false时生效Booleantrue
textAlignCenter多行文案是否居中Booleantrue
bgColor背景颜色(透明度)String“rgba(46, 46, 46, 0.7)”
customClass自定义类名String“”
icon自定义图标,支持图片链接或base64格式String“”
size尺寸,small/base/large三选一String“base”
cover是否显示遮罩层,loading类型默认显示Booleanloading类型true/其他类型false
coverColor遮罩层颜色,默认透明String“rgba(0,0,0,0)”
loadingRotateloading图标是否旋转,仅对loading类型生效Booleantrue
onClose关闭时触发的事件functionnull
closeOnClickOverlay是否在点击遮罩层后关闭提示Booleanfalse

Toast 吐司 - 图1