Skip to content

Commit

Permalink
docs: support for lazy=false
Browse files Browse the repository at this point in the history
  • Loading branch information
mrcjkb committed Jan 1, 2025
1 parent 5a6d5fa commit 456831b
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 1 deletion.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -145,7 +145,7 @@ require("lz.n").load(plugins)
| **ft** | `string?` or `string[]` | Lazy-load on filetype. | `ft` |
| **keys** | `string?` or `string[]` or `lz.n.KeysSpec[]` | Lazy-load on key mapping. | `keys` |
| **colorscheme** | `string?` or `string[]` | Lazy-load on colorscheme. | None. `lazy.nvim` lazy-loads colorschemes automatically[^2]. |
| **lazy** | `boolean?` | Lazy-load manually, e.g. using `trigger_load`. | `lazy` |
| **lazy** | `boolean?` | Lazy-load manually, e.g. using `trigger_load`. Will disable lazy-loading if explicitly set to `false`. | `lazy` |
| **priority** | `number?` | Only useful for **start** plugins (not lazy-loaded) to force loading certain plugins first. Default priority is `50`. | `priority` |
| **load** | `fun(string)?` | Can be used to override the `vim.g.lz_n.load()` function for an individual plugin. | None. |
<!-- markdownlint-enable MD013 -->
Expand Down
3 changes: 3 additions & 0 deletions doc/lz.n.txt
Original file line number Diff line number Diff line change
Expand Up @@ -142,6 +142,9 @@ lz.n.PluginSpecHandlers *lz.n.PluginSpecHandlers*
Load a plugin on one or more |key-mapping|s.
{colorscheme?} (string[]|string)
Load a plugin on one or more |colorscheme| events.
{lazy?} (boolean)
Lazy-load manually, e.g. using `trigger_load`.
Will disable lazy-loading if explicitly set to `false`.


lz.n.KeysBase : vim.keymap.set.Opts *lz.n.KeysBase*
Expand Down
4 changes: 4 additions & 0 deletions lua/lz/n/meta.lua
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,10 @@
---
--- Load a plugin on one or more |colorscheme| events.
---@field colorscheme? string[]|string
---
--- Lazy-load manually, e.g. using `trigger_load`.
--- Will disable lazy-loading if explicitly set to `false`.
---@field lazy? boolean

---@class lz.n.KeysBase: vim.keymap.set.Opts
---@field desc? string
Expand Down

0 comments on commit 456831b

Please sign in to comment.