jtdaugherty/brick
1
1
Fork 0
mirror of https://github.com/jtdaugherty/brick.git synced 2024-11-29 10:54:48 +03:00
Code Issues Projects Releases Wiki Activity

Keybindings.Pretty: add docs for attributes

Browse Source
This commit is contained in:
Jonathan Daugherty 2022-08-08 14:11:29 -07:00
parent b5b1f9329e
commit 2454714d1d
1 changed files with 9 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
src/Brick/Keybindings/Pretty.hs
View File

@ -3,16 +3,19 @@
-- and for generating Markdown, plain text, and Brick displays of event
-- handler's key binding configurations.
module Brick.Keybindings.Pretty
( keybindingTextTable
(
-- * Generating help output
keybindingTextTable
, keybindingMarkdownTable
, keybindingHelpWidget
-- * Pretty-printing primitives
, ppBinding
, ppMaybeBinding
, ppKey
, ppModifier
-- * Attributes
-- * Attributes for Widget rendering
, keybindingHelpBaseAttr
, eventNameAttr
, eventDescriptionAttr
@ -229,14 +232,18 @@ ppModifier Vty.MAlt = "A"
ppModifier Vty.MCtrl = "C"
ppModifier Vty.MShift = "S"
-- | The base attribute for 'Widget' keybinding help.
keybindingHelpBaseAttr :: AttrName
keybindingHelpBaseAttr = attrName "keybindingHelp"
-- | The attribute for event names in keybinding help 'Widget's.
eventNameAttr :: AttrName
eventNameAttr = keybindingHelpBaseAttr <> attrName "eventName"
-- | The attribute for event descriptions in keybinding help 'Widget's.
eventDescriptionAttr :: AttrName
eventDescriptionAttr = keybindingHelpBaseAttr <> attrName "eventDescription"
-- | The attribute for keybinding lists in keybinding help 'Widget's.
keybindingAttr :: AttrName
keybindingAttr = keybindingHelpBaseAttr <> attrName "keybinding"