Vue3全局提示(Message)

简介: 这是一个可定制的消息提示组件,支持自动关闭延迟及消息位置设置。通过调用不同方法(如 `info`, `success`, `error`, `warning`, `loading`)展示多种样式的消息提示,并按顺序自动关闭。组件效果包括在线预览及具体示例。组件基于 Vue 开发,并利用 `requestAnimationFrame` 实现延时功能,可在页面中轻松集成与使用。

可自定义设置以下属性:

  • 自动关闭的延时(duration),类型:number,单位 ms,默认 3000

  • 消息距离顶部的位置(top),类型:string | number,单位 px,默认 30

调用一次只展示一个提示,调用多次则依次展示多个,按照调用先后顺序依次自动关闭。

效果如下图:在线预览

info()调用:

success()调用:

error()调用:

warning()调用:

loading()调用:

①创建全局提示组件Message:

<script setup lang="ts">
import { ref, computed, watch } from 'vue'
import { rafTimeout, cancelRaf } from '../utils'
interface Props {
  duration?: number // 自动关闭的延时,单位 ms
  top?: string | number // 消息距离顶部的位置,单位 px
}
const props = withDefaults(defineProps<Props>(), {
  duration: 3000,
  top: 30
})
interface Message {
  content: string
  mode: string
}
const resetTimer = ref()
const showMessage = ref<boolean[]>([])
const hideTimers = ref<any[]>([])
const messageContent = ref<Message[]>([])
const messageTop = computed(() => {
  if (typeof props.top === 'number') {
    return props.top + 'px'
  }
  return props.top
})
const clear = computed(() => {
  // 所有提示是否已经全部变为false
  return showMessage.value.every((show) => !show)
})
watch(clear, (to, from) => {
  // 所有提示都消失后重置
  if (!from && to) {
    resetTimer.value = rafTimeout(() => {
      messageContent.value.splice(0)
      showMessage.value.splice(0)
    }, 300)
  }
})
function onEnter(index: number) {
  hideTimers.value[index] && cancelRaf(hideTimers.value[index])
}
function onLeave(index: number) {
  onHideMessage(index)
}
function show() {
  resetTimer.value && cancelRaf(resetTimer.value)
  const index = messageContent.value.length - 1
  showMessage.value[index] = true
  onHideMessage(index)
}
function info(content: string) {
  messageContent.value.push({
    content,
    mode: 'info'
  })
  show()
}
function success(content: string) {
  messageContent.value.push({
    content,
    mode: 'success'
  })
  show()
}
function error(content: string) {
  messageContent.value.push({
    content,
    mode: 'error'
  })
  show()
}
function warning(content: string) {
  messageContent.value.push({
    content,
    mode: 'warning'
  })
  show()
}
function loading(content: string) {
  messageContent.value.push({
    content,
    mode: 'loading'
  })
  show()
}
defineExpose({
  info,
  success,
  error,
  warning,
  loading
})
const emit = defineEmits(['close'])
function onHideMessage(index: number) {
  hideTimers.value[index] = rafTimeout(() => {
    showMessage.value[index] = false
    emit('close')
  }, props.duration)
}
</script>
<template>
  <div class="m-message-wrap" :style="`top: ${messageTop};`">
    <TransitionGroup name="slide-fade">
      <div class="m-message" v-show="showMessage[index]" v-for="(message, index) in messageContent" :key="index">
        <div class="m-message-content" @mouseenter="onEnter(index)" @mouseleave="onLeave(index)">
          <svg
            v-if="message.mode === 'info'"
            class="icon-svg icon-info"
            viewBox="64 64 896 896"
            data-icon="info-circle"
            aria-hidden="true"
            focusable="false"
          >
            <path
              d="M512 64C264.6 64 64 264.6 64 512s200.6 448 448 448 448-200.6 448-448S759.4 64 512 64zm32 664c0 4.4-3.6 8-8 8h-48c-4.4 0-8-3.6-8-8V456c0-4.4 3.6-8 8-8h48c4.4 0 8 3.6 8 8v272zm-32-344a48.01 48.01 0 0 1 0-96 48.01 48.01 0 0 1 0 96z"
            ></path>
          </svg>
          <svg
            v-if="message.mode === 'success'"
            class="icon-svg icon-success"
            viewBox="64 64 896 896"
            data-icon="check-circle"
            aria-hidden="true"
            focusable="false"
          >
            <path
              d="M512 64C264.6 64 64 264.6 64 512s200.6 448 448 448 448-200.6 448-448S759.4 64 512 64zm193.5 301.7l-210.6 292a31.8 31.8 0 0 1-51.7 0L318.5 484.9c-3.8-5.3 0-12.7 6.5-12.7h46.9c10.2 0 19.9 4.9 25.9 13.3l71.2 98.8 157.2-218c6-8.3 15.6-13.3 25.9-13.3H699c6.5 0 10.3 7.4 6.5 12.7z"
            ></path>
          </svg>
          <svg
            v-if="message.mode === 'error'"
            class="icon-svg icon-error"
            viewBox="64 64 896 896"
            data-icon="close-circle"
            aria-hidden="true"
            focusable="false"
          >
            <path
              d="M512 64C264.6 64 64 264.6 64 512s200.6 448 448 448 448-200.6 448-448S759.4 64 512 64zm165.4 618.2l-66-.3L512 563.4l-99.3 118.4-66.1.3c-4.4 0-8-3.5-8-8 0-1.9.7-3.7 1.9-5.2l130.1-155L340.5 359a8.32 8.32 0 0 1-1.9-5.2c0-4.4 3.6-8 8-8l66.1.3L512 464.6l99.3-118.4 66-.3c4.4 0 8 3.5 8 8 0 1.9-.7 3.7-1.9 5.2L553.5 514l130 155c1.2 1.5 1.9 3.3 1.9 5.2 0 4.4-3.6 8-8 8z"
            ></path>
          </svg>
          <svg
            v-if="message.mode === 'warning'"
            class="icon-svg icon-warning"
            viewBox="64 64 896 896"
            data-icon="exclamation-circle"
            aria-hidden="true"
            focusable="false"
          >
            <path
              d="M512 64C264.6 64 64 264.6 64 512s200.6 448 448 448 448-200.6 448-448S759.4 64 512 64zm-32 232c0-4.4 3.6-8 8-8h48c4.4 0 8 3.6 8 8v272c0 4.4-3.6 8-8 8h-48c-4.4 0-8-3.6-8-8V296zm32 440a48.01 48.01 0 0 1 0-96 48.01 48.01 0 0 1 0 96z"
            ></path>
          </svg>
          <svg
            v-if="message.mode === 'loading'"
            class="icon-svg icon-loading circular"
            viewBox="0 0 50 50"
            focusable="false"
          >
            <circle class="path" cx="25" cy="25" r="20" fill="none"></circle>
          </svg>
          <p class="message-content">{
  { message.content }}</p>
        </div>
      </div>
    </TransitionGroup>
  </div>
