Dressing.nvim

随着Neovim 0.6的发布，我们获得了可扩展的核心UI钩子（vim.ui.select和vim.ui.input）。它们的存在是为了让插件作者能够通过改进默认行为来覆盖它们，所以这正是我们要做的。

我们的目标是匹配而不是扩展核心Neovim API。所有核心尊重的选项我们都会尊重，我们不会在函数中接受任何自定义参数或选项。自定义将完全通过单独的配置方法进行。

• 要求
• 截图
• 安装
• 配置
• 高亮
• 高级配置
• 插件作者注意事项
• 替代和相关项目

要求

Neovim 0.8.0+（对于早期版本，请使用nvim-0.7或nvim-0.5分支）

截图

vim.input替换（处理LSP重命名）

vim.select（telescope）

vim.select（fzf）

vim.select（nui）

vim.select（内置）

安装

dressing.nvim支持所有常用的插件管理器

<details> <summary>lazy.nvim</summary>

{
  'stevearc/dressing.nvim',
  opts = {},
}

</details> <details> <summary>Packer</summary>

require('packer').startup(function()
    use {'stevearc/dressing.nvim'}
end)

</details> <details> <summary>Paq</summary>

require "paq" {
    {'stevearc/dressing.nvim'};
}

</details> <details> <summary>vim-plug</summary>

Plug 'stevearc/dressing.nvim'

</details> <details> <summary>dein</summary>

call dein#add('stevearc/dressing.nvim')

</details> <details> <summary>Pathogen</summary>

git clone --depth=1 https://github.com/stevearc/dressing.nvim.git ~/.vim/bundle/

</details> <details> <summary>Neovim原生包</summary>

git clone --depth=1 https://github.com/stevearc/dressing.nvim.git \
  "${XDG_DATA_HOME:-$HOME/.local/share}"/nvim/site/pack/dressing.nvim/start/dressing.nvim

</details>

配置

如果你对默认设置满意，那么安装后就可以直接使用了。如果你想进行调整，可以调用以下函数：

require("dressing").setup({
  input = {
    -- 设置为false以禁用vim.ui.input实现
    enabled = true,

    -- 默认提示字符串
    default_prompt = "输入",

    -- 从提示中删除尾随的`:`
    trim_prompt = true,

    -- 可以是'left'、'right'或'center'
    title_pos = "left",

    -- 当为true时，输入将从插入模式开始
    start_in_insert = true,

    -- 这些参数传递给nvim_open_win
    border = "rounded",
    -- 'editor'和'win'默认居中
    relative = "cursor",

    -- 这些可以是整数或0到1之间的浮点数（例如0.4表示40%）
    prefer_width = 40,
    width = nil,
    -- min_width和max_width可以是混合类型的列表
    -- min_width = {20, 0.2}表示"20列或总宽度的20%中的较大者"
    max_width = { 140, 0.9 },
    min_width = { 20, 0.2 },

    buf_options = {},
    win_options = {
      -- 禁用换行
      wrap = false,
      -- 文本超出窗口时的指示器
      list = true,
      listchars = "precedes:…,extends:…",
      -- 增加此值以在文本滚动出窗口时获得更多上下文
      sidescrolloff = 0,
    },

    -- 设置为`false`以禁用
    mappings = {
      n = {
        ["<Esc>"] = "关闭",
        ["<CR>"] = "确认",
      },
      i = {
        ["<C-c>"] = "关闭",
        ["<CR>"] = "确认",
        ["<Up>"] = "历史上一个",
        ["<Down>"] = "历史下一个",
      },
    },

    override = function(conf)
      -- 这是将传递给nvim_open_win的配置
      -- 在这里更改值以自定义布局
      return conf
    end,

    -- 参见 :help dressing_get_config
    get_config = nil,
  },
  select = {
    -- 设置为false以禁用vim.ui.select实现
    enabled = true,

    -- 首选vim.select实现的优先级列表
    backend = { "telescope", "fzf_lua", "fzf", "builtin", "nui" },

    -- 从提示中删除尾随的`:`
    trim_prompt = true,

    -- telescope选择器的选项
    -- 这些直接传递给telescope选择器。可以像这样使用：
    -- telescope = require('telescope.themes').get_ivy({...})
    telescope = nil,

    -- fzf选择器的选项
    fzf = {
      window = {
        width = 0.5,
        height = 0.4,
      },
    },

    -- fzf-lua的选项
    fzf_lua = {
      -- winopts = {
      --   height = 0.5,
      --   width = 0.5,
      -- },
    },

    -- nui菜单的选项
    nui = {
      position = "50%",
      size = nil,
      relative = "editor",
      border = {
        style = "rounded",
      },
      buf_options = {
        swapfile = false,
        filetype = "DressingSelect",
      },
      win_options = {
        winblend = 0,
      },
      max_width = 80,
      max_height = 40,
      min_width = 40,
      min_height = 10,
    },

    -- 内置选择器的选项
    builtin = {
      -- 显示选项的数字并设置键映射
      show_numbers = true,
      -- 这些传递给nvim_open_win
      border = "rounded",
      -- 'editor'和'win'默认居中
      relative = "editor",

      buf_options = {},
      win_options = {
        cursorline = true,
        cursorlineopt = "both",
      },
-- 这些可以是整数或0到1之间的浮点数（例如，0.4表示40%）
-- min_和max_选项可以是混合类型的列表。
-- max_width = {140, 0.8} 意味着"140列或总宽度的80%中的较小值"
width = nil,
max_width = { 140, 0.8 },
min_width = { 40, 0.2 },
height = nil,
max_height = 0.9,
min_height = { 10, 0.2 },

-- 设置为`false`以禁用
mappings = {
  ["<Esc>"] = "关闭",
  ["<C-c>"] = "关闭",
  ["<CR>"] = "确认",
},

override = function(conf)
  -- 这是将传递给nvim_open_win的配置。
  -- 在这里更改值以自定义布局
  return conf
end,
},

-- 用于覆盖format_item。参见 :help dressing-format
format_item_override = {},

-- 参见 :help dressing_get_config
get_config = nil,
},
})

