Notifications
lib.notify
Custom notifications with a lot of styling options.
lib.notify(data)
- 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
- Default:
- showDuration?:
boolean
- Default:
true
- Default:
- 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'
- Default:
- type?:
'inform'
or'error'
or'success'
or'warning'
- Default:
'inform'
- Default:
- style?:
table
(object
)- React CSS styling format
- icon?:
string
- Font Awesome 6 icon name
- iconColor?:
string
- CSS Legal Color Values
- iconAnimation?:
'spin'
'spinPulse'
'spinReverse'
'pulse'
'beat'
'fade'
'beatFade'
'bounce'
'shake'
- alignIcon?:
'top'
or'center'
- Default:
'center'
- Default:
- 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
- bank?:
💡
Setting iconColor
will get rid of the contrasted icon colour and it's circular background.
Usage Example
Standard
lib.notify({
title = 'Notification title',
description = 'Notification description',
type = 'success'
})
Custom
lib.notify({
id = 'some_identifier',
title = 'Notification title',
description = 'Notification description',
showDuration = false,
position = 'top',
style = {
backgroundColor = '#141517',
color = '#C1C2C5',
['.description'] = {
color = '#909296'
}
},
icon = 'ban',
iconColor = '#C53030'
})