plugins.dressing.settings.input.enabled

Enable the vim.ui.input implementation.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.dressing.settings.input.border

Defines the border to use for the input window. Accepts same border values as nvim_open_win(). See :help nvim_open_win() for more info.

Plugin default: rounded

Type: null or string or list of string or list of list of string or raw lua code

Default: null

Declared by:

plugins.dressing.settings.input.buf_options

An attribute set of neovim buffer options.

Plugin default: {}

Type: null or (attribute set of (anything or raw lua code))

Default: null

Declared by:

plugins.dressing.settings.input.default_prompt

Default prompt string for vim.ui.input.

Plugin default: "Input"

Type: null or string or raw lua code

Default: null

Declared by:

plugins.dressing.settings.input.get_config

This can be a function that accepts the opts parameter that is passed in to ‘vim.select’ or ‘vim.input’. It must return either nil or config values to use in place of the global config values for that module.

See :h dressing_get_config for more info.

Plugin default: null

Type: null or lua function string

Default: null

Declared by:

plugins.dressing.settings.input.insert_only

When true, <Esc> will close the modal.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.dressing.settings.input.mappings

Mappings for defined modes.

To disable a default mapping in a specific mode, set it to false.

Plugin default:

{
  n = {
    "<Esc>" = "Close";
    "<CR>" = "Confirm";
  };
  i = {
    "<C-c>" = "Close";
    "<CR>" = "Confirm";
    "<Up>" = "HistoryPrev";
    "<Down>" = "HistoryNext";
  };
}

Type: null or (attribute set of ((attribute set of (string or value false (singular enum))) or raw lua code))

Default: null

Declared by:

plugins.dressing.settings.input.max_width

Max width of window.

Can be a list of mixed types, e.g. [140 0.9] means “less than 140 columns or 90% of total.”

Plugin default: [140 0.9]

Type: null or unsigned integer, meaning >=0, or integer or floating point number between 0.0 and 1.0 (both inclusive) or list of (unsigned integer, meaning >=0, or integer or floating point number between 0.0 and 1.0 (both inclusive))

Default: null

Declared by:

plugins.dressing.settings.input.min_width

Min width of window.

Can be a list of mixed types, e.g. [140 0.9] means “less than 140 columns or 90% of total.”

Plugin default: [20 0.2]

Type: null or unsigned integer, meaning >=0, or integer or floating point number between 0.0 and 1.0 (both inclusive) or list of (unsigned integer, meaning >=0, or integer or floating point number between 0.0 and 1.0 (both inclusive))

Default: null

Declared by:

plugins.dressing.settings.input.override

Lua function that takes config that is passed to nvim_open_win. Used to customize the layout.

Plugin default: function(conf) return conf end

Type: null or lua function string

Default: null

Declared by:

plugins.dressing.settings.input.prefer_width

Can be an integer or a float between 0 and 1 (e.g. 0.4 for 40%).

Plugin default: 40

Type: null or unsigned integer, meaning >=0, or integer or floating point number between 0.0 and 1.0 (both inclusive)

Default: null

Declared by:

plugins.dressing.settings.input.relative

Affects the dimensions of the window with respect to this setting. If ‘editor’ or ‘win’, will default to being centered.

Plugin default: "cursor"

Type: null or one of “cursor”, “win”, “editor” or raw lua code

Default: null

Declared by:

plugins.dressing.settings.input.start_in_insert

When true, input will start in insert mode.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.dressing.settings.input.title_pos

Position of title.

Plugin default: "left"

Type: null or one of “left”, “right”, “center” or raw lua code

Default: null

Declared by:

plugins.dressing.settings.input.trim_prompt

Trim trailing : from prompt.

Plugin default: true

Type: null or boolean or raw lua code

Default: null

Declared by:

plugins.dressing.settings.input.width

Can be an integer or a float between 0 and 1 (e.g. 0.4 for 40%).

Plugin default: null

Type: null or unsigned integer, meaning >=0, or integer or floating point number between 0.0 and 1.0 (both inclusive)

Default: null

Declared by:

plugins.dressing.settings.input.win_options

An attribute set of window options.

Plugin default:

{
  wrap = false;
  list = true;
  listchars = "precedes:...,extends:...";
  sidescrolloff = 0;
}

Type: null or (attribute set of (anything or raw lua code))

Default: null

Declared by: