search

RishabhRD / popfix

Neovim lua API for highly extensible popup window
83 stars 3 forks source link

how to use the plugin ??? #1

Open lopesivan opened 3 years ago

lopesivan commented 3 years ago

I think it's important to create documentation or show your vimdotfile

RishabhRD commented 3 years ago

This plugin is intended to help plugin developers to develop their plugin UI faster with some sensible defaults. The core idea behind the plugin is that plugin developer should mostly worry about the logic of plugins, Not much about UI.

If a plugin needs some sort of selection interface (or prompt interface in future) then this plugin would be just like a ready-made drag and drop tool hiding all complexities of neovim event-loop programming model, autocmd(s), keybinds, etc. Some simple examples would be like: Music player client integrated in neovim, some sort of projectifier, maybe some treesitter utilities, etc.

The plugin can't be used directly for the time being. However, it is possible to utilize the plugin by other plugins. One example of it is nvim-lsputils!.

Because the plugin development is still in progress. Prompt and fuzzy finding (and other searching algorithms) are still in the unstable stage and hence not showcased in README.md. Once done, we can present a wiki page with a tutorial to write a very simple plugin with the help of popfix. :smile: