Monomer.Widgets.Containers.Scroll

Scroll container of a single node. Assigns all the space the inner node requests but limits itself to what its parent assigns. It allows navigating the content of the inner node with the scroll bars. It also supports automatic focus following.

Accepts the following messages:

• ScrollTo: Causes the scroll to update its handles to ensure rect is visible.
• ScrollReset: Sets both handle positions to zero.

vscroll (vstack longItemsList)

Configuration

data ScrollCfg s e

Configuration options for scroll:

• scrollOverlay: whether scroll bar should be on top of content or by the side.
• scrollInvisible: shortcut for setting invisible style. Useful with scroll overlay, since it allows scrolling without taking up space or hiding content.
• scrollFollowFocus: whether to auto scroll when focusing a non visible item.
• scrollStyle: the base style of the scroll bar.
• wheelRate: rate at which wheel movement causes scrolling.
• barColor: the color of the bar (container of the thumb).
• barHoverColor: the color of the bar when mouse is on top.
• barWidth: the width of the bar.
• thumbColor: the color of the thumb.
• thumbHoverColor: the color of the thumb when mouse is on top.
• thumbWidth: the width of the thumb.
• thumbMinSize: the minimum size of the thumb.
• thumbRadius: the radius of the corners of the thumb.
• onChange: event to raise when the viewport changes.
• onChangeReq: WidgetRequest to generate when the viewport changes.

Instances

Semigroup (ScrollCfg s e)

Defined in Monomer.Widgets.Containers.Scroll

Methods

(<>) :: ScrollCfg s e -> ScrollCfg s e -> ScrollCfg s e

sconcat :: NonEmpty (ScrollCfg s e) -> ScrollCfg s e

stimes :: Integral b => b -> ScrollCfg s e -> ScrollCfg s e

Monoid (ScrollCfg s e)

Defined in Monomer.Widgets.Containers.Scroll

Methods

mempty :: ScrollCfg s e

mappend :: ScrollCfg s e -> ScrollCfg s e -> ScrollCfg s e

mconcat :: [ScrollCfg s e] -> ScrollCfg s e

Default (ScrollCfg s e)

Defined in Monomer.Widgets.Containers.Scroll

Methods

def :: ScrollCfg s e

CmbThumbMinSize (ScrollCfg s e)

Defined in Monomer.Widgets.Containers.Scroll

Methods

thumbMinSize :: Double -> ScrollCfg s e

CmbThumbWidth (ScrollCfg s e)

Defined in Monomer.Widgets.Containers.Scroll

Methods

thumbWidth :: Double -> ScrollCfg s e

CmbThumbRadius (ScrollCfg s e)

Defined in Monomer.Widgets.Containers.Scroll

Methods

thumbRadius :: Double -> ScrollCfg s e

CmbThumbHoverColor (ScrollCfg s e)

Defined in Monomer.Widgets.Containers.Scroll

Methods

thumbHoverColor :: Color -> ScrollCfg s e

CmbThumbColor (ScrollCfg s e)

Defined in Monomer.Widgets.Containers.Scroll

Methods

thumbColor :: Color -> ScrollCfg s e

CmbBarWidth (ScrollCfg s e)

Defined in Monomer.Widgets.Containers.Scroll

Methods

barWidth :: Double -> ScrollCfg s e

CmbBarHoverColor (ScrollCfg s e)

Defined in Monomer.Widgets.Containers.Scroll

Methods

barHoverColor :: Color -> ScrollCfg s e

CmbBarColor (ScrollCfg s e)

Defined in Monomer.Widgets.Containers.Scroll

Methods

barColor :: Color -> ScrollCfg s e

CmbWheelRate (ScrollCfg s e) Rational

Defined in Monomer.Widgets.Containers.Scroll

Methods

wheelRate :: Rational -> ScrollCfg s e

WidgetEvent e => CmbOnChange (ScrollCfg s e) ScrollStatus e

Defined in Monomer.Widgets.Containers.Scroll

Methods

onChange :: (ScrollStatus -> e) -> ScrollCfg s e

CmbOnChangeReq (ScrollCfg s e) s e ScrollStatus

Defined in Monomer.Widgets.Containers.Scroll

Methods

onChangeReq :: (ScrollStatus -> WidgetRequest s e) -> ScrollCfg s e

data ScrollStatus

Information provided in the onChange event.

The currently visible viewport is affected by the position of the scroll bars, their size and any other parent widget that restricts the visible viewport (e.g., another scroll).

Constructors

ScrollStatus

Fields

• scrollDeltaX :: Double

  Displacement in the x axis.

• scrollDeltaY :: Double

  Displacement in the y axis.

• scrollRect :: Rect

  The viewport assigned to the scroll widget.

• scrollVpSize :: Size

  The currently visible viewport.

• scrollChildSize :: Size

  The total size of the child widget.

Instances

Eq ScrollStatus

Defined in Monomer.Widgets.Containers.Scroll

Methods

(==) :: ScrollStatus -> ScrollStatus -> Bool

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

Show ScrollStatus

Defined in Monomer.Widgets.Containers.Scroll

Methods

showsPrec :: Int -> ScrollStatus -> ShowS

show :: ScrollStatus -> String

showList :: [ScrollStatus] -> ShowS

Default ScrollStatus

Defined in Monomer.Widgets.Containers.Scroll

Methods

def :: ScrollStatus

WidgetEvent e => CmbOnChange (ScrollCfg s e) ScrollStatus e

Defined in Monomer.Widgets.Containers.Scroll

Methods

onChange :: (ScrollStatus -> e) -> ScrollCfg s e

CmbOnChangeReq (ScrollCfg s e) s e ScrollStatus

Defined in Monomer.Widgets.Containers.Scroll

Methods

onChangeReq :: (ScrollStatus -> WidgetRequest s e) -> ScrollCfg s e

data ScrollMessage

Messages the scroll component supports.

Constructors

ScrollTo Rect

Causes the scroll to update its bars to ensure rect is visible.

ScrollReset

Sets both bars to zero.

Instances

Eq ScrollMessage

Defined in Monomer.Widgets.Containers.Scroll

Methods

(==) :: ScrollMessage -> ScrollMessage -> Bool

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

Show ScrollMessage

Defined in Monomer.Widgets.Containers.Scroll

Methods

showsPrec :: Int -> ScrollMessage -> ShowS

show :: ScrollMessage -> String

showList :: [ScrollMessage] -> ShowS

scrollOverlay :: ScrollCfg s e

Scroll bars will be displayed on top of the content.

scrollOverlay_ :: Bool -> ScrollCfg s e

Sets whether scroll bars will be displayed on top of the content or next to it.

scrollFwdStyle :: (WidgetEnv s e -> Style -> (Style, Style)) -> ScrollCfg s e

Sets a function that will split the node's style into one for the scroll and one for the child node. Useful for widgets which wrap themselves in a scroll, such as textArea, to be able to receive customizations made by the user.

scrollFwdDefault :: WidgetEnv s e -> Style -> (Style, Style)

Default style forward function, keeping standard fields for scroll.

scrollInvisible :: ScrollCfg s e

Sets the style of the scroll bars to transparent.

scrollInvisible_ :: Bool -> ScrollCfg s e

Whether to set the style of the scroll bars to transparent.

scrollFollowFocus :: ScrollCfg s e

Makes the scroll automatically follow focused items to make them visible.

scrollFollowFocus_ :: Bool -> ScrollCfg s e

Whether to automatically follow focused items to make them visible.

scrollStyle :: ALens' ThemeState StyleState -> ScrollCfg s e

Sets the base style of the scroll bar. Useful when creating widgets which use scroll and may need to customize it.

Constructors

scroll :: WidgetNode s e -> WidgetNode s e

Creates a scroll node that may show both bars.

scroll_ :: [ScrollCfg s e] -> WidgetNode s e -> WidgetNode s e

Creates a scroll node that may show both bars. Accepts config.

hscroll :: WidgetNode s e -> WidgetNode s e

Creates a horizontal scroll node. Vertical space is equal to what the parent node assigns.

hscroll_ :: [ScrollCfg s e] -> WidgetNode s e -> WidgetNode s e

Creates a horizontal scroll node. Vertical space is equal to what the parent node assigns. Accepts config.

vscroll :: WidgetNode s e -> WidgetNode s e

Creates a vertical scroll node. Vertical space is equal to what the parent node assigns.

vscroll_ :: [ScrollCfg s e] -> WidgetNode s e -> WidgetNode s e

Creates a vertical scroll node. Vertical space is equal to what the parent node assigns. Accepts config.