plugins.notify.enable

Whether to enable nvim-notify.

Type: boolean

Default: false

Example: true

Declared by:

plugins.notify.package

Which package to use for the nvim-notify plugin.

Type: package

Default: <derivation vimplugin-nvim-notify-2024-05-17>

Declared by:

plugins.notify.backgroundColour

For stages that change opacity this is treated as the highlight behind the window. Set this to either a highlight group, an RGB hex value e.g. “#000000” or a function returning an RGB code for dynamic values.

Type: null or string or raw lua code

Default: null

Plugin default: "NotifyBackground"

Declared by:

plugins.notify.extraOptions

These attributes will be added to the table parameter for the setup function. Typically, it can override NixVim’s default settings.

Type: attribute set of anything

Default: { }

Declared by:

plugins.notify.fps

Frames per second for animation stages, higher value means smoother animations but more CPU usage.

Type: null or positive integer, meaning >0, or raw lua code

Default: null

Plugin default: 30

Declared by:

plugins.notify.level

Minimum log level to display. See vim.log.levels.

Type: null or unsigned integer, meaning >=0, or one of “off”, “error”, “warn”, “info”, “debug”, “trace”

Default: null

Plugin default: "info"

Declared by:

plugins.notify.maxHeight

Max number of lines for a message.

Type: null or unsigned integer, meaning >=0, or raw lua code

Default: null

Declared by:

plugins.notify.maxWidth

Max number of columns for messages.

Type: null or unsigned integer, meaning >=0, or raw lua code

Default: null

Declared by:

plugins.notify.minimumWidth

Minimum width for notification windows.

Type: null or unsigned integer, meaning >=0, or raw lua code

Default: null

Plugin default: 50

Declared by:

plugins.notify.onClose

Function called when a new window is closed.

Type: null or lua function string

Default: null

Plugin default: "nil"

Declared by:

plugins.notify.onOpen

Function called when a new window is opened, use for changing win settings/config.

Type: null or lua function string

Default: null

Plugin default: "nil"

Declared by:

plugins.notify.render

Function to render a notification buffer or a built-in renderer name.

Type: null or one of “default”, “minimal” or raw lua code

Default: null

Plugin default: "default"

Declared by:

plugins.notify.stages

Animation stages. Can be either one of the builtin stages or an array of lua functions.

Type: null or one of “fade”, “slide”, “fade_in_slide_out”, “static” or list of string

Default: null

Plugin default: "fade_in_slide_out"

Declared by:

plugins.notify.timeout

Default timeout for notification.

Type: null or unsigned integer, meaning >=0, or raw lua code

Default: null

Plugin default: 5000

Declared by:

plugins.notify.topDown

Whether or not to position the notifications at the top or not.

Type: null or boolean or raw lua code

Default: null

Plugin default: true

Declared by: