Notify 消息提示

介绍

在页面顶部展示消息提示，支持函数调用和组件调用两种方式。

函数调用

Notify 是一个函数，调用后会直接在页面中弹出相应的消息提示。

import { Notify } from 'vant';
Notify('通知内容');

手动引入样式

Notify 组件是以函数形式提供的，如果项目中使用 unplugin-vue-components 插件来自动引入组件样式，则无法正确识别 Notify 组件，因此需要手动引入 Notify 组件的样式：

import 'vant/es/notify/style';

你可以在项目的入口文件或公共模块中引入 Notify 组件的样式，这样在业务代码中使用 Notify 时，便不再需要重复引入样式了。

组件调用

通过组件调用 Notify 时，可以通过下面的方式进行注册：

import { createApp } from 'vue';
import { Notify } from 'vant';
// 全局注册
const app = createApp();
app.use(Notify);
// 局部注册
export default {
  components: {
    [Notify.Component.name]: Notify.Component,
  },
};

在 script setup 中，可以通过以下方式使用：

<script setup>
  const VanNotify = Notify.Component;
</script>
<template>
  <!-- 中划线命名 -->
  <van-notify />
  <!-- 也支持大驼峰命名 -->
  <VanNotify>
</template>

代码演示

基础用法

Notify('通知内容');

通知类型

支持 primary、success、warning、danger 四种通知类型，默认为 danger。

// 主要通知
Notify({ type: 'primary', message: '通知内容' });
// 成功通知
Notify({ type: 'success', message: '通知内容' });
// 危险通知
Notify({ type: 'danger', message: '通知内容' });
// 警告通知
Notify({ type: 'warning', message: '通知内容' });

自定义通知

自定义消息通知的颜色、位置和展示时长。

Notify({
  message: '自定义颜色',
  color: '#ad0000',
  background: '#ffe1e1',
});
Notify({
  message: '自定义位置',
  position: 'bottom',
});
Notify({
  message: '自定义时长',
  duration: 1000,
});

全局方法

通过 app.use 全局注册 Notify 组件后，会自动在 app 的所有子组件上挂载 $notify 方法，便于在组件内调用。

export default {
  mounted() {
    this.$notify('提示文案');
  },
};

Tips: 由于 setup 选项中无法访问 this，因此不能使用上述方式，请通过 import 引入。

组件调用

如果需要在 Notify 内嵌入组件或其他自定义内容，可以使用组件调用的方式。

<van-button type="primary" text="组件调用" @click="showNotify" />
<van-notify v-model:show="show" type="success">
  <van-icon name="bell" style="margin-right: 4px;" />
  <span>通知内容</span>
</van-notify>

import { ref } from 'vue';
export default {
  setup() {
    const show = ref(false);
    const showNotify = () => {
      show.value = true;
      setTimeout(() => {
        show.value = false;
      }, 2000);
    };
    return {
      show,
      showNotify,
    };
  },
};

API

方法

Options

类型定义

组件导出以下类型定义：

import type {
  NotifyType,
  NotifyProps,
  NotifyOptions,
  NotifyPosition,
} from 'vant';

主题定制

样式变量

组件提供了下列 CSS 变量，可用于自定义样式，使用方法请参考 ConfigProvider 组件。