OrionNotif

useNotif.[color](options) displays a notification at the bottom right of the screen.

Popables

OrionNotif, OrionAside and OrionModal are parts of the Popables family.

It means that all the OrionNotif you open will be kept in queue.

This behaviour can be customized to fit your needs.
More informations on this mecanism on the Popables documentation.

Usage

Tips

Notifications are generally used programatically with the useNotif service.

However, like <o-modal> and <o-aside>, you can use <o-notif> in a template, and make it visible through the display boolean prop.

NotifStyle NotifPlayground

Props

Name
displayboolean = undefined
optionsPartial<Orion.Popable.Options> & Partial<Orion.Notif.Options> = () => ({}) as Partial<Orion.Popable.Options>

Events

Name
Payload type
enter-start
enter-end
leave-start
leave-end

PublicInstance

Name
Type
resetTimer
() => void
_loader
() => OrionLoader
uid
number
bus
Bus
state
{ isClosing: boolean; isOpening: boolean; isMounted: boolean; visible: boolean; }
options
Orion.Popable.Options
open
(keepInQueue?: boolean) => Promise<void>
close
(options?: Orion.Popable.CloseOptions) => Promise<void>
trigger
(eventName: string, params?: any) => void
animateAsync
(enter: boolean) => Promise<void>
removeProgrammatic
() => void
isLastOpenedPopable
() => boolean
_el
() => HTMLElement | undefined

Provide

Name
Type
_notif
publicInstance