Documentation
Resources
Core
Configuration

Configuration

The configuration file can be found in the config.lua file.

Framework

OptionTypeDescription
FrameworkstringFramework support (qbCore, esx or standalone)
config.lua
Config.Framework = "qbCore"

Notification

OptionTypeDescription
useCustombooleanUse custom notifications
customNotifyfunctionCustom notification function

Styling

OptionTypeDescription
groupbooleanAllow stacking with a badge instead of repeating
positionstringPosition (top-left, top-right, bottom-left, bottom-right, top, bottom, left, right, center)
progressbooleanDisplay progress bar

Variants

OptionTypeDescription
classesstringCSS classes
iconstringCSS icon (Font Awesome)
config.lua
Config.Notification = {
    useCustom = false,
    customNotify = function(text, textType, length)
      --- Your custom notification code
    end,
 
    styling = {
      group = false,
      position = "right",
      progress = true
    },
 
    variants = {
      info = {
        classes = 'info',
        icon = 'fa-solid fa-circle-info'
      },
      success = {
        classes = 'success',
        icon = 'fa-solid fa-circle-check'
      },
      warning = {
        classes = 'warning',
        icon = 'fa-solid fa-triangle-exclamation'
      },
      error = {
        classes = 'error',
        icon = 'fa-solid fa-circle-xmark'
      }
    }
}
CoreDrive