Put a border around the specified widget.
Modulebrick-3.0Haskell2010
Brick.Widgets.Border
This module provides border widgets: vertical borders, horizontal borders, and a box border wrapper widget. All functions in this module use the rendering context's active BorderStyle; to change the BorderStyle, use withBorderStyle.
Contents
Synopsis
- value border
- value borderWithLabel
- value hBorder
- value hBorderWithLabel
- value vBorder
- value borderElem
- value borderAttr
- value hBorderAttr
- value vBorderAttr
- value joinableBorder
- Packagebrick-3.0
- Exports10
- LanguageHaskell2010
- LicenceBSD-3-Clause
- SourceBorder.hs
Border wrapper
value
borderWithLabel Put a border around the specified widget with the specified label widget placed in the middle of the top horizontal border.
Note that a border will wrap its child widget as tightly as possible, which means that if the child widget is narrower than the label widget, the label widget will be truncated. If you want to avoid this behavior, add a fill or other space-filling wrapper to the bordered widget so that it takes up enough room to make the border horizontally able to avoid truncating the label.
Horizontal border
A horizontal border. Fills all horizontal space. Draws using hBorderAttr.
A horizontal border with a label placed in the center of the border. Fills all horizontal space.
Vertical border
A vertical border. Fills all vertical space. Draws using vBorderAttr.
Drawing single border elements
Draw the specified border element using the active border style using borderAttr.
Does not participate in dynamic borders (due to the difficulty of introspecting on the first argument); consider using joinableBorder instead.
Attribute names
The top-level border attribute name.
The horizontal border attribute name. Inherits from borderAttr.
The vertical border attribute name. Inherits from borderAttr.
Utility
A single-character dynamic border that will react to neighboring borders, initially connecting in the given directions.