folke / which-key.nvim

💥 Create key bindings that stick. WhichKey helps you remember your Neovim keymaps, by showing available keybindings in a popup as you type.
Apache License 2.0
4.75k stars 154 forks source link

feature: Group descriptions #550

Closed Aonodensetsu closed 5 days ago

Aonodensetsu commented 7 months ago

Did you check the docs?

Is your feature request related to a problem? Please describe.

I'm making a user-friendly "distribution" of nvim for my colleagues at work, who would benefit from a simple but powerful editor that works over ssh - so, terminal based. They aren't exactly familiar with vim, so which-key is a must, but I would hope to add descriptions/explanations to further clarify their purpose and use.

Describe the solution you'd like

An option of groups, similar to name, but that adds a longer description within the group window

require'which-key'.register{
  t = {
    name = 'telescope', -- this gets shown outside group
    desc = 'These are commands...', -- this gets shown inside group, on separate lines
    ...
  }
}

quick mock-up image

Describe alternatives you've considered

github-actions[bot] commented 6 days ago

This issue is stale because it has been open 30 days with no activity. Remove stale label or comment or this will be closed in 7 days.

Aonodensetsu commented 5 days ago

Not closed

folke commented 5 days ago

Not interested in adding this