Mappings

Overview

• C = Ctrl

• Space = leader

• A = alt

• S = shift

• Defaults are defined in core.mappings (core/mappings.lua).

Mapping format

-- opts here is completely optional

 ["keys"] = {"action", "icon  mapping description", opts = {}},

 -- more examples
 ["<C-n>"] = {"<cmd> NvimTreeToggle <CR>", "Toggle nvimtree", opts = {}},

 ["<leader>uu"] = { "<cmd> NvChadUpdate <CR>", "update nvchad" },
 ["<leader>uu"] = { ":NvChadUpdate <CR>", "update nvchad" }, -- this will work too, either use <cmd> or : before command

 [";"] = { ":", "enter cmdline", opts = { nowait = true } },
 ["jk"] = { "<ESC>", "escape insert mode" , opts = { nowait = true }},

 -- example with lua function
 ["<leader>tt"] = {
     function()
        require("base46").toggle_theme()
     end,
        "toggle theme",
   },

• The mapping description is required for WhichKey, so non-whichkey users can skip that.

Default opts values

{
  buffer = nil, -- Global mappings. Specify a buffer number for buffer local mappings
  silent = true, 
  noremap = true,
  nowait = false,

  -- all standard key binding opts are supported 
}

Add new mappings

• This is the mappings structure of core.mappings and your custom mappings.
• You need to put your mappings into modes like n, v, i, t, etc.

-- chadrc
M.mappings = require "custom.mappings"

• n = normal, i = insert and so on.

-- lua/custom/mappings 
local M = {}

-- add this table only when you want to disable default keys
M.disabled = {
  n = {
      ["<leader>h"] = "",
      ["<C-s>"] = ""
  }
}

M.abc = {

  n = {
     ["<C-n>"] = {"<cmd> Telescope <CR>", "Open Telescope"}
  }

  i = {
    -- more keys!
  }
}

M.xyz = {
  -- stuff
}

return M

• The abc and xyz above are arbitrary; they could, for example, be a plugin's name.
• Be sure to maintain a table structure similar to core.mappings.
• Mappings will be automatically loaded. You don't need to load them manually.

Override default mappings

-- Let's override nvimtree's mappings

M.nvimtree = {
   n = {
      ["<leader>ff"] = { "<cmd> NvimTreeToggle <CR>", "   toggle nvimtree" },
      ["<C-n>"] = { "<cmd> Telescope <CR>", "open telescope" },
   },
}