jank/lazy.nvim
1
0
Fork 0
mirror of https://github.com/folke/lazy.nvim.git synced 2025-04-18 20:36:45 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

docs: added docs on optional

Browse source
This commit is contained in:
Folke Lemaitre 2023-05-23 08:57:53 +02:00
parent b1ad64a73e
commit b0aa5348d8
No known key found for this signature in database
GPG key ID: 41F8B1FBACAE2040
2 changed files with 15 additions and 9 deletions
Download patch file Download diff file Expand all files Collapse all files

1
README.md
View file

@ -107,6 +107,7 @@ require("lazy").setup({
| **keys** | `string?` or `string[]` or `LazyKeys[]` or `fun(self:LazyPlugin, keys:string[]):(string \| LazyKeys)[]` | Lazy-load on key mapping |
| **module** | `false?` | Do not automatically load this Lua module when it's required somewhere |
| **priority** | `number?` | Only useful for **start** plugins (`lazy=false`) to force loading certain plugins first. Default priority is `50`. It's recommended to set this to a high number for colorschemes. |
| **optional** | `boolean?` | When a spec is tagged optional, it will only be included in the final spec, when the same plugin has been specified at least once somewhere else without `optional`. This is mainly useful for Neovim distros, to allow setting options on plugins that may/may not be part of the user's plugins |
### Lazy Loading