HelpModel class

A help view widget for displaying key bindings.

The help view can display key bindings in two modes:

• Short: A single line showing the most important bindings
• Full: Multiple columns showing all bindings grouped

Example

class MyKeyMap implements KeyMap {
  final up = KeyBinding.withHelp(['up', 'k'], '↑/k', 'move up');
  final down = KeyBinding.withHelp(['down', 'j'], '↓/j', 'move down');
  final quit = KeyBinding.withHelp(['q'], 'q', 'quit');

  @override
  List<KeyBinding> shortHelp() => [up, down, quit];

  @override
  List<List<KeyBinding>> fullHelp() => [[up, down], [quit]];
}

class MyModel implements Model {
  final HelpModel help;
  final MyKeyMap keyMap;

  MyModel({HelpModel? help, MyKeyMap? keyMap})
      : help = help ?? HelpModel(),
        keyMap = keyMap ?? MyKeyMap();

  @override
  (Model, Cmd?) update(Msg msg) {
    // Toggle help with ?
    if (msg is KeyMsg && msg.key.matchesSingle(CommonKeyBindings.help)) {
      return (
        MyModel(help: help.copyWith(showAll: !help.showAll), keyMap: keyMap),
        null,
      );
    }
    return (this, null);
  }

  @override
  String view() => '...\n${help.view(keyMap)}';
}