Safe Haskell	None
Language	GHC2024

NanoUI.Widgets.Combo

Description

Combo box: a search field with a filtered, scrollable suggestion dropdown. The per-frame logic is the pure comboStep over a persisted ComboState.

Synopsis

comboBox :: forall f (es :: [Effect]). (Foldable f, Ui :> es) => Text -> f Text -> Text -> Eff es Text
comboBox' :: forall f (es :: [Effect]). (Foldable f, Ui :> es) => Text -> f Text -> Text -> Eff es (Response, Text)
data ComboState = ComboState {
- csHighlight :: !Int
- csWindow :: !Int
- csScrollX :: !Float
- csContentW :: !Float
- csDrag :: !Int
- csDragOff :: !Float
- csCommitted :: !Text
- csLive :: !Text
- csFocused :: !Bool
}
data ComboInput = ComboInput {
- ciFocused :: !Bool
- ciEdited :: !Bool
- ciText :: !Text
- ciRows :: ![Text]
- ciContentW :: !Float
- ciField :: !Rect
- ciMetrics :: !FontMetrics
- ciMouse :: !V2
- ciPressed :: !Bool
- ciDown :: !Bool
- ciScroll :: !V2
- ciKeyUp :: !Bool
- ciKeyDown :: !Bool
- ciEnter :: !Bool
- ciEscape :: !Bool
}
data ComboStep = ComboStep {
- stepState :: !ComboState
- stepCommit :: !(Maybe Text)
- stepPicked :: !Bool
- stepDismissed :: !Bool
- stepRedraw :: !Bool
}
comboStep :: ComboInput -> ComboState -> ComboStep

Documentation

comboBox :: forall f (es :: [Effect]). (Foldable f, Ui :> es) => Text -> f Text -> Text -> Eff es Text Source #

Combo box: the searchField with a select-style dropdown of options. While the field holds focus, the shared select dropdown overlay lists the options filtered by the field text (all of them while it is empty). The value is free text: options are suggestions, not a closed set. See comboStep for when the value commits. Pass the current text; the result is the text after this frame, and respChanged on comboBox' marks a commit.

comboBox' :: forall f (es :: [Effect]). (Foldable f, Ui :> es) => Text -> f Text -> Text -> Eff es (Response, Text) Source #

data ComboState Source #

A combo's state between frames.

Constructors

ComboState

Fields

csHighlight :: !Int
Highlighted row of the filtered list; -1 for none.
csWindow :: !Int
First visible row.
csScrollX :: !Float
csContentW :: !Float
Widest matching row, measured while focused.
csDrag :: !Int
Scrollbar thumb drag: 0 none, 1 vertical, 2 horizontal.
csDragOff :: !Float
Pointer offset into the dragged thumb.
csCommitted :: !Text
Last committed value.
csLive :: !Text
Field text the combo last produced.
csFocused :: !Bool

Instances

Instances details

Eq ComboState Source #
Instance details Defined in NanoUI.Widgets.Combo Methods (==) :: ComboState -> ComboState -> Bool # (/=) :: ComboState -> ComboState -> Bool #
Show ComboState Source #
Instance details Defined in NanoUI.Widgets.Combo Methods showsPrec :: Int -> ComboState -> ShowS # show :: ComboState -> String # showList :: [ComboState] -> ShowS #

data ComboInput Source #

One frame's inputs to comboStep.

Constructors

ComboInput

Fields

ciFocused :: !Bool
ciEdited :: !Bool
Typing changed the field text this frame.
ciText :: !Text
Field text after this frame's editing.
ciRows :: ![Text]
Options matching the field text.
ciContentW :: !Float
Width of the widest matching row.
ciField :: !Rect
The field's rect; empty before its first layout.
ciMetrics :: !FontMetrics
ciMouse :: !V2
ciPressed :: !Bool
ciDown :: !Bool
ciScroll :: !V2
ciKeyUp :: !Bool
ciKeyDown :: !Bool
ciEnter :: !Bool
ciEscape :: !Bool

data ComboStep Source #

What one frame of the combo decided.

Constructors

ComboStep
Fields stepState :: !ComboState stepCommit :: !(Maybe Text) The newly committed value, on the frame the committed value changes. stepPicked :: !Bool Enter picked the highlighted row; the caret moves to the text's end. stepDismissed :: !Bool Escape reverted the field to the committed value and releases focus. stepRedraw :: !Bool Something visible moved.

comboStep :: ComboInput -> ComboState -> ComboStep Source #

One frame of the combo: highlight, scrolling, thumb drags, and commits.

Typing edits the live text but never commits it: the committed value only changes on Enter (which commits the highlighted row only), on a row click (a field text the combo did not produce), or when the field loses focus. Escape reverts the live text to the last committed value. Hover highlights a row and makes it the Enter target; Up/Down move the highlight.