</template>
<style lang="less" scoped>
// 滑动渐变过渡效果
.slide-fade-move,
.slide-fade-enter-active,
.slide-fade-leave-active {
  transition: all 0.3s;
}
.slide-fade-enter-from,
.slide-fade-leave-to {
  transform: translateY(-16px);
  -ms-transform: translateY(-16px); /* IE 9 */
  -webkit-transform: translateY(-16px); /* Safari and Chrome */
  opacity: 0;
}
.slide-fade-leave-active {
  position: absolute;
  left: 0;
  right: 0;
  margin: 0 auto;
}
.m-message-wrap {
  position: fixed;
  z-index: 999; // 突出显示该层级
  width: 100%;
  left: 0;
  right: 0;
  pointer-events: none; // 保证整个message区域不遮挡背后元素响应鼠标事件
  .m-message {
    text-align: center;
    &:not(:last-child) {
      margin-bottom: 8px;
    }
    .m-message-content {
      display: inline-flex;
      align-items: center;
      padding: 9px 12px;
      background: #fff;
      border-radius: 8px;
      box-shadow:
        0 6px 16px 0 rgba(0, 0, 0, 0.08),
        0 3px 6px -4px rgba(0, 0, 0, 0.12),
        0 9px 28px 8px rgba(0, 0, 0, 0.05);
      pointer-events: auto; // 保证内容区域部分可以正常响应鼠标事件
      .icon-svg {
        display: inline-block;
        width: 16px;
        height: 16px;
        margin-right: 8px;
      }
      .icon-info {
        fill: @themeColor;
      }
      .icon-success {
        fill: #52c41a;
      }
      .icon-warning {
        fill: #faad14;
      }
      .icon-error {
        fill: #ff4d4f;
      }
      .icon-loading {
        stroke: @themeColor;
      }
      .circular {
        display: inline-block;
        animation: loading-rotate 2s linear infinite;
        @keyframes loading-rotate {
          100% {
            transform: rotate(360deg);
          }
        }
        .path {
          stroke-dasharray: 90, 150;
          stroke-dashoffset: 0;
          stroke-width: 5;
          stroke-linecap: round;
          animation: loading-dash 1.5s ease-in-out infinite;
          @keyframes loading-dash {
            0% {
              stroke-dasharray: 1, 200;
              stroke-dashoffset: 0;
            }

            50% {
              stroke-dasharray: 90, 150;
              stroke-dashoffset: -40px;
            }
            100% {
              stroke-dasharray: 90, 150;
              stroke-dashoffset: -120px;
            }
          }
        }
      }
      .message-content {
        display: inline-block;
        font-size: 14px;
        color: rgba(0, 0, 0, 0.88);
        line-height: 22px;
      }
    }
  }
}
</style>

