Struct TreeStyle

pub struct TreeStyle {
    pub enumerator_func: StyleFunc,
    pub item_func: StyleFunc,
    pub enumerator_base: Option<Style>,
    pub item_base: Option<Style>,
    pub root: Style,
}

Styling configuration for tree rendering.

TreeStyle controls how different parts of the tree are styled, including enumerators (branch characters like ├──), items (node content), and the root. It supports both base styles (applied unconditionally) and function styles (applied per-child based on index and context).

Examples

use lipgloss::Style;
use lipgloss_tree::renderer::TreeStyle;

let style = TreeStyle {
    enumerator_func: |_, _| Style::new().foreground("blue"),
    item_func: |_, _| Style::new().bold(true),
    enumerator_base: Some(Style::new().padding_right(1)),
    item_base: None,
    root: Style::new().bold(true),
};

Fields

enumerator_func: StyleFunc

Function style applied to enumerators (branch characters) based on child index

item_func: StyleFunc

Function style applied to item content based on child index

enumerator_base: Option<Style>

Base style applied unconditionally to all enumerators before function styles

item_base: Option<Style>

Base style applied unconditionally to all items before function styles

root: Style

Style applied to the root node

Trait Implementations

impl Clone for TreeStyle

fn clone(&self) -> TreeStyle

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for TreeStyle

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for TreeStyle

fn default() -> Self

Creates a default TreeStyle with Go lipgloss-compatible behavior.

The default includes padding_right(1) on enumerators to match Go’s behavior of printing a space after tree branch prefixes. Tests that need different behavior can override with no-op functions.