Reflex.Vty.Widget.Scroll

Documentation

data ScrollToBottom

Configuration options for automatic scroll-to-bottom behavior

Constructors

ScrollToBottom_Always

Always scroll to the bottom on new output

ScrollToBottom_Maintain

Scroll down with new output only when, prior to the new output being added, the widget was scrolled all the way to the bottom.

Instances

Eq ScrollToBottom

Defined in Reflex.Vty.Widget.Scroll

Methods

(==) :: ScrollToBottom -> ScrollToBottom -> Bool

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

Ord ScrollToBottom

Defined in Reflex.Vty.Widget.Scroll

Methods

compare :: ScrollToBottom -> ScrollToBottom -> Ordering

(<) :: ScrollToBottom -> ScrollToBottom -> Bool

(<=) :: ScrollToBottom -> ScrollToBottom -> Bool

(>) :: ScrollToBottom -> ScrollToBottom -> Bool

(>=) :: ScrollToBottom -> ScrollToBottom -> Bool

max :: ScrollToBottom -> ScrollToBottom -> ScrollToBottom

min :: ScrollToBottom -> ScrollToBottom -> ScrollToBottom

Show ScrollToBottom

Defined in Reflex.Vty.Widget.Scroll

Methods

showsPrec :: Int -> ScrollToBottom -> ShowS

show :: ScrollToBottom -> String

showList :: [ScrollToBottom] -> ShowS

data ScrollableConfig t

Configuration for the scrollable element. Controls scroll behavior.

Constructors

ScrollableConfig

Fields

• _scrollableConfig_scrollBy :: Event t Int

  Number of lines to scroll by

• _scrollableConfig_scrollTo :: Event t ScrollPos

  Specific position to scroll to

• _scrollableConfig_startingPosition :: ScrollPos

  The initial scroll position

• _scrollableConfig_scrollToBottom :: Behavior t (Maybe ScrollToBottom)

  How the scroll position should be adjusted as new content is added

Instances

Reflex t => Default (ScrollableConfig t)

Defined in Reflex.Vty.Widget.Scroll

Methods

def :: ScrollableConfig t

data ScrollPos

The scroll position

Constructors

ScrollPos_Top

ScrollPos_Line Int

ScrollPos_Bottom

Instances

Eq ScrollPos

Defined in Reflex.Vty.Widget.Scroll

Methods

(==) :: ScrollPos -> ScrollPos -> Bool

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

Ord ScrollPos

Defined in Reflex.Vty.Widget.Scroll

Methods

compare :: ScrollPos -> ScrollPos -> Ordering

(<) :: ScrollPos -> ScrollPos -> Bool

(<=) :: ScrollPos -> ScrollPos -> Bool

(>) :: ScrollPos -> ScrollPos -> Bool

(>=) :: ScrollPos -> ScrollPos -> Bool

max :: ScrollPos -> ScrollPos -> ScrollPos

min :: ScrollPos -> ScrollPos -> ScrollPos

Show ScrollPos

Defined in Reflex.Vty.Widget.Scroll

Methods

showsPrec :: Int -> ScrollPos -> ShowS

show :: ScrollPos -> String

showList :: [ScrollPos] -> ShowS

data Scrollable t

The output of a scrollable, indicating its current scroll position.

Constructors

Scrollable

Fields

• _scrollable_scrollPosition :: Behavior t ScrollPos
• _scrollable_totalLines :: Behavior t Int
• _scrollable_scrollHeight :: Behavior t Int

scrollable :: forall t m. (Reflex t, MonadHold t m, MonadFix m, HasDisplayRegion t m, HasInput t m, HasImageWriter t m, HasTheme t m) => ScrollableConfig t -> m (Behavior t Image, Event t ()) -> m (Scrollable t)

Scrollable widget. The output exposes the current scroll position and total number of lines (including those that are hidden)

scrollByLines :: ScrollPos -> Int -> Int -> Int -> ScrollPos

Modify the scroll position by the given number of lines

scrollToLine :: Int -> Int -> Int -> ScrollPos

Scroll to a particular line