Code
Hub
Workspaces
Following
Trending
Connect
MCP
copy
Create free account
hub
/
github.com/charmbracelet/lipgloss
/ types & classes
Types & classes
65 in github.com/charmbracelet/lipgloss
⨍
Functions
731
◇
Types & classes
65
↓ 5 callers
TypeAlias
NodeChildren
NodeChildren is the implementation of the Children interface with tree Nodes.
tree/children.go:15
↓ 4 callers
TypeAlias
Position
Position represents a position along a horizontal or vertical axis. It's in situations where an axis is involved, like alignment, joining, placement a
position.go:19
↓ 3 callers
TypeAlias
props
props is a set of properties.
style.go:94
Struct
AdaptiveColor
AdaptiveColor provides color options for light and dark backgrounds. The appropriate color will be returned at runtime based on the darkness of the te
compat/color.go:26
Struct
Border
Border contains a series of values which comprise the various parts of a border.
borders.go:16
Struct
Canvas
Canvas is a cell-buffer that can be used to compose and draw [uv.Drawable]s like [Layer]s. Composed drawables are drawn onto the canvas in the order
canvas.go:17
Interface
Children
Children is the interface that wraps the basic methods of a tree model.
tree/children.go:6
Struct
CompleteAdaptiveColor
CompleteAdaptiveColor specifies exact values for truecolor, ANSI256, and ANSI color profiles, with separate options for light and dark backgrounds. Au
compat/color.go:65
Struct
CompleteColor
CompleteColor specifies exact values for truecolor, ANSI256, and ANSI color profiles. Automatic color degradation will not be performed.
compat/color.go:42
FuncType
CompleteFunc
CompleteFunc is a function that returns the appropriate color based on the given color profile. Example usage: p := colorprofile.Detect(os.Stderr,
color.go:250
Struct
Compositor
Compositor manages the composition of layers. It flattens a layer hierarchy once and provides efficient drawing and hit testing operations. All comput
layer.go:188
Interface
Data
Data is the interface that wraps the basic methods of a table model.
table/rows.go:4
Struct
Document
examples/list/glow/main.go:8
FuncType
Enumerator
Enumerator enumerates a list. Given a list of items and the index of the current enumeration, it returns the prefix that should be displayed for the c
list/enumerator.go:26
FuncType
Enumerator
Enumerator enumerates a tree. Typically, this is used to draw the branches for the tree nodes and is different for the last child. For example, the d
tree/enumerator.go:15
Struct
Filter
Filter applies a filter on some data.
table/rows.go:66
Struct
Filter
Filter applies a filter on some data. You could use this to create a new tree whose values all satisfy the condition provided in the Filter() function
tree/children.go:59
FuncType
Indenter
Indenter indents the children of a tree. Indenters allow for displaying nested tree items with connecting borders to sibling nodes. For example, the
list/enumerator.go:42
FuncType
Indenter
Indenter indents the children of a tree. Indenters allow for displaying nested tree items with connecting borders to sibling nodes. For example, the
tree/enumerator.go:57
TypeAlias
Items
Items represents the list items.
list/list.go:58
Struct
Layer
Layer represents a visual layer with content and positioning. It's a pure data structure that defines the layer hierarchy without any computation.
layer.go:13
Struct
LayerHit
LayerHit represents the result of a hit test on a [Layer].
layer.go:159
Struct
Leaf
Leaf is a node without children.
tree/tree.go:46
FuncType
LightDarkFunc
LightDarkFunc is a function that returns a color based on whether the terminal has a light or dark background. You can create one of these with [Light
color.go:174
Struct
List
List represents a list of items that can be displayed. Lists can contain lists as items, they will be rendered as nested (sub)lists. In fact, lists c
list/list.go:34
Struct
NoColor
NoColor is used to specify the absence of color styling. When this is active foreground colors will be rendered with the terminal's default text color
color.go:52
Interface
Node
Node defines a node in a tree.
tree/tree.go:36
Struct
RGBColor
RGBColor is a color specified by red, green, and blue values.
color.go:138
Struct
Range
Range is a range of text and associated styling to be used with [StyleRanges].
ranges.go:45
Struct
StringData
StringData is a string-based implementation of the Data interface.
table/rows.go:16
Struct
Style
Style contains a set of rules that comprise a style as a whole.
style.go:142
Struct
Style
Style is the styling applied to the tree.
tree/renderer.go:13
FuncType
StyleFunc
StyleFunc is the style function that determines the style of a Cell. It takes the row and column of the cell as an input and determines the lipgloss
table/table.go:37
FuncType
StyleFunc
StyleFunc is the style function that determines the style of an item. It takes the list items and index of the list and determines the lipgloss Style
list/list.go:81
FuncType
StyleFunc
StyleFunc allows the tree to be styled per item.
tree/renderer.go:10
Struct
Table
Table is a type for rendering tables.
table/table.go:45
Struct
Tree
Tree implements a Node.
tree/tree.go:96
FuncType
WhitespaceOption
WhitespaceOption sets a styling rule for rendering whitespace.
whitespace.go:62
Struct
WrapWriter
WrapWriter is a writer that writes to a buffer and keeps track of the current pen style and link state for the purpose of wrapping with newlines. Whe
wrap.go:26
Struct
borderBlend
borders.go:281
Struct
borderRotationTickMsg
examples/blending/border-blend-rotation/bubbletea/main.go:17
Struct
compositeLayer
compositeLayer holds a flattened layer with its calculated absolute position and bounds.
layer.go:196
Struct
dir
examples/tree/selection/main.go:42
Struct
dir
examples/tree/toggle/main.go:38
Struct
file
file implements the Node interface.
examples/tree/selection/main.go:58
Struct
file
examples/tree/toggle/main.go:53
Struct
gradientData
examples/blending/linear-1d/bubbletea/main.go:58
Struct
model
examples/compat/bubbletea/main.go:59
Struct
model
examples/blending/border-blend-rotation/bubbletea/main.go:27
Struct
model
examples/blending/linear-2d/bubbletea/main.go:76
Struct
model
examples/blending/linear-1d/bubbletea/main.go:94
Struct
model
examples/color/bubbletea/main.go:66
TypeAlias
propKey
Property for a key.
style.go:18
FuncType
queryTerminalFilter
queryTerminalFilter is a function that filters input events using a type switch. If false is returned, the QueryTerminal function will stop reading in
terminal.go:54
Struct
renderer
tree/renderer.go:39
Struct
resizer
resizer is a table resizer.
table/resizing.go:122
Struct
resizerColumn
resizerColumn is a column in the resizer.
table/resizing.go:111
Struct
styles
Style definitions.
examples/compat/bubbletea/main.go:21
Struct
styles
Style definitions.
examples/blending/linear-1d/bubbletea/main.go:64
Struct
styles
Available styles.
examples/ssh/main.go:21
Struct
styles
Style definitions.
examples/color/bubbletea/main.go:12
Struct
styles
examples/tree/selection/main.go:13
Struct
styles
examples/tree/toggle/main.go:8
Struct
test
join_test.go:6
Struct
whitespace
whitespace is a whitespace renderer.
whitespace.go:10