Notify 消息提示

介绍

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

函数调用

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

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

手动引入样式

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

  1. import 'vant/es/notify/style';

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

组件调用

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

  1. import { createApp } from 'vue';
  2. import { Notify } from 'vant';
  3. // 全局注册
  4. const app = createApp();
  5. app.use(Notify);
  6. // 局部注册
  7. export default {
  8. components: {
  9. [Notify.Component.name]: Notify.Component,
  10. },
  11. };

script setup 中,可以通过以下方式使用:

  1. <script setup>
  2. const VanNotify = Notify.Component;
  3. </script>
  4. <template>
  5. <!-- 中划线命名 -->
  6. <van-notify />
  7. <!-- 也支持大驼峰命名 -->
  8. <VanNotify>
  9. </template>

代码演示

基础用法

  1. Notify('通知内容');

通知类型

支持 primarysuccesswarningdanger 四种通知类型,默认为 danger

  1. // 主要通知
  2. Notify({ type: 'primary', message: '通知内容' });
  3. // 成功通知
  4. Notify({ type: 'success', message: '通知内容' });
  5. // 危险通知
  6. Notify({ type: 'danger', message: '通知内容' });
  7. // 警告通知
  8. Notify({ type: 'warning', message: '通知内容' });

自定义通知

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

  1. Notify({
  2. message: '自定义颜色',
  3. color: '#ad0000',
  4. background: '#ffe1e1',
  5. });
  6. Notify({
  7. message: '自定义位置',
  8. position: 'bottom',
  9. });
  10. Notify({
  11. message: '自定义时长',
  12. duration: 1000,
  13. });

全局方法

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

  1. export default {
  2. mounted() {
  3. this.$notify('提示文案');
  4. },
  5. };

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

组件调用

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

  1. <van-button type="primary" text="组件调用" @click="showNotify" />
  2. <van-notify v-model:show="show" type="success">
  3. <van-icon name="bell" style="margin-right: 4px;" />
  4. <span>通知内容</span>
  5. </van-notify>
  1. import { ref } from 'vue';
  2. export default {
  3. setup() {
  4. const show = ref(false);
  5. const showNotify = () => {
  6. show.value = true;
  7. setTimeout(() => {
  8. show.value = false;
  9. }, 2000);
  10. };
  11. return {
  12. show,
  13. showNotify,
  14. };
  15. },
  16. };

API

方法

方法名说明参数返回值
Notify展示提示options | messagenotify 实例
Notify.clear关闭提示-void
Notify.setDefaultOptions修改默认配置,对所有 Notify 生效optionsvoid
Notify.resetDefaultOptions重置默认配置,对所有 Notify 生效-void

Options

参数说明类型默认值
type类型,可选值为 primary success warningNotifyTypedanger
message展示文案,支持通过\n换行string-
duration展示时长(ms),值为 0 时,notify 不会消失number | string3000
position v3.4.0弹出位置,可选值为 bottomNotifyPositiontop
color字体颜色stringwhite
background背景颜色string-
className自定义类名string | Array | object-
lockScroll v3.0.7是否锁定背景滚动booleanfalse
onClick点击时的回调函数(event: MouseEvent): void-
onOpened完全展示后的回调函数() => void-
onClose关闭时的回调函数() => void-

类型定义

组件导出以下类型定义:

  1. import type {
  2. NotifyType,
  3. NotifyProps,
  4. NotifyOptions,
  5. NotifyPosition,
  6. } from 'vant';

主题定制

样式变量

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

名称默认值描述
—van-notify-text-colorvar(—van-white)-
—van-notify-paddingvar(—van-padding-xs) var(—van-padding-md)-
—van-notify-font-sizevar(—van-font-size-md)-
—van-notify-line-heightvar(—van-line-height-md)-
—van-notify-primary-background-colorvar(—van-primary-color)-
—van-notify-success-background-colorvar(—van-success-color)-
—van-notify-danger-background-colorvar(—van-danger-color)-
—van-notify-warning-background-colorvar(—van-warning-color)-

Notify 消息通知 - 图1