lib: add lznKeySpec example

2024-08-03 16:38:42 +02:00 · 2024-08-03 16:38:42 +02:00 · dfd9172371
parent f29664626b
commit dfd9172371
1 changed files with 6 additions and 1 deletions
--- a/lib/types/plugins.nix
+++ b/lib/types/plugins.nix
@ -186,7 +186,12 @@
      keys = mkOption {
        description = "Lazy-load on key mapping";
        default = null;
-        type = nullOr (oneOf [str (listOf lznKeysSpec) (listOf str)]); # TODO: support lz.n.KeysSpec
+        type = nullOr (oneOf [str (listOf lznKeysSpec) (listOf str)]);
+        example = ''
+          keys = [
+            {lhs = "<leader>s"; rhs = ":NvimTreeToggle<cr>"; desc = "Toggle NvimTree"}
+          ]
+        '';
      };

      # TODO: enabled, beforeAll, colorscheme, priority, load