vim.ui.input.Opts

@inlinedoc

Fields5

Opts.prompt : nil | string

Text of the prompt

Opts.default : nil | string

Default reply to the input

Opts.completion : nil | string

Specifies type of completion supported for input. Supported types are the same that can be supplied to a user-defined command using the "-complete=" argument. See |:command-completion|

Opts.highlight : nil | function

Function that will be used for highlighting user inputs.

Opts.scope : "cursor" | "line" | "buffer" | "window" | "tabpage" | "editor" | "project" | nil

Input scope, as in "This input is for something at cursor/line/etc scope". Can be used by vim.ui.input implementations to tweak behavior and presentation. For example, the input may adjust the floating window position: near the cursor if cursor, in window corner if buffer or window, etc.