Monomer.Widgets.Containers.SelectList

Select list widget, allowing selection of a single item. List content (rows) is customizable, and so is its styling. This widget is used by Monomer.Widgets.Containers.Dropdown when in its open state.

makeRow username = hstack [
    label "User: ",
    label username
  ]

customSelect = selectList userLens usernames makeRow

Note: the content of the list will only be updated when the provided items change, based on their Eq instance. In case data external to the items is used for building the row nodes, mergeRequired may be needed to avoid stale content.

Configuration

data SelectListCfg s e a

Configuration options for selectList:

• onFocus: event to raise when focus is received.
• onFocusReq: WidgetRequest to generate when focus is received.
• onBlur: event to raise when focus is lost.
• onBlurReq: WidgetRequest to generate when focus is lost.
• onChange: event to raise when selected item changes.
• onChangeReq: WidgetRequest to generate when selected item changes.
• onChangeIdx: event to raise when selected item changes. Includes index,
• onChangeIdxReq: WidgetRequest to generate when selected item changes. Includes index.
• selectOnBlur: whether to select the currently highlighted item when navigating away from the widget with tab key.
• itemBasicStyle: style of an item in the list when not selected.
• itemSelectedStyle: style of the selected item in the list.
• mergeRequired: whether merging children is required. Useful when the content displayed depends on external data, since changes to data outside the provided list cannot be detected. In general it is recommended to only depend on data contained in the list itself, making sure the Eq instance of the item type is correct.

Instances

Monoid (SelectListCfg s e a)

Defined in Monomer.Widgets.Containers.SelectList

Methods

mempty :: SelectListCfg s e a

mappend :: SelectListCfg s e a -> SelectListCfg s e a -> SelectListCfg s e a

mconcat :: [SelectListCfg s e a] -> SelectListCfg s e a

Semigroup (SelectListCfg s e a)

Defined in Monomer.Widgets.Containers.SelectList

Methods

(<>) :: SelectListCfg s e a -> SelectListCfg s e a -> SelectListCfg s e a

sconcat :: NonEmpty (SelectListCfg s e a) -> SelectListCfg s e a

stimes :: Integral b => b -> SelectListCfg s e a -> SelectListCfg s e a

Default (SelectListCfg s e a)

Defined in Monomer.Widgets.Containers.SelectList

Methods

def :: SelectListCfg s e a

CmbSelectOnBlur (SelectListCfg s e a)

Defined in Monomer.Widgets.Containers.SelectList

Methods

selectOnBlur :: SelectListCfg s e a

selectOnBlur_ :: Bool -> SelectListCfg s e a

CmbItemBasicStyle (SelectListCfg s e a) Style

Defined in Monomer.Widgets.Containers.SelectList

Methods

itemBasicStyle :: Style -> SelectListCfg s e a

CmbItemSelectedStyle (SelectListCfg s e a) Style

Defined in Monomer.Widgets.Containers.SelectList

Methods

itemSelectedStyle :: Style -> SelectListCfg s e a

WidgetEvent e => CmbOnBlur (SelectListCfg s e a) e Path

Defined in Monomer.Widgets.Containers.SelectList

Methods

onBlur :: (Path -> e) -> SelectListCfg s e a

WidgetEvent e => CmbOnChange (SelectListCfg s e a) a e

Defined in Monomer.Widgets.Containers.SelectList

Methods

onChange :: (a -> e) -> SelectListCfg s e a

WidgetEvent e => CmbOnChangeIdx (SelectListCfg s e a) e a

Defined in Monomer.Widgets.Containers.SelectList

Methods

onChangeIdx :: (Int -> a -> e) -> SelectListCfg s e a

WidgetEvent e => CmbOnFocus (SelectListCfg s e a) e Path

Defined in Monomer.Widgets.Containers.SelectList

Methods

onFocus :: (Path -> e) -> SelectListCfg s e a

CmbOnBlurReq (SelectListCfg s e a) s e Path

Defined in Monomer.Widgets.Containers.SelectList

Methods

onBlurReq :: (Path -> WidgetRequest s e) -> SelectListCfg s e a

CmbOnChangeIdxReq (SelectListCfg s e a) s e a

Defined in Monomer.Widgets.Containers.SelectList

Methods

onChangeIdxReq :: (Int -> a -> WidgetRequest s e) -> SelectListCfg s e a

CmbOnChangeReq (SelectListCfg s e a) s e a

Defined in Monomer.Widgets.Containers.SelectList

Methods

onChangeReq :: (a -> WidgetRequest s e) -> SelectListCfg s e a

CmbOnFocusReq (SelectListCfg s e a) s e Path

Defined in Monomer.Widgets.Containers.SelectList

Methods

onFocusReq :: (Path -> WidgetRequest s e) -> SelectListCfg s e a

CmbMergeRequired (SelectListCfg s e a) (WidgetEnv s e) (Seq a)

Defined in Monomer.Widgets.Containers.SelectList

Methods

mergeRequired :: (WidgetEnv s e -> Seq a -> Seq a -> Bool) -> SelectListCfg s e a

type SelectListItem a = (Eq a, Show a, Typeable a)

Constraints for an item handled by selectList.

data SelectListMessage

Messages received by selectList. In general used internally.

Constructors

SelectListClickItem Int

SelectListShowSelected

Instances

Show SelectListMessage

Defined in Monomer.Widgets.Containers.SelectList

Methods

showsPrec :: Int -> SelectListMessage -> ShowS

show :: SelectListMessage -> String

showList :: [SelectListMessage] -> ShowS

Eq SelectListMessage

Defined in Monomer.Widgets.Containers.SelectList

Methods

(==) :: SelectListMessage -> SelectListMessage -> Bool

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

type SelectListMakeRow s e a = a -> WidgetNode s e

Creates a row from an item.

Constructors

selectList

Arguments

:: (WidgetModel s, WidgetEvent e, Traversable t, SelectListItem a)

=> ALens' s a

The lens into the model.

-> t a

The list of selectable items.

-> SelectListMakeRow s e a

Function to create the list items.

-> WidgetNode s e

The created dropdown.

Creates a select list using the given lens.

selectList_

Arguments

:: (WidgetModel s, WidgetEvent e, Traversable t, SelectListItem a)

=> ALens' s a

The lens into the model.

-> t a

The list of selectable items.

-> SelectListMakeRow s e a

Function to create the list items.

-> [SelectListCfg s e a]

The config options.

-> WidgetNode s e

The created dropdown.

Creates a select list using the given lens. Accepts config.

selectListV

Arguments

:: (WidgetModel s, WidgetEvent e, Traversable t, SelectListItem a)

=> a

The event to raise on change.

-> (Int -> a -> e)

The list of selectable items.

-> t a

The list of selectable items.

-> SelectListMakeRow s e a

Function to create the list items.

-> WidgetNode s e

The created dropdown.

Creates a select list using the given value and onChange event handler.

selectListV_

Arguments

:: (WidgetModel s, WidgetEvent e, Traversable t, SelectListItem a)

=> a

The event to raise on change.

-> (Int -> a -> e)

The list of selectable items.

-> t a

The list of selectable items.

-> SelectListMakeRow s e a

Function to create the list items.

-> [SelectListCfg s e a]

The config options.

-> WidgetNode s e

The created dropdown.

Creates a select list using the given value and onChange event handler. Accepts config.

selectListD_

Arguments

:: forall s e t a. (WidgetModel s, WidgetEvent e, Traversable t, SelectListItem a)

=> WidgetData s a

The WidgetData to retrieve the value from.

-> t a

The list of selectable items.

-> SelectListMakeRow s e a

Function to create the list items.

-> [SelectListCfg s e a]

The config options.

-> WidgetNode s e

The created dropdown.

Creates a dropdown providing a WidgetData instance and config.