[snacks.toggle] There is any default snacks.toggle key bindings?

[ricardoseriani]

Hi

There is any default snacks.toggle key bindings when I enabled that "module" or should I configure that manually?
I enabled the toggle module using toggle = { enabled = true }, but I can't find any key mappings.

Thanks in advance.

[drowning-cat]

From https://github.com/folke/snacks.nvim?tab=readme-ov-file#-usage:

{
  "folke/snacks.nvim",
  priority = 1000,
  lazy = false,
  ---@type snacks.Config
  opts = {
    -- ...
  },
  init = function()
    vim.api.nvim_create_autocmd("User", {
      pattern = "VeryLazy",
      callback = function()
        -- ...

        -- Create some toggle mappings
        Snacks.toggle.option("spell", { name = "Spelling" }):map("<leader>us")
        Snacks.toggle.option("wrap", { name = "Wrap" }):map("<leader>uw")
        Snacks.toggle.option("relativenumber", { name = "Relative Number" }):map("<leader>uL")
        Snacks.toggle.diagnostics():map("<leader>ud")
        Snacks.toggle.line_number():map("<leader>ul")
        Snacks.toggle.option("conceallevel", { off = 0, on = vim.o.conceallevel > 0 and vim.o.conceallevel or 2 }):map("<leader>uc")
        Snacks.toggle.treesitter():map("<leader>uT")
        Snacks.toggle.option("background", { off = "light", on = "dark", name = "Dark Background" }):map("<leader>ub")
        Snacks.toggle.inlay_hints():map("<leader>uh")
        Snacks.toggle.indent():map("<leader>ug")
        Snacks.toggle.dim():map("<leader>uD")
      end,
    })
  end,

[ricardoseriani]

I thought that it was already coming with some key mappings.
But now that you pointed out, I will create them.
Thanks for your help.

[dpetka2001]

@ricardoseriani No it only comes with a predefined set of toggles and users are free to choose whatever mappings they prefer. You can also set your own toggles if you want with something like

Snacks.toggle({
      name = "Completion",
      get = function()
        return vim.b.completion
      end,
      set = function(state)
        vim.b.completion = state
      end,
    }):map("<leader>uk")

You just have to correctly figure out how to get the initial state of the toggle you want and how you can customize it.

[ricardoseriani]

Thanks for your tips @dpetka2001.

Taking advantage of this discussion, why the toggle definitions is being set inside an init function instead of config function?

If this topic is too "out of boundaries" in this discussion, I can open a new one.

[dpetka2001]

Doesn't have to be in init. Can be in config or opts (since opts will be passed into config either way) of a plugin or even more general toggles in your own keymaps.lua file. Take a look at how they're implemented accross LazyVim as a reference.

[ricardoseriani]

Thanks again @dpetka2001.
I thought that it has to be inside an init function for a reason... but it's good to known that I can use any method.
I will take a look into LazyVim, as you pointed.