New returns a new Table that can be modified through different attributes. By default, a table has normal border, no styling, and no rows.

String returns the table as a string.

Set a value on the underlying rules map.

Headers sets the table headers.

StyleFunc sets the style for a cell based on it's position (row, column).

unset unsets a property from a style.

Foreground sets a foreground color. // Sets the foreground to blue s := lipgloss.NewStyle().Foreground(lipgloss.Color("#0000ff")) // Removes the

Rows returns the number of rows in the table.

Child adds a child to this Tree. If a Child Tree is passed without a root, it will be parented to its sibling child (auto-nesting). tree.Root("Foo"

Render applies the defined style formatting to a given string.

Border sets the table border.

New returns a new tree.

String returns the string representation of a Leaf node. For leaf nodes, this is the same as Value.

Padding is a shorthand method for setting padding on all sides at once. With one argument, the value is applied to all sides. With two arguments, th

Bold sets a bold formatting rule.

NewStyle returns a new, empty Style. While it's syntactic sugar for the [Style]{} primitive, it's recommended to use this function for creating styles

Background sets a background color.

Width sets the width of the block before applying margins. This means your styled content will exactly equal the size set here. Text will wrap based o

Width sets the table width, this auto-sizes the columns to fit the width by either expanding or contracting the widths of each column as a best effort

Border is shorthand for setting the border style and which sides should have a border at once. The variadic argument sides works as follows: With one

String implements stringer for a Style, returning the rendered result based on the rules in this style. An underlying string value must be set with St

Root returns a new tree with the root set. tree.Root(root) It is a shorthand for: tree.New().Root(root)

Row appends a row to the table data.

New returns a new list with the given items. alphabet := list.New( "A", "B", "C", "D", "E", "F", ... ) Items can be other lists, tre

Enumerator sets the list enumerator. There are several predefined enumerators: • Alphabet • Arabic • Bullet • Dash • Roman Or, define your own. fu

Align is a shorthand method for setting horizontal and vertical alignment. With one argument, the position value is applied to the horizontal alignme

Root sets the root value of this tree.

Color specifies a color by hex or ANSI256 value. For example: ansiColor := lipgloss.Color("1") // The same as lipgloss.Red ansi256Color := lipgloss

Margin is a shorthand method for setting margins on all sides at once. With one argument, the value is applied to all sides. With two arguments, the

Height sets the table height.

Item appends an item to the list. l := list.New(). Item("Foo"). Item("Bar"). Item("Baz")

Length returns the number of children in the tree.

Returns whether or not the given property is set.

EnumeratorStyle sets the enumerator style for all enumerators. To set the enumerator style conditionally based on the item value or index, use [Enume

PaddingRight adds padding on the right.

At returns the contents of the cell at the given index.

At returns the content item of the given index.

Height sets the height of the block before applying margins. If the height of the text block is less than this value after applying padding (or not),

Italic sets an italic formatting rule. In some terminal emulators this will render with "reverse" coloring if not italic font variant is available.

Underline sets an underline rule. By default, underlines will not be drawn on whitespace like margins and padding. To change this behavior set [Style.

BorderRow sets the row border separator.

Enumerator sets the enumerator implementation. This can be used to change the way the branches indicators look. Lipgloss includes predefined enumerat

MarginBottom sets the value of the bottom margin.

MarginRight sets the value of the right margin.

SetString sets the underlying string value for this style. To render once the underlying string is set, use the [Style.String]. This method is a conve

Strikethrough sets a strikethrough rule. By default, strikes will not be drawn on whitespace like margins and padding. To change this behavior set Str

BorderForeground is a shorthand function for setting all of the foreground colors of the borders at once. The arguments work as follows: With one arg

Faint sets a rule for rendering the foreground color in a dimmer shade.

RGBA returns the RGBA value of this color. Because we have to return something, despite this color being the absence of color, we're returning black w

Wrap dictates whether or not the table content should wrap. This only applies to data cells. Headers are never wrapped.

BorderColumn sets the column border separator.

IndenterStyle sets the enumerator style for all enumerators. To set the enumerator style conditionally based on the item value or index, use [Indente

Render returns the table as a string.

Split a string into lines, additionally returning the size of the widest line.

ItemStyle sets the item style for all items. To set the item style conditionally based on the item value or index, use [ItemStyleFunc].

Width returns the cell width of characters in the string. ANSI sequences are ignored and characters wider than one cell (such as Chinese characters an

hex converts a color to a hex string or panics if invalid.

Blink sets a rule for blinking foreground text.

BorderBottom sets the bottom border.

BorderLeft sets the left border.

BorderRight sets the right border.

BorderTop sets the top border.

GetBackground returns the style's background color. If no value is set NoColor{} is returned.

Inherit overlays the style in the argument onto this style by copying each explicitly set value from the argument style onto this style if it is not a

ItemStyle sets a static style for all items. Use ItemStyleFunc to conditionally set styles based on the tree node.

MarginLeft sets the value of the left margin.

MaxWidth applies a max width to a given style. This is useful in enforcing a certain width at render time, particularly with arbitrary strings and sty

btoi converts a boolean to an integer, 1 if true, 0 if false.

isBorderStyleSetWithoutSides returns true if the border style is set but no sides are set. This is used to determine if the border should be rendered

newWhitespace creates a new whitespace renderer.

Render whitespaces.

xPaddingForCol returns the horizontal padding for a column.

AddLayers adds child layers to the Layer.

Blend1D blends a series of colors together in one linear dimension using multiple stops, into the provided number of steps. Uses the "CIE L*, a*, b*"

BorderForegroundBlend sets the foreground colors for the border blend. At least 2 colors are required to use blending, otherwise this will no-op with

BorderStyle defines the Border on a style. A Border contains a series of definitions for the sides and corners of a border. Note that if border visib

Columns returns the number of columns in the table.

EnumeratorStyleFunc sets the enumerator style function for the list items. Use this to conditionally set different styles based on the current items,

GetBold returns the style's bold value. If no value is set false is returned.

GetHorizontalFrameSize returns the sum of the style's horizontal margins, padding and border widths. Provisional: this method may be renamed.

GetHorizontalMargins returns the style's left and right margins. Unset values are measured as 0.

GetVerticalFrameSize returns the sum of the style's vertical margins, padding and border widths. Provisional: this method may be renamed.

Height returns height of a string in cells. This is done simply by counting \n characters. If your output has \r\n, that sequence will be replaced wit

Hide sets whether to hide the Tree node. Use this when creating a new hidden Tree.

Indenter sets the indenter implementation. This is used to change the way the tree is indented. The default indentor places a border connecting siblin

Inline makes rendering output one line and disables the rendering of margins, padding and borders. This is useful when you need a style to apply only

ItemStyleFunc sets the item style function for the list items. Use this to conditionally set different styles based on the current items, sibling ite

NewStringData creates a new StringData with the given number of columns.

PaddingLeft adds padding on the left.