Safe Haskell	Safe-Inferred
Language	Haskell2010

Brick.Keybindings.Pretty

Contents

Generating help output
Pretty-printing primitives
Attributes for Widget rendering

Description

This module provides functions for pretty-printing key bindings and for generating Markdown, plain text, and Brick displays of event handler key binding configurations.

Synopsis

keybindingTextTable :: Ord k => KeyConfig k -> [(Text, [KeyEventHandler k m])] -> Text
keybindingMarkdownTable :: Ord k => KeyConfig k -> [(Text, [KeyEventHandler k m])] -> Text
keybindingHelpWidget :: Ord k => KeyConfig k -> [KeyEventHandler k m] -> Widget n
ppBinding :: Binding -> Text
ppMaybeBinding :: Maybe Binding -> Text
ppKey :: Key -> Text
ppModifier :: Modifier -> Text
keybindingHelpBaseAttr :: AttrName
eventNameAttr :: AttrName
eventDescriptionAttr :: AttrName
keybindingAttr :: AttrName

Generating help output

keybindingTextTable Source #

Arguments

:: Ord k
=> KeyConfig k	The key binding configuration in use.
-> [(Text, [KeyEventHandler k m])]	Key event handlers by named section.
-> Text

Generate a plain text document of sections indicating the key binding state for each event handler.

keybindingMarkdownTable Source #

Arguments

:: Ord k
=> KeyConfig k	The key binding configuration in use.
-> [(Text, [KeyEventHandler k m])]	Key event handlers by named section.
-> Text

Generate a Markdown document of sections indicating the key binding state for each event handler.

keybindingHelpWidget Source #

Arguments

:: Ord k
=> KeyConfig k	The key binding configuration in use.
-> [KeyEventHandler k m]	The list of the event handlers to include in the help display.
-> Widget n

Build a Widget displaying key binding information for a single related group of event handlers. This is provided for convenience so that basic help text for the application's event handlers can be produced and embedded in the UI.

The resulting widget lists the key events (and keys) bound to the specified handlers, along with the events' names and the list of available key bindings for each handler.