高亮

调整仅dressing窗口高亮的常见方法是在配置中提供winhighlight选项。更多详情请参见:help winhighlight。示例：

require('dressing').setup({
  input = {
    win_options = {
      winhighlight = 'NormalFloat:DiagnosticError'
    }
  }
})

高级配置

对于input和select配置中的每一项，都有一个get_config选项。这可以是一个接受传递给vim.select或vim.input的opts参数的函数。它必须返回nil（表示不操作）或用于替代该模块全局配置值的配置值。

例如，如果你想为代码操作使用特定配置：

require('dressing').setup({
  select = {
    get_config = function(opts)
      if opts.kind == 'codeaction' then
        return {
          backend = 'nui',
          nui = {
            relative = 'cursor',
            max_width = 40,
          }
        }
      end
    end
  }
})

插件作者注意事项

简而言之：你可以通过在opts中传递telescope来自定义telescope的vim.ui.select实现。

vim.ui钩子对我们来说是一大福音，因为我们现在可以假设用户将有一个合理的UI可用于简单的输入操作。我们不再需要为fzf、telescope、ctrlp等每个选项构建单独的实现。代价是vim.ui.select比这些选项中的任何一个都更不可定制，所以如果你想要一个预览窗口（像telescope支持的那样），现在就不再是一个选项。

我的解决方案是扩展传递给vim.ui.select的opts。你可以添加一个telescope字段，它将直接传递给选择器，允许你自定义UI的任何部分。如果用户同时安装了dressing和telescope，他们将获得你的自定义选择器UI。如果这两个条件中的任何一个不成立，选择UI将优雅地降级为用户为vim.ui.select配置的任何内容。

使用示例：

vim.ui.select({'苹果', '香蕉', '芒果'}, {
  prompt = "标题",
  telescope = require("telescope.themes").get_cursor(),
}, function(selected) end)

目前这只适用于telescope后端，但如果你需要添加其他内容，随时提出请求。

替代和相关项目

• telescope-ui-select - 为telescope提供vim.ui.select实现
• fzf-lua - 为fzf提供vim.ui.select实现
• nvim-fzy - fzf的替代品，也提供vim.ui.select实现（#13）
• guihua.lua - 多用途GUI库，提供vim.ui.select和vim.ui.input实现
• nvim-notify - 为vim.notify做类似的事情
• nui.nvim - 为插件作者提供常见的UI组件。wiki中有如何构建自己的vim.ui接口的示例。