[mini.clue] The proper way to use postkeys and set descriptions for key groups

[s-cerevisiae]

Contributing guidelines

• I have read CODE_OF_CONDUCT.md

Module(s)

mini.clue

Question

I have my key mappings grouped by prefixes, and with mini.clue I want to make some of the keys "submodes".

My current config set empty mappings for key group prefixes to give them descriptions:

vim.keymap.set("n", "<leader>d", "", { desc = "description for the group" })

But it turns out this doesn't work well with postkeys. If I configure it like this:

{
  triggers = {
    {mode = "n", keys = "<leader>"}
  },
  clues = {
    {mode = "n", keys = "<leader>dh", postkeys = "<leader>d"}
  }
}

the empty <leader>d keymap rather than the <leader> trigger is activated, so the clue window exits immediately.
Should this be considered a problem with mini.clue? Or should I accept it and rewrite my empty mappings for groups to clues instead?

[echasnovski]

Should this be considered a problem with mini.clue? Or should I accept it and rewrite my empty mappings for groups to clues instead?

I don't think this is a problem with 'mini.clue'. Having real mappings for both <Leader>d and <Leader>dh is a bit problematic in itself.

What indeed should work is to have real mappings only for the actions you want to do outside of 'mini.clue' and put a group description in config.clues. So something like this:

require('mini.clue').setup({
  triggers = {
    { mode = 'n', keys = '<leader>' },
  },
  clues = {
    { mode = 'n', keys = '<leader>d', desc = 'Group' },

    { mode = 'n', keys = '<leader>dh', postkeys = '<leader>d' },
    { mode = 'n', keys = '<leader>dj', postkeys = '<leader>d' },
    { mode = 'n', keys = '<leader>dk', postkeys = '<leader>d' },
    { mode = 'n', keys = '<leader>dl', postkeys = '<leader>d' },
  },
})

This is more or less documented in "Leader clues" section together with submode example. Although the latter should probably set up <Leader> as a trigger and <Leader>m as a group clue.

[echasnovski]

The documentation example for submode with <Leader> key should now be updated.

[s-cerevisiae]

Thank you! Everything is working as expected now.