Notify 消息提示

介绍

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

函数调用

为了便于使用 Notify,zebra 提供了一系列辅助函数,通过辅助函数可以快速唤起全局的消息提示。

比如使用 showNotify 函数,调用后会直接在页面中渲染对应的提示。

import { useNotify } from '../../uni_modules/zebra-ui'
const notify = useNotify()
notify.showNotify({
  message: '通知内容',
  type
})

代码演示

基础用法

import { useNotify } from '../../uni_modules/zebra-ui'
const notify = useNotify()
// 3 秒后自动关闭
notify.showNotify('通知内容');
// 主动关闭
notify.closeNotify();

通知类型

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

import { useNotify } from '../../uni_modules/zebra-ui'
const notify = useNotify()

// 主要通知
notify.showNotify({ type: 'primary', message: '通知内容' });

// 成功通知
notify.showNotify({ type: 'success', message: '通知内容' });

// 危险通知
notify.showNotify({ type: 'danger', message: '通知内容' });

// 警告通知
notify.showNotify({ type: 'warning', message: '通知内容' });

自定义通知

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

notify.showNotify({
  message: '自定义颜色',
  color: '#ad0000',
  background: '#ffe1e1',
});

notify.showNotify({
  message: '自定义位置',
  position: 'bottom',
});

notify.showNotify({
  message: '自定义时长',
  duration: 1000,
});

使用 Notify 组件

如果需要在 Notify 内嵌入组件或其他自定义内容,可以直接使用 Notify 组件,并使用默认插槽进行定制。

<z-cell is-link title="使用 Notify 组件" @click="showComponentCall" />
<z-notify
  v-model:show="show"
  type="success"
  custom-navbar
  use-component
>
  <z-icon name="notification" />
  <text style="margin-left: 8rpx">内容</text>
</z-notify>
const show = ref(false)
const showComponentCall = () => {
  show.value = true
  setTimeout(() => {
    show.value = false
  }, 2000)
}

API

方法

zebra 中导出了以下 Notify 相关的辅助函数:

方法名说明参数返回值
showNotify在页面顶部展示 NotifyNotifyOptions | stringnotify 实例
closeNotify关闭当前展示的 Notify-void
setNotifyDefaultOptions修改默认配置,影响所有的 showNotify 调用NotifyOptionsvoid
resetNotifyDefaultOptions重置默认配置,影响所有的 showNotify 调用-void

NotifyOptions

调用 showNotify 等方法时,支持传入以下选项:

参数说明类型默认值
type类型,可选值为 primary success warningNotifyTypedanger
message展示文案string-
duration展示时长(ms),值为 0 时,notify 不会消失number | string3000
z-index将组件的 z-index 层级设置为一个固定值number | string2000+
position弹出位置,可选值为 bottomNotifyPositiontop
color字体颜色stringwhite
background背景颜色string-
className自定义类名string | Array | object-
lockScroll是否锁定背景滚动booleanfalse
onClick点击时的回调函数(event: MouseEvent): void-
onOpened完全展示后的回调函数() => void-
onClose关闭时的回调函数() => void-

Props

通过组件调用 Notify 时,支持以下 Props:

参数说明类型默认值
v-model:show是否显示通知booleanfalse
type类型,可选值为 primary success warningNotifyTypedanger
message展示文案string-
z-index将组件的 z-index 层级设置为一个固定值number | string2000+
position弹出位置,可选值为 bottomNotifyPositiontop
color字体颜色stringwhite
background背景颜色string-
class-name自定义类名string | Array | object-
lock-scroll是否锁定背景滚动booleanfalse

Events

通过组件调用 Notify 时,支持以下事件:

事件名说明回调参数
click点击时的回调函数event: MouseEvent
close关闭时的回调函数-
opened完全展示后的回调函数-

Slots

通过组件调用 Notify 时,支持以下插槽:

名称说明
default自定义内容

主题定制

样式变量

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

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