luxolus
/
dressing.nvim
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

doc: add some alternative projects to the README

This commit is contained in:
Steven Arcangeli 2021-12-17 11:38:34 -08:00
parent 1c314ea68a
commit 441432ae1c
1 changed files with 7 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
README.md
View File

@ -16,7 +16,7 @@ options in the functions. Customization will be done entirely using a separate
- [Installation](#installation) - [Installation](#installation)
- [Configuration](#configuration) - [Configuration](#configuration)
- [Advanced configuration](#advanced-configuration) - [Advanced configuration](#advanced-configuration)
- [Similar projects](#similar-projects) - [Alternative and related projects](#alternative-and-related-projects)
## Requirements ## Requirements
@ -205,6 +205,7 @@ require('dressing').setup({
``` ```
## Advanced configuration ## Advanced configuration
For each of the `input` and `select` configs, there is an option For each of the `input` and `select` configs, there is an option
`get_config`. This can be a function that accepts the `opts` parameter that `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` (to is passed in to `vim.select` or `vim.input`. It must return either `nil` (to
@ -212,6 +213,7 @@ no-op) or config values to use in place of the global config values for that
module. module.
For example, if you want to use a specific configuration for code actions: For example, if you want to use a specific configuration for code actions:
```lua ```lua
require('dressing').setup({ require('dressing').setup({
select = { select = {
@ -230,8 +232,11 @@ require('dressing').setup({
}) })
``` ```
## Similar projects
## Alternative and related projects
- [telescope-ui-select](https://github.com/nvim-telescope/telescope-ui-select.nvim) - provides a `vim.ui.select` implementation for telescope
- [nvim-fzy](https://github.com/mfussenegger/nvim-fzy) - fzf alternative that also provides a `vim.ui.select` implementation ([#13](https://github.com/mfussenegger/nvim-fzy/pull/13))
- [nvim-notify](https://github.com/rcarriga/nvim-notify) - doing pretty much the - [nvim-notify](https://github.com/rcarriga/nvim-notify) - doing pretty much the
same thing but for `vim.notify` same thing but for `vim.notify`
- [nui.nvim](https://github.com/MunifTanjim/nui.nvim) - provides common UI - [nui.nvim](https://github.com/MunifTanjim/nui.nvim) - provides common UI