useNoti

Usage

vue3-noti.vue
import { useNoti } from '@vue3-noti/core'

const noti = useNoti()

notify({
  message: 'Hi Noti',
  type: 'success',
  position: 'top-right',
  duration: 3000,
  hoverPause: true,
  closeOnClick: true,
  showProgressBar: true,
})

Type

function useNoti(): (options: NotiOptions) => void
export type NotificationType = 'success' | 'warning' | 'error' | 'info'

export type NotiPosition = 'top-left' | 'top-middle' | 'top-right' | 'bottom-left' | 'bottom-middle' | 'bottom-right'
export interface NotiOptions {
  /**
   * Text display on the notification.
   */
  message: string

  /**
   * The type of the notification.
   */
  type?: NotificationType

  /**
   * The position of the notification.
   */
  position?: NotiPosition

  /**
   * The duration of the notification.
   */
  duration?: number

  /**
   * Whether to show the progress bar.
   */
  showProgressBar?: boolean

  /**
   * Whether to close when clicking on the notification.
   */
  closeOnClick?: boolean

  /**
   * Whether to pause on hover.
   */
  hoverPause?: boolean
}
import type { NotiOptions } from '@vue3-noti/core'

Option

message (required)

Text displayed on the notification.

  • Type: string
  • Default: ''
const noti = useNoti()

notify({
  message: 'Hi Noti',
})

type (optional)

The type of the notification

  • Type: NotificationType
  • Default: success
type NotificationType = 'success' | 'warning' | 'error' | 'info'
import type { NotificationType } from '@vue3-noti/core'
const noti = useNoti()

notify({
  message: 'Hi Noti',
  type: 'success',
})

position (optional)

The position of the notification

  • Type: NotiPosition
  • Default: 'top-right'
type NotiPosition = 'top-left' | 'top-middle' | 'top-right' | 'bottom-left' | 'bottom-middle' | 'bottom-right'
import type { NotiPosition } from '@vue3-noti/core'
const noti = useNoti()

notify({
  message: 'Hi Noti',
  type: 'top-right',
})

duration (optional)

The duration of the notification's display in milliseconds.

  • Type: number
  • Default: 3000
const noti = useNoti()

notify({
  message: 'Hi Noti',
  duration: 3000,
})

showProgressBar (optional)

Specify whether to display a progress bar.

  • Type: boolean
  • Default: true
const noti = useNoti()

notify({
  message: 'Hi Noti',
  showProgressBar: true,
})

closeOnClick (optional)

Specify whether to close the notification when clicked.

  • Type: boolean
  • Default: true
const noti = useNoti()

notify({
  message: 'Hi Noti',
  closeOnClick: true,
})

hoverPause (optional)

Specify whether to pause the notification's display on hover.

  • Type: boolean
  • Default: true
const noti = useNoti()

notify({
  message: 'Hi Noti',
  hoverPause: true,
})