Notification

Notifications with a lot of customizable properties.

id?: string

When set the current notification will be unique and only shown once on screen when spammed.

title?: string

Must provide if there is no description.

description?: string

Must provide if there is no title.

Markdown support

duration?: number

Default: 3000

showDuration?: boolean

Default: true

position?: 'top' or 'top-right' or 'top-left' or 'bottom' or 'bottom-right' or 'bottom-left' or 'center-right' or 'center-left'

Default: 'top-right'

type?: 'info' or 'error' or 'success' or 'warning'

Default: 'info'

icon?: string

Font Awesome 6 icon name

iconAnimation?: 'spin' or 'spinPulse' or 'spinReverse' or 'pulse' or 'beat' or 'fade' or 'beatFade' or 'bounce' or 'shake'
sound?: table {object}

bank?: string

name of audio bank that contains the soundset provided

set: string

Soundset the soundname is a member of.

name: string

Example

ox_lib example


 
    lib.notify({
        description = 'Profile updated **successfully**',
        duration = 3000,
        position = 'top-center',
        type = 'success'
    })
 
    lib.notify({
        description = 'Prism UI Pack is **now available**',
        duration = 3000,
        type = 'info'
    })
 
    lib.notify({
        description = 'Failed to save changes',
        duration = 3000,
        type = 'error'
    })
 
    lib.notify({
        description = 'Your session is about to expire',
        duration = 3000,
        type = 'warning'
    })
 
    lib.notify({
        description = 'This is a custom notification.',
        duration = 3000,
        title = 'Custom',
        icon = 'hamburger'
    })

Prism UI example


 
    exports['prism_uipack']:Notify({
        description = 'Profile updated **successfully**',
        duration = 3000,
        position = 'top-center',
        type = 'success'
    })
 
    exports['prism_uipack']:Notify({
        description = 'Prism UI Pack is **now available**',
        duration = 3000,
        type = 'info'
    })
 
    exports['prism_uipack']:Notify({
        description = 'Failed to save changes',
        duration = 3000,
        type = 'error'
    })
 
    exports['prism_uipack']:Notify({
        description = 'Your session is about to expire',
        duration = 3000,
        type = 'warning'
    })
 
    exports['prism_uipack']:Notify({
        description = 'This is a custom notification.',
        duration = 3000,
        title = 'Custom',
        icon = 'hamburger'
    })