| Safe Haskell | None |
|---|---|
| Language | Haskell2010 |
Brick.Widgets.List
Description
This module provides a scrollable list type and functions for manipulating and rendering it.
- data List e
- list :: Name -> (Bool -> e -> Widget) -> [e] -> List e
- renderList :: List e -> Widget
- listElementsL :: forall e. Lens' (List e) [e]
- listSelectedL :: forall e. Lens' (List e) (Maybe Int)
- listNameL :: forall e. Lens' (List e) Name
- listMoveBy :: Int -> List e -> List e
- listMoveTo :: Int -> List e -> List e
- listMoveUp :: List e -> List e
- listMoveDown :: List e -> List e
- listInsert :: Int -> e -> List e -> List e
- listRemove :: Int -> List e -> List e
- listReplace :: Eq e => [e] -> List e -> List e
- listSelectedElement :: List e -> Maybe (Int, e)
- listAttr :: AttrName
- listSelectedAttr :: AttrName
Documentation
List state. Lists have an element type e that is the data stored
by the list. Lists handle the following events by default:
- Up/down arrow keys: move cursor of selected item
Instances
| HandleEvent (List e) |
Consructing a list
Arguments
| :: Name | The list name (must be unique) |
| -> (Bool -> e -> Widget) | The item rendering function (takes the item and whether it is currently selected) |
| -> [e] | The initial list contents |
| -> List e |
Construct a list in terms of an element type e.
Rendering a list
renderList :: List e -> Widget Source
Turn a list state value into a widget.
Lenses
listElementsL :: forall e. Lens' (List e) [e] Source
Manipulating a list
listMoveBy :: Int -> List e -> List e Source
Move the list selected index by the specified amount, subject to validation.
listMoveTo :: Int -> List e -> List e Source
Set the selected index for a list to the specified index, subject to validation.
listMoveUp :: List e -> List e Source
Move the list selected index up by one. (Moves the cursor up, subtracts one from the index.)
listMoveDown :: List e -> List e Source
Move the list selected index down by one. (Moves the cursor down, adds one to the index.)
Arguments
| :: Int | The position at which to insert (0 <= i <= size) |
| -> e | The element to insert |
| -> List e | |
| -> List e |
Insert an item into a list at the specified position.
Remove an element from a list at the specified position.
listReplace :: Eq e => [e] -> List e -> List e Source
Replace the contents of a list with a new set of elements but preserve the currently selected index.
listSelectedElement :: List e -> Maybe (Int, e) Source
Return a list's selected element, if any.
Attributes
listSelectedAttr :: AttrName Source
The attribute used only for the currently-selected list item.
Extends listAttr.