mirrors/neovim
1
0
Fork 0
mirror of https://github.com/neovim/neovim.git synced 2026-06-15 16:23:48 +00:00
Code Issues Packages Projects Releases Wiki Activity

backport: opts.scope in vim.ui.input (#39906)

Browse Source 
feat(ui): vim.ui.input(opts.scope) #39570

Problem: There is no way for a `vim.ui.input` caller to indicate for
  which scope the input is. As in "This input is for something at cursor
  scope". This information can be useful for `vim.ui.input`
  implementation to tweak its behavior and presentation:
  - Show different floating window depending on the scope. For example:
    - Near cursor for "cursor" scope.
    - At line start for "line" scope.
    - In window corner for "buffer" and "window" scopes.
    - In whole editor corner for "tabpage", "editor", "project" scopes.
  - Navigate through history only for inputs with the same scope.

Solution: Document new `opts.scope` for `vim.ui.input`. Use it in the
  codebase.
This commit is contained in:
Evgeni Chasnovski
2026-05-20 11:44:03 +03:00
committed by GitHub
parent b0bfce290f
commit b05675bccc
5 changed files with 22 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
runtime/lua/vim/ui.lua
View File

@@ -96,6 +96,12 @@ end
---Function that will be used for highlighting
---user inputs.
---@field highlight? function
---
---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.
---@field scope? 'cursor'|'line'|'buffer'|'window'|'tabpage'|'editor'|'project'
--- Prompts the user for input, allowing arbitrary (potentially asynchronous) work until
--- `on_confirm`.
@@ -103,7 +109,8 @@ end
--- Example:
---
--- ```lua
--- vim.ui.input({ prompt = 'Enter value for shiftwidth: ' }, function(input)
--- local opts = { prompt = 'Enter value for shiftwidth: ', scope = 'buffer' }
--- vim.ui.input(opts, function(input)
--- vim.o.shiftwidth = tonumber(input)
--- end)
--- ```