diff options
| -rw-r--r-- | README.md | 39 |
1 files changed, 22 insertions, 17 deletions
@@ -491,7 +491,7 @@ Telescope find_files theme=get_dropdown ``` Themes should work with every `telescope.builtin` function. If you wish to -make theme, check out `lua/telescope/themes.lua`. +make a theme, check out `lua/telescope/themes.lua`. ## Autocmds @@ -510,30 +510,35 @@ Telescope provides the capabilties to create & register extensions, which improv Some extensions provide integration with external tools, outside of the scope of `builtins`. Others provide performance enhancements by using compiled C and interfacing directly with Lua. -### Community Extensions -- [telescope-fzy-native.nvim](https://github.com/nvim-telescope/telescope-fzy-native.nvim) - Native FZY sorter that uses compiled C to do the matching -- [telescope-dap.nvim](https://github.com/nvim-telescope/telescope-dap.nvim) - [`nvim-dap`](https://github.com/mfussenegger/nvim-dap) integration -- [telescope-packer.nvim](https://github.com/nvim-telescope/telescope-packer.nvim) - A Telescope extension that provides extra functionality for Packer.nvim -- [telescope-github.nvim](https://github.com/nvim-telescope/telescope-github.nvim) - Integration with github cli -- [telescope-vimspector.nvim](https://github.com/nvim-telescope/telescope-vimspector.nvim) - Integration for [vimspector](https://github.com/puremourning/vimspector) -- [telescope-fzf-writer.nvim](https://github.com/nvim-telescope/telescope-fzf-writer.nvim) - Incorporating some fzf concepts with plenary jobs and telescope -- [telescope-symbols.nvim](https://github.com/nvim-telescope/telescope-symbols.nvim) - Picking symbols and insert them at point. -- [telescope-asynctasks.nvim](https://github.com/GustavoKatel/telescope-asynctasks.nvim) - Integration for [asynctasks](https://github.com/skywind3000/asynctasks.vim) - -Extensions can be refenced by doing the following: +### Loading nextensions +To load an extension, use the `load_extension` function as shown in the example below: ```lua --- Run the `configurations` picker from nvim-dap (not yet implemented) -require('telescope').extensions.dap.configurations() +-- This will load fzy_native and have it override the default file sorter +require('telescope').load_extension('fzy_native') ``` -To pre-load an extension (so that it will override default configurations), you can do: +You may skip explicitly loading extensions (they will then be lazy-loaded), but tab completions will not be available right away. + +### Accessing pickers from extensions +Pickers from extensions are added to the `:Telescope` command under their respective name. +For example: +```viml +" Run the `configurations` picker from nvim-dap +:Telescope dap configurations +``` + +They can also be called directly from lua: ```lua --- This will load fzy_native and have it override the default file sorter -require('telescope').load_extension('fzy_native') +-- Run the `configurations` picker from nvim-dap +require('telescope').extensions.dap.configurations() ``` +### Community Extensions + +For a list of community extensions, please consult the wiki: [Extensions](https://github.com/nvim-telescope/telescope.nvim/wiki/Extensions) + ## API <!-- TODO: need to provide working examples for every api --> |