GHCup.Brick.Widgets.Menu

Documentation

type Formatter n = Bool -> Widget n -> Widget n

Just some type synonym to make things explicit

type Label = Text

A label

type HelpMessage = Text

A help message of an entry

type ButtonName n = n

A button name

idFormatter :: Formatter n

type ErrorMessage = Text

An error message

data ErrorStatus

Constructors

Valid

Invalid ErrorMessage

Instances

Eq ErrorStatus

Defined in GHCup.Brick.Widgets.Menu

Methods

(==) :: ErrorStatus -> ErrorStatus -> Bool

(/=) :: ErrorStatus -> ErrorStatus -> Bool

emptyLens :: Lens' s ()

A lens which does nothing. Usefull to defined no-op fields

data FieldInput a b n

A FieldInput is a pair label-content a - is the type of the field it manipulates b - is its internal state (modified in the gui) n - your application's resource name type

Constructors

FieldInput

Fields

• inputState :: b

  The state of the input field (what's rendered in the screen)

• inputValidator :: b -> Either ErrorMessage a

  A validator function

• inputHelp :: HelpMessage

  The input helpMessage

• inputRender :: Bool -> ErrorStatus -> HelpMessage -> Label -> b -> (Widget n -> Widget n) -> (Widget n, Maybe (Widget n))

  How to draw the input and optionally an overlay, with focus a help message and input. A extension function can be applied too

• inputHandler :: BrickEvent n () -> EventM n b ()

  The handler

inputValidatorL :: forall a b n a. Lens (FieldInput a b n) (FieldInput a b n) (b -> Either ErrorMessage a) (b -> Either ErrorMessage a)

inputStateL :: forall a b n. Lens' (FieldInput a b n) b

inputHelpL :: forall a b n. Lens' (FieldInput a b n) HelpMessage

data MenuField s n where

The MenuField is an existential type which stores a Lens' to a part of the Menu state. In also contains a Field input which internal state is hidden

Constructors

MenuField

Fields

• :: { fieldAccesor :: Lens' s a

  A Lens pointing to some part of the state

•    , fieldInput :: FieldInput a b n

  The input which modifies the state

•    , fieldLabel :: Label

  The label

•    , fieldStatus :: ErrorStatus

  Whether the current is valid or not.

•    , fieldName :: n
•    } -> MenuField s n

Instances

Named (MenuField s n) n

Defined in GHCup.Brick.Widgets.Menu

Methods

getName :: MenuField s n -> n

isValidField :: MenuField s n -> Bool

fieldStatusL :: forall s n. Lens' (MenuField s n) ErrorStatus

fieldLabelL :: forall s n. Lens' (MenuField s n) Label

data SelectState i n

Constructors

SelectState

Fields

• selectStateItems :: (NonEmpty (Int, (i, Bool)), Bool)

  All items along with their selected state And Bool to indicate if editable field is selected

• selectStateEditState :: Maybe (Editor Text n)

  Editable field's editor state

• selectStateFocusRing :: FocusRing Int

  Focus ring using integeral values assigned to each item

• selectStateOverlayOpen :: Bool

  Whether the select menu is open

selectStateOverlayOpenL :: forall i n. Lens' (SelectState i n) Bool

selectStateItemsL :: forall i n i. Lens (SelectState i n) (SelectState i n) (NonEmpty (Int, (i, Bool)), Bool) (NonEmpty (Int, (i, Bool)), Bool)

selectStateFocusRingL :: forall i n. Lens' (SelectState i n) (FocusRing Int)

selectStateEditStateL :: forall i n n. Lens (SelectState i n) (SelectState i n) (Maybe (Editor Text n)) (Maybe (Editor Text n))

data EditState n

Constructors

EditState

Fields

• editState :: Editor Text n
• editStateOverlayOpen :: Bool

  Whether the edit menu is open

editStateOverlayOpenL :: forall n. Lens' (EditState n) Bool

editStateL :: forall n n. Lens (EditState n) (EditState n) (Editor Text n) (Editor Text n)

data MenuKeyBindings

Constructors

MenuKeyBindings

Fields

• mKbUp :: KeyCombination
• mKbDown :: KeyCombination
• mKbQuit :: KeyCombination

Instances

Show MenuKeyBindings

Defined in GHCup.Brick.Widgets.Menu

Methods

showsPrec :: Int -> MenuKeyBindings -> ShowS

show :: MenuKeyBindings -> String

showList :: [MenuKeyBindings] -> ShowS

mKbUpL :: Lens' MenuKeyBindings KeyCombination

mKbQuitL :: Lens' MenuKeyBindings KeyCombination

mKbDownL :: Lens' MenuKeyBindings KeyCombination

fieldHelpMsgL :: Lens' (MenuField s n) HelpMessage

A fancy lens to the help message

drawField :: Formatter n -> Bool -> MenuField s n -> Widget n

How to draw a field given a formater

drawFieldOverlay :: MenuField s n -> Maybe (Widget n)

CheckBox widget *****************

type CheckBoxField = MenuField

createCheckBoxInput :: FieldInput Bool Bool n

createCheckBoxField :: n -> Lens' s Bool -> CheckBoxField s n

Editable widget *****************

type EditableField = MenuField

createEditableInput :: (Ord n, Show n) => Text -> n -> (Text -> Either ErrorMessage a) -> FieldInput a (EditState n) n

createEditableField' :: (Eq n, Ord n, Show n) => Text -> n -> (Text -> Either ErrorMessage a) -> Lens' s a -> EditableField s n

createEditableField :: (Eq n, Ord n, Show n) => n -> (Text -> Either ErrorMessage a) -> Lens' s a -> EditableField s n

Button widget *****************

type Button = MenuField

createButtonInput :: FieldInput () () n

createButtonField :: n -> Button s n

Select widget *****************

type SelectField = MenuField

createSelectInput :: (Ord n, Show n) => NonEmpty i -> (i -> Text) -> (Int -> (NonEmpty (Int, (i, Bool)), Bool) -> (NonEmpty (Int, (i, Bool)), Bool)) -> (([i], Maybe Text) -> Either ErrorMessage k) -> n -> Maybe n -> MenuKeyBindings -> FieldInput k (SelectState i n) n

createSelectField :: (Ord n, Show n) => n -> Lens' s (Maybe i) -> NonEmpty i -> (i -> Text) -> MenuKeyBindings -> SelectField s n

Select Field with only single selection possible, aka radio button

createMultiSelectField :: (Ord n, Show n) => n -> Lens' s [i] -> NonEmpty i -> (i -> Text) -> MenuKeyBindings -> SelectField s n

Select Field with multiple selections possible

createSelectFieldWithEditable :: (Ord n, Show n) => n -> n -> Lens' s (Either a i) -> (Text -> Either ErrorMessage a) -> NonEmpty i -> (i -> Text) -> MenuKeyBindings -> SelectField s n

Select Field with only single selection possible, along with an editable field

Utilities *****************

highlighted :: Widget n -> Widget n

highlights a widget (using List.listSelectedFocusedAttr)

renderAslabel :: Text -> Bool -> Widget n

Given a text, crates a highlighted label on focus. An amplifier can be passed

leftify :: Int -> Widget n -> Widget n

Creates a left align column. Example: |- col2 is align dispite the length of col1 row1_col1 row1_col2 row2_col1_large row2_col2

rightify :: Int -> Widget n -> Widget n

Creates a right align column. Example: |- col2 is align dispite the length of col1 row1_col1 row1_col2 row2_col1_large row2_col2

renderAsHelpMsg :: Text -> Widget n

render some Text using helpMsgAttr

renderAsErrMsg :: Text -> Widget n

render some Text using errMsgAttr

overlayLayer :: Text -> Widget n -> Widget n

Used to create a layer on top of menu

Menu widget *****************

data Menu s n

A menu is a list of Fields and a state. Informally we can think about s in terms of the record type returned by a form.

Constructors

Menu

Fields

• menuFields :: [MenuField s n]

  The datatype representing the list of entries. Precisely, any array-like data type is highly unconvinient.

• menuState :: s
• menuValidator :: s -> Maybe ErrorMessage

  A validator function

• menuButtons :: [Button s n]

  The buttons. Commonly, the handlers for buttons are defined outside the menu handler.

• menuFocusRing :: FocusRing n

  The focus ring with the resource name for each entry and each button, in the order you want to loop them.

• menuKeyBindings :: MenuKeyBindings

  KeyBindings for navigation

• menuName :: n

  The resource Name.

• menuTitle :: Text

  Menu title.

menuValidatorL :: forall s n. Lens' (Menu s n) (s -> Maybe ErrorMessage)

menuTitleL :: forall s n. Lens' (Menu s n) Text

menuStateL :: forall s n. Lens' (Menu s n) s

menuNameL :: forall s n. Lens' (Menu s n) n

menuKeyBindingsL :: forall s n. Lens' (Menu s n) MenuKeyBindings

menuFocusRingL :: forall s n. Lens' (Menu s n) (FocusRing n)

menuFieldsL :: forall s n. Lens' (Menu s n) [MenuField s n]

menuButtonsL :: forall s n. Lens' (Menu s n) [Button s n]

isValidMenu :: Menu s n -> Bool

createMenu :: n -> s -> Text -> (s -> Maybe ErrorMessage) -> MenuKeyBindings -> [Button s n] -> [MenuField s n] -> Menu s n

handlerMenu :: forall n e s. Eq n => BrickEvent n e -> EventM n (Menu s n) ()

drawMenu :: (Eq n, Ord n, Show n, Named (MenuField s n) n) => Menu s n -> [Widget n]