②在要使用的页面引入:

<script setup lang="ts">
import Message from './Message.vue'
import { ref } from 'vue'
const message = ref()

function onInfo(content: string) {
  message.value.info(content) // info调用
}
function onSuccess(content: string) {
  message.value.success(content) // success调用
}
function onError(content: string) {
  message.value.error(content) // error调用
}
function onWarning(content: string) {
  message.value.warning(content) // warning调用
}
function onLoading(content: string) {
  message.value.loading(content) // loading调用
}
function onClose() {
  console.log('close')
}
</script>
<template>
  <div>
    <h1>{
  { $route.name }} {
  { $route.meta.title }}</h1>
    <h2 class="mt30 mb10">基本使用</h2>
    <Space vertical>
      <Button type="primary" @click="onInfo('This is a normal message')">Info</Button>
      <Button type="primary" @click="onSuccess('This is a success message')">Success</Button>
      <Button type="primary" @click="onError('This is a error message')">Error</Button>
      <Button type="primary" @click="onWarning('This is a warning message')">Warning</Button>
      <Button type="primary" @click="onLoading('This is a loading message')">Loading</Button>
    </Space>
    <Message ref="message" @close="onClose" />
  </div>
</template>
相关文章
|
9天前
|
存储 JavaScript 前端开发
vue3的脚手架模板你真的了解吗?里面有很多值得我们学习的地方!
【10月更文挑战第21天】 vue3的脚手架模板你真的了解吗?里面有很多值得我们学习的地方!
vue3的脚手架模板你真的了解吗?里面有很多值得我们学习的地方!
|
12天前
|
API
vue3知识点:provide 与 inject
vue3知识点:provide 与 inject
27 4
vue3知识点:provide 与 inject
|
12天前
|
API
vue3知识点:readonly 与 shallowReadonly
vue3知识点:readonly 与 shallowReadonly
22 1
vue3知识点:readonly 与 shallowReadonly
|
6天前
|
JavaScript 前端开发 开发者
Vue 3中的Proxy
【10月更文挑战第23天】Vue 3中的`Proxy`为响应式系统带来了更强大、更灵活的功能,解决了Vue 2中响应式系统的一些局限性,同时在性能方面也有一定的提升,为开发者提供了更好的开发体验和性能保障。
19 7
|
7天前
|
前端开发 数据库
芋道框架审批流如何实现(Cloud+Vue3)
芋道框架审批流如何实现(Cloud+Vue3)
25 3
|
6天前
|
JavaScript 数据管理 Java
在 Vue 3 中使用 Proxy 实现数据双向绑定的性能如何?
【10月更文挑战第23天】Vue 3中使用Proxy实现数据双向绑定在多个方面都带来了性能的提升,从更高效的响应式追踪、更好的初始化性能、对数组操作的优化到更优的内存管理等,使得Vue 3在处理复杂的应用场景和大量数据时能够更加高效和稳定地运行。
24 1
|
6天前
|
JavaScript 开发者
在 Vue 3 中使用 Proxy 实现数据的双向绑定
【10月更文挑战第23天】Vue 3利用 `Proxy` 实现了数据的双向绑定,无论是使用内置的指令如 `v-model`,还是通过自定义事件或自定义指令,都能够方便地实现数据与视图之间的双向交互,满足不同场景下的开发需求。
25 1
|
8天前
|
前端开发 JavaScript
简记 Vue3(一)—— setup、ref、reactive、toRefs、toRef
简记 Vue3(一)—— setup、ref、reactive、toRefs、toRef
|
9天前
Vue3 项目的 setup 函数
【10月更文挑战第23天】setup` 函数是 Vue3 中非常重要的一个概念,掌握它的使用方法对于开发高效、灵活的 Vue3 组件至关重要。通过不断的实践和探索,你将能够更好地利用 `setup` 函数来构建优秀的 Vue3 项目。
|
12天前
|
JavaScript Java API
vue3知识点:setup
vue3知识点:setup
26 5