Monomer.Widgets.Singles.ToggleButton

Toggle button widget, used for boolean values.

toggleButton "Toggle" booleanLens

Its behavior is equivalent to Monomer.Widgets.Singles.Checkbox and Monomer.Widgets.Singles.LabeledCheckbox, with a different visual representation.

See Monomer.Widgets.Singles.OptionButton for detailed notes.

Configuration

type ToggleButtonCfg s e = OptionButtonCfg s e Bool

Configuration options for toggleButton:

• ignoreTheme: whether to load default style from theme or start empty.
• toggleButtonOffStyle: style to use when the option is not active.
• trimSpaces: whether to remove leading/trailing spaces in the caption.
• ellipsis: if ellipsis should be used for overflown text.
• multiline: if text may be split in multiple lines.
• maxLines: maximum number of text lines to show.
• resizeFactor: flexibility to have more or less spaced assigned.
• resizeFactorW: flexibility to have more or less horizontal spaced assigned.
• resizeFactorH: flexibility to have more or less vertical spaced assigned.
• 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.
• onClick: event to raise when the value is clicked.
• onClickReq: WidgetRequest to generate when the value is clicked.
• onChange: event to raise when the value changes.
• onChangeReq: WidgetRequest to generate when the value changes.

toggleButtonOffStyle :: Style -> ToggleButtonCfg s e

Sets the style for the Off state of the toggle button.

Constructors

toggleButton

Arguments

:: Text

The caption.

-> ALens' s Bool

The lens into the model.

-> WidgetNode s e

The created toggle button.

Creates a toggleButton using the given lens.

toggleButton_

Arguments

:: Text

The caption.

-> ALens' s Bool

The lens into the model.

-> [ToggleButtonCfg s e]

The config options.

-> WidgetNode s e

The created toggle button.

Creates a toggleButton using the given lens. Accepts config.

toggleButtonV

Arguments

:: WidgetEvent e

=> Text

The caption.

-> Bool

The current value.

-> (Bool -> e)

The event to raise on change.

-> WidgetNode s e

The created toggle button.

Creates a toggleButton using the given value and onChange event handler.

toggleButtonV_

Arguments

:: WidgetEvent e

=> Text

The caption.

-> Bool

The current value.

-> (Bool -> e)

The event to raise on change.

-> [ToggleButtonCfg s e]

The config options.

-> WidgetNode s e

The created toggle button.

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

toggleButtonD_

Arguments

:: Text

The caption.

-> WidgetData s Bool

The WidgetData to retrieve the value from.

-> [ToggleButtonCfg s e]

The config options.

-> WidgetNode s e

The created toggle button.

Creates a toggleButton providing a WidgetData instance and config.