mirror of
https://github.com/NotAShelf/nvf.git
synced 2025-09-06 02:11:33 +00:00
binds/qmk: init
Create the `vim.binds.qmk` module with `enable` and `setupOpts`.
This commit is contained in:
parent
f578f82b4d
commit
ef9609c207
7 changed files with 101 additions and 0 deletions
51
modules/plugins/utility/binds/qmk/qmk.nix
Normal file
51
modules/plugins/utility/binds/qmk/qmk.nix
Normal file
|
@ -0,0 +1,51 @@
|
|||
{
|
||||
config,
|
||||
lib,
|
||||
...
|
||||
}: let
|
||||
inherit (lib.options) mkOption mkEnableOption;
|
||||
inherit (lib.types) attrsOf enum lines str;
|
||||
inherit (lib.nvim.types) mkPluginSetupOption;
|
||||
in {
|
||||
options.vim.binds.qmk = {
|
||||
enable = mkEnableOption "QMK and ZMK keymaps in nvim";
|
||||
|
||||
setupOpts = mkPluginSetupOption "qmk.nvim" {
|
||||
name = mkOption {
|
||||
type = str;
|
||||
description = "The name of the layout";
|
||||
};
|
||||
|
||||
layout = mkOption {
|
||||
type = lines;
|
||||
description = ''
|
||||
The keyboard key layout
|
||||
see <https://github.com/codethread/qmk.nvim?tab=readme-ov-file#Layout> for more details
|
||||
'';
|
||||
};
|
||||
|
||||
variant = mkOption {
|
||||
type = enum ["qmk" "zmk"];
|
||||
default = "qmk";
|
||||
description = "Chooses the expected hardware target";
|
||||
};
|
||||
|
||||
comment_preview = {
|
||||
position = mkOption {
|
||||
type = enum ["top" "bottom" "inside" "none"];
|
||||
default = "top";
|
||||
description = "Controls the position of the preview";
|
||||
};
|
||||
|
||||
keymap_overrides = mkOption {
|
||||
type = attrsOf str;
|
||||
default = {};
|
||||
description = ''
|
||||
Key codes to text replacements
|
||||
see <https://github.com/codethread/qmk.nvim/blob/main/lua/qmk/config/key_map.lua> for more details
|
||||
'';
|
||||
};
|
||||
};
|
||||
};
|
||||
};
|
||||
}
|
Loading…
Add table
Add a link
Reference in a new issue