jtdaugherty/brick
1
1
Fork 0
mirror of https://github.com/jtdaugherty/brick.git synced 2024-10-27 09:38:28 +03:00
Code Issues Projects Releases Wiki Activity

Improve docs for scroll bar handle enabling functions

Browse Source
This commit is contained in:
Jonathan Daugherty 2022-01-31 09:44:59 -08:00
parent e402db29d4
commit 338deace08
1 changed files with 15 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
src/Brick/Widgets/Core.hs
View File

@ -1104,8 +1104,13 @@ withVScrollBars orientation w =
withReaderT (ctxVScrollBarOrientationL .~ Just orientation) (render w)
-- | Enable scroll bar handles on all vertical scroll bars in the
-- specified widget. This will only have an effect if 'withVScrollBars'
-- is also called.
-- specified widget. Handles appear at the ends of the scroll bar,
-- representing the "handles" that are typically clickable in
-- graphical UIs to move the scroll bar incrementally. Vertical
-- scroll bars are also clickable if mouse mode is enabled and if
-- 'withClickableVScrollBars' is used.
--
-- This will only have an effect if 'withVScrollBars' is also called.
withVScrollBarHandles :: Widget n -> Widget n
withVScrollBarHandles w =
Widget (hSize w) (vSize w) $
@ -1156,9 +1161,14 @@ withClickableVScrollBars f w =
Widget (hSize w) (vSize w) $
withReaderT (ctxVScrollBarClickableConstrL .~ Just f) (render w)
-- | Enable scroll bar handles on all horizontal scroll bars in the
-- specified widget. This will only have an effect if 'withHScrollBars'
-- is also called.
-- | Enable scroll bar handles on all horizontal scroll bars in
-- the specified widget. Handles appear at the ends of the scroll
-- bar, representing the "handles" that are typically clickable in
-- graphical UIs to move the scroll bar incrementally. Horizontal
-- scroll bars are also clickable if mouse mode is enabled and if
-- 'withClickableHScrollBars' is used.
--
-- This will only have an effect if 'withHScrollBars' is also called.
withHScrollBarHandles :: Widget n -> Widget n
withHScrollBarHandles w =
Widget (hSize w) (vSize w) $