diff --git a/CHANGELOG.md b/CHANGELOG.md --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,6 +2,14 @@ Brick changelog --------------- +2.5 +--- + +New features: +* `Brick.Widgets.ProgressBar` got a new function, `customProgressBar`, + which allows the customization of the fill characters used to draw a + progress bar. (Thanks @sectore) + 2.4 --- diff --git a/README.md b/README.md --- a/README.md +++ b/README.md @@ -108,13 +108,6 @@ | [`brick-filetree`](https://github.com/ChrisPenner/brick-filetree) [[Hackage]](http://hackage.haskell.org/package/brick-filetree) | A widget for exploring a directory tree and selecting or flagging files and directories | | [`brick-panes`](https://github.com/kquick/brick-panes) [[Hackage]](https://hackage.haskell.org/package/brick-panes) | A Brick overlay library providing composition and isolation of screen areas for TUI apps. | -Release Announcements / News ----------------------------- - -Find out about `brick` releases and other news on Twitter: - -https://twitter.com/brick_haskell/ - Getting Started --------------- diff --git a/brick.cabal b/brick.cabal --- a/brick.cabal +++ b/brick.cabal @@ -1,5 +1,5 @@ name: brick -version: 2.4 +version: 2.5 synopsis: A declarative terminal user interface library description: Write terminal user interfaces (TUIs) painlessly with 'brick'! You diff --git a/programs/CustomEventDemo.hs b/programs/CustomEventDemo.hs --- a/programs/CustomEventDemo.hs +++ b/programs/CustomEventDemo.hs @@ -54,9 +54,9 @@ case e of VtyEvent (V.EvKey V.KEsc []) -> halt VtyEvent _ -> stLastBrickEvent .= (Just e) - -- AppEvent Counter -> do - -- stCounter %= (+1) - -- stLastBrickEvent .= (Just e) + AppEvent Counter -> do + stCounter %= (+1) + stLastBrickEvent .= (Just e) _ -> return () initialState :: St diff --git a/programs/ProgressBarDemo.hs b/programs/ProgressBarDemo.hs --- a/programs/ProgressBarDemo.hs +++ b/programs/ProgressBarDemo.hs @@ -21,12 +21,13 @@ import Brick.Widgets.Core ( (<+>), (<=>) , str + , strWrap , updateAttrMap , overrideAttr ) import Brick.Util (fg, bg, on, clamp) -data MyAppState n = MyAppState { _x, _y, _z :: Float } +data MyAppState n = MyAppState { _x, _y, _z :: Float, _showLabel :: Bool } makeLenses ''MyAppState @@ -48,13 +49,32 @@ zBar = overrideAttr P.progressCompleteAttr zDoneAttr $ overrideAttr P.progressIncompleteAttr zToDoAttr $ bar $ _z p - lbl c = Just $ show $ fromEnum $ c * 100 + -- custom bars + cBar1 = overrideAttr P.progressCompleteAttr cDoneAttr1 $ + overrideAttr P.progressIncompleteAttr cToDoAttr1 + $ bar' '▰' '▱' $ _x p + cBar2 = overrideAttr P.progressCompleteAttr cDoneAttr2 $ + overrideAttr P.progressIncompleteAttr cToDoAttr2 + $ bar' '|' '─' $ _y p + cBar3 = overrideAttr P.progressCompleteAttr cDoneAttr $ + overrideAttr P.progressIncompleteAttr cToDoAttr + $ bar' '⣿' '⠶' $ _z p + lbl c = if _showLabel p + then Just $ " " ++ (show $ fromEnum $ c * 100) ++ " " + else Nothing bar v = P.progressBar (lbl v) v + bar' cc ic v = P.customProgressBar cc ic (lbl v) v ui = (str "X: " <+> xBar) <=> (str "Y: " <+> yBar) <=> (str "Z: " <+> zBar) <=> + (str "X: " <+> cBar1) <=> + (str "Y: " <+> cBar2) <=> + (str "Z: " <+> cBar3) <=> str "" <=> - str "Hit 'x', 'y', or 'z' to advance progress, or 'q' to quit" + (strWrap $ concat [ "Hit 'x', 'y', or 'z' to advance progress," + , "'t' to toggle labels, 'r' to revert values, " + , "'Ctrl + r' to reset values or 'q' to quit" + ]) appEvent :: T.BrickEvent () e -> T.EventM () (MyAppState ()) () appEvent (T.VtyEvent e) = @@ -63,12 +83,18 @@ V.EvKey (V.KChar 'x') [] -> x %= valid . (+ 0.05) V.EvKey (V.KChar 'y') [] -> y %= valid . (+ 0.03) V.EvKey (V.KChar 'z') [] -> z %= valid . (+ 0.02) + V.EvKey (V.KChar 't') [] -> showLabel %= not + V.EvKey (V.KChar 'r') [V.MCtrl] -> do + x .= 0 + y .= 0 + z .= 0 + V.EvKey (V.KChar 'r') [] -> T.put initialState V.EvKey (V.KChar 'q') [] -> M.halt _ -> return () appEvent _ = return () initialState :: MyAppState () -initialState = MyAppState 0.25 0.18 0.63 +initialState = MyAppState 0.25 0.18 0.63 True theBaseAttr :: A.AttrName theBaseAttr = A.attrName "theBase" @@ -85,6 +111,18 @@ zDoneAttr = theBaseAttr <> A.attrName "Z:done" zToDoAttr = theBaseAttr <> A.attrName "Z:remaining" +cDoneAttr, cToDoAttr :: A.AttrName +cDoneAttr = A.attrName "C:done" +cToDoAttr = A.attrName "C:remaining" + +cDoneAttr1, cToDoAttr1 :: A.AttrName +cDoneAttr1 = A.attrName "C1:done" +cToDoAttr1 = A.attrName "C1:remaining" + +cDoneAttr2, cToDoAttr2 :: A.AttrName +cDoneAttr2 = A.attrName "C2:done" +cToDoAttr2 = A.attrName "C2:remaining" + theMap :: A.AttrMap theMap = A.attrMap V.defAttr [ (theBaseAttr, bg V.brightBlack) @@ -93,6 +131,12 @@ , (yDoneAttr, V.magenta `on` V.yellow) , (zDoneAttr, V.blue `on` V.green) , (zToDoAttr, V.blue `on` V.red) + , (cDoneAttr, fg V.blue) + , (cToDoAttr, fg V.blue) + , (cDoneAttr1, fg V.red) + , (cToDoAttr1, fg V.brightWhite) + , (cDoneAttr2, fg V.green) + , (cToDoAttr2, fg V.brightGreen) , (P.progressIncompleteAttr, fg V.yellow) ] diff --git a/src/Brick/Widgets/ProgressBar.hs b/src/Brick/Widgets/ProgressBar.hs --- a/src/Brick/Widgets/ProgressBar.hs +++ b/src/Brick/Widgets/ProgressBar.hs @@ -3,6 +3,7 @@ -- | This module provides a progress bar widget. module Brick.Widgets.ProgressBar ( progressBar + , customProgressBar -- * Attributes , progressCompleteAttr , progressIncompleteAttr @@ -37,17 +38,42 @@ -> Float -- ^ The progress value. Should be between 0 and 1 inclusive. -> Widget n -progressBar mLabel progress = +progressBar = customProgressBar ' ' ' ' + +-- | Draw a progress bar with the specified (optional) label, +-- progress value and custom characters to fill the progress. +-- This fills available horizontal space and is one row high. +-- Please be aware of using wide characters in Brick, +-- see [Wide Character Support and the TextWidth class](https://github.com/jtdaugherty/brick/blob/master/docs/guide.rst#wide-character-support-and-the-textwidth-class) +customProgressBar :: Char + -- ^ Character to fill the completed part. + -> Char + -- ^ Character to fill the incomplete part. + -> Maybe String + -- ^ The label. If specified, this is shown in the center of + -- the progress bar. + -> Float + -- ^ The progress value. Should be between 0 and 1 inclusive. + -> Widget n +customProgressBar completeChar incompleteChar mLabel progress = Widget Greedy Fixed $ do c <- getContext let barWidth = c^.availWidthL label = fromMaybe "" mLabel labelWidth = safeWcswidth label spacesWidth = barWidth - labelWidth - leftPart = replicate (spacesWidth `div` 2) ' ' - rightPart = replicate (barWidth - (labelWidth + length leftPart)) ' ' + leftWidth = spacesWidth `div` 2 + rightWidth = barWidth - labelWidth - leftWidth + completeWidth = round $ progress * toEnum barWidth + + leftCompleteWidth = min leftWidth completeWidth + leftIncompleteWidth = leftWidth - leftCompleteWidth + leftPart = replicate leftCompleteWidth completeChar ++ replicate leftIncompleteWidth incompleteChar + rightCompleteWidth = max 0 (completeWidth - labelWidth - leftWidth) + rightIncompleteWidth = rightWidth - rightCompleteWidth + rightPart = replicate rightCompleteWidth completeChar ++ replicate rightIncompleteWidth incompleteChar + fullBar = leftPart <> label <> rightPart - completeWidth = round $ progress * toEnum (length fullBar) adjustedCompleteWidth = if completeWidth == length fullBar && progress < 1.0 then completeWidth - 1 else if completeWidth == 0 && progress > 0.0