plugins.notify.settings

Options provided to the require('notify').setup function.

Type: attribute set of anything

Default: { }

Example:

{
  settings = {
    background_colour = "#000000";
    fps = 30;
    icons = {
      debug = "";
      error = "";
      info = "";
      trace = "✎";
      warn = "";
    };
    level = "info";
    max_height = 10;
    max_width = 80;
    minimum_width = 50;
    on_close = {
      __raw = "function() print('Window closed') end";
    };
    on_open = {
      __raw = "function() print('Window opened') end";
    };
    render = "default";
    stages = "fade_in_slide_out";
    timeout = 5000;
    top_down = true;
  };
}

Declared by:

plugins.notify.settings.background_colour

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.settings.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.settings.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.settings.max_height

Max number of lines for a message.

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

Default: null

Declared by:

plugins.notify.settings.max_width

Max number of columns for messages.

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

Default: null

Declared by:

plugins.notify.settings.minimum_width

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.settings.on_close

Function called when a new window is closed.

Type: null or lua function string

Default: null

Plugin default: "nil"

Declared by:

plugins.notify.settings.on_open

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.settings.render

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

Type: null or one of “default”, “minimal”, “simple”, “compact”, “wrapped-compact” or raw lua code

Default: null

Plugin default: "default"

Declared by:

plugins.notify.settings.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.settings.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.settings.top_down

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: