DirkScripts

Docs

Notify

lib.notify

Show a notification.

lua
lib.notify({
    title = 'Welcome',
    description = 'You have joined the server',
    type = 'success',
    duration = 5000,
})

Field	Type	Required	Description
`title`	string	no	Notification title
`description`	string	no	Notification body text
`type`	string	no	`"error"`, `"success"`, `"inform"`, or `"warning"`
`duration`	number	no	Display time in milliseconds
`position`	string	no	Override position (e.g. `"top-right"`)
`sound`	boolean	no	Play notification sound

Compatibility notification wrapper used by some resources.

lua
lib.defaultNotify({
    status = 'success',
    title = 'Saved',
    description = 'Profile updated successfully',
})

status is mapped to notification type internally.

Text UI

DirkScripts

Docs

Show a notification.

lua
lib.notify({
    title = 'Welcome',
    description = 'You have joined the server',
    type = 'success',
    duration = 5000,
})

Field	Type	Required	Description
`title`	string	no	Notification title
`description`	string	no	Notification body text
`type`	string	no	`"error"`, `"success"`, `"inform"`, or `"warning"`
`duration`	number	no	Display time in milliseconds
`position`	string	no	Override position (e.g. `"top-right"`)
`sound`	boolean	no	Play notification sound

Compatibility notification wrapper used by some resources.

lua
lib.defaultNotify({
    status = 'success',
    title = 'Saved',
    description = 'Profile updated successfully',
})

status is mapped to notification type internally.

Text UI

DirkScripts

Docs

Show a notification.

lua
lib.notify({
    title = 'Welcome',
    description = 'You have joined the server',
    type = 'success',
    duration = 5000,
})

Field	Type	Required	Description
`title`	string	no	Notification title
`description`	string	no	Notification body text
`type`	string	no	`"error"`, `"success"`, `"inform"`, or `"warning"`
`duration`	number	no	Display time in milliseconds
`position`	string	no	Override position (e.g. `"top-right"`)
`sound`	boolean	no	Play notification sound

Compatibility notification wrapper used by some resources.

lua
lib.defaultNotify({
    status = 'success',
    title = 'Saved',
    description = 'Profile updated successfully',
})

status is mapped to notification type internally.

Text UI