Tui Tree Widget

https://docs.rs/tui-tree-widget/latest/tui_tree_widget/
Admin
A widget built to display and interact with tree data structures, using `TreeItem`s to form the tree...
Tokens:71,826
Snippets:646
Trust Score:9.7
Update:2 weeks ago
Show doc for...
Tokens:
Raw
### Expected rendering for title_top example

Source: https://docs.rs/tui-tree-widget/latest/tui_tree_widget/struct.Block.html?search=

Expected rendering output for the title_top example above, showing how the titles are placed and spaced within the block.

```text
// Renders
// ┌Left1─Left2───Center─────────Right┐
// │                                  │
// └──────────────────────────────────┘
```

--------------------------------

### padding examples

Source: https://docs.rs/tui-tree-widget/latest/tui_tree_widget/struct.Block.html?search=u32+-%3E+bool

Two examples show padding: the first uses Padding::ZERO (default, no padding), the second uses Padding::horizontal(2) to add two spaces on each side. Both render a bordered block with 'content' inside.

```rust
use ratatui::widgets::{Block, Padding};

Block::bordered().padding(Padding::ZERO);
// Renders
// ┌───────┐
// │content│
// └───────┘
```

```rust
use ratatui::widgets::{Block, Padding};

Block::bordered().padding(Padding::horizontal(2));
// Renders
// ┌───────────┐
// │  content  │
// └───────────┘
```

--------------------------------

### Block Widget Methods

Source: https://docs.rs/tui-tree-widget/latest/tui_tree_widget/struct.Block.html

Code examples for the Block widget methods.

```APIDOC
## Block::new()

### Description
Creates a new block with no borders or padding.

### Method
Constructor

### Signature
`pub const fn new() -> Block<'a>`

### Parameters
None

### Returns
- **Block<'a>** - A new block instance with no borders or padding.

### Example
```rust
use ratatui::widgets::Block;
let block = Block::new();
```
```

```APIDOC
## Block::bordered()

### Description
Creates a new block with all borders shown.

### Method
Constructor

### Signature
`pub const fn bordered() -> Block<'a>`

### Parameters
None

### Returns
- **Block<'a>** - A new block with all borders shown.

### Example
```rust
use ratatui::widgets::{Block, Borders};
assert_eq!(Block::bordered(), Block::new().borders(Borders::ALL));
```
```

```APIDOC
## Block::title<T>(self, title: T) -> Block<'a>

### Description
Adds a title to the block using the default position (top). Can be called multiple times to add multiple titles. Accepts any type that can be converted into `Line` (e.g., strings, `&str`, `Cow<str>`, spans, `Vec<Span>`).

### Method
Builder method

### Signature
`pub fn title<T>(self, title: T) -> Block<'a> where T: Into<Line<'a>>`

### Parameters
- **title** (T) - Required - The title to add, convertible into `Line`.

### Returns
- **Block<'a>** - The block with the added title.

### Example
```rust
use ratatui::widgets::Block;
let block = Block::bordered().title("My Block");
```
```

```APIDOC
## Block::title_top<T>(self, title: T) -> Block<'a>

### Description
Adds a title to the top of the block. Accepts any type that can be converted into `Line` (e.g., strings, `&str`, `Cow<str>`, spans, `Vec<Span>`).

### Method
Builder method

### Signature
`pub fn title_top<T>(self, title: T) -> Block<'a> where T: Into<Line<'a>>`

### Parameters
- **title** (T) - Required - The title to add, convertible into `Line`.

### Returns
- **Block<'a>** - The block with the added top title.

### Example
```rust
use ratatui::{ widgets::Block, text::Line };
let block = Block::bordered()
    .title_top("Left1")
    .title_top(Line::from("Left2").left_aligned())
    .title_top(Line::from("Right").right_aligned())
    .title_top(Line::from("Center").centered());
```
```

--------------------------------

### TreeItem construction example

Source: https://docs.rs/tui-tree-widget/latest/tui_tree_widget/struct.TreeItem.html?search=std%3A%3Avec

Example usage of TreeItem constructors. Creates a leaf item and a root item with a child. The second line uses the ? operator, implying it returns a Result.

```rust
let a = TreeItem::new_leaf("l", "Leaf");
let b = TreeItem::new("r", "Root", vec![a])?;
```

--------------------------------

### style example: styling block, borders, titles, and inner widget

Source: https://docs.rs/tui-tree-widget/latest/tui_tree_widget/struct.Block.html

Shows how to apply a base style to a block, then override it for borders and titles. Also demonstrates styling an inner Paragraph widget, which is applied before the block style.

```rust
use ratatui::style::{Color, Style, Stylize};
use ratatui::widgets::{Block, Paragraph};

let block = Block::new().style(Style::new().red().on_black());

// For border and title you can additionally apply styles on top of the block level style.
let block = Block::new()
    .style(Style::new().red().bold().italic())
    .border_style(Style::new().not_italic()) // will be red and bold
    .title_style(Style::new().not_bold()) // will be red and italic
    .title("Title");

// To style the inner widget, you can style the widget itself.
let paragraph = Paragraph::new("Content")
    .block(block)
    .style(Style::new().white().not_bold()); // will be white, and italic
```

--------------------------------

### borders example: displaying left and right borders

Source: https://docs.rs/tui-tree-widget/latest/tui_tree_widget/struct.Block.html

Shows how to display only the left and right borders using the Borders bitflags. The comment notes that Block::bordered can be used to show all borders.

```rust
use ratatui::widgets::{Block, Borders};
Block::new().borders(Borders::LEFT | Borders::RIGHT);
```

--------------------------------

### Tree widget usage example

Source: https://docs.rs/tui-tree-widget/latest/tui_tree_widget/struct.Tree.html

Example usage of the Tree widget. It creates a default TreeState, a leaf TreeItem, and renders the tree inside a terminal draw closure with a bordered block titled "Tree Widget". The expect call asserts that all item identifiers are unique.

```rust
let mut state = TreeState::default();

let item = TreeItem::new_leaf("l", "leaf");
let items = vec![item];

terminal.draw(|frame| {
    let area = frame.area();

    let tree_widget = Tree::new(&items)
        .expect("all item identifiers are unique")
        .block(Block::bordered().title("Tree Widget"));

    frame.render_stateful_widget(tree_widget, area, &mut state);
})?;
```

--------------------------------

### Scrollbar usage example

Source: https://docs.rs/tui-tree-widget/latest/tui_tree_widget/struct.Scrollbar.html

Example usage of the Scrollbar widget with a Paragraph. It creates a vertical scrollbar on the right, sets begin and end symbols, and renders both the paragraph and the scrollbar as separate widgets. Note that ScrollbarState::content_length must be set before rendering, otherwise the scrollbar renders blank.

```rust
use ratatui::Frame;
use ratatui::layout::{Margin, Rect};
use ratatui::text::Line;
use ratatui::widgets::{
    Block, Borders, Paragraph, Scrollbar, ScrollbarOrientation, ScrollbarState, StatefulWidget,
};

let vertical_scroll = 0; // from app state

let items = vec![
    Line::from("Item 1"),
    Line::from("Item 2"),
    Line::from("Item 3"),
];
let paragraph = Paragraph::new(items.clone())
    .scroll((vertical_scroll as u16, 0))
    .block(Block::new().borders(Borders::RIGHT)); // to show a background for the scrollbar

let scrollbar = Scrollbar::new(ScrollbarOrientation::VerticalRight)
    .begin_symbol(Some("↑"))
    .end_symbol(Some("↓"));

let mut scrollbar_state = ScrollbarState::new(items.len()).position(vertical_scroll);

let area = frame.area();
// Note we render the paragraph
frame.render_widget(paragraph, area);
// and the scrollbar, those are separate widgets
frame.render_stateful_widget(
    scrollbar,
    area.inner(Margin {
        // using an inner vertical margin of 1 unit makes the scrollbar inside the block
        vertical: 1,
        horizontal: 0,
    }),
    &mut scrollbar_state,
);
```

--------------------------------

### border_style example: setting blue border style

Source: https://docs.rs/tui-tree-widget/latest/tui_tree_widget/struct.Block.html

Applies a blue style to the borders of a bordered block. The style is applied only to border areas and after any Block::style.

```rust
use ratatui::style::{Style, Stylize};
use ratatui::widgets::Block;
Block::bordered().border_style(Style::new().blue());
```

--------------------------------

### title_bottom example: adding bottom titles with alignment

Source: https://docs.rs/tui-tree-widget/latest/tui_tree_widget/struct.Block.html

Shows how to add multiple bottom titles with different alignments. The first title defaults to top-left alignment, while others use left, right, and center alignment. The rendered output is shown in a comment.

```rust
use ratatui::{ widgets::Block, text::Line };

Block::bordered()
    .title_bottom("Left1") // By default in the top left corner
    .title_bottom(Line::from("Left2").left_aligned())
    .title_bottom(Line::from("Right").right_aligned())
    .title_bottom(Line::from("Center").centered());

// Renders
// ┌──────────────────────────────────┐
// │                                  │
// └Left1─Left2───Center─────────Right┘
```

--------------------------------

### Rendered output with merged borders

Source: https://docs.rs/tui-tree-widget/latest/tui_tree_widget/struct.Block.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Rendering the blocks with MergeStrategy::Exact or MergeStrategy::Fuzzy collapses the borders, resulting in a clean layout without connected borders. This is the displayed output of the merge_borders example.

```text
┌───┐    ┌───┐  ┌───┲━━━┓┌───┐
│   │    │ 1 │  │   ┃   ┃│   │
│ 1 │    │ ┏━┿━┓│ 1 ┃ 2 ┃│ 1 │
│   │    │ ┃ │ ┃│   ┃   ┃│   │
└───╆━━━┓└─╂─┘ ┃└───┺━━━┛┢━━━┪
    ┃   ┃  ┃ 2 ┃         ┃   ┃
    ┃ 2 ┃  ┗━━━┛         ┃ 2 ┃
    ┃   ┃                ┃   ┃
    ┗━━━┛                ┗━━━┛
```

--------------------------------

### title_alignment example: setting default alignment for all titles

Source: https://docs.rs/tui-tree-widget/latest/tui_tree_widget/struct.Block.html

Sets the default alignment for all titles to center, but a title that explicitly sets Alignment::Right overrides it. The example shows a block with three titles: one right-aligned, and two centered.

```rust
use ratatui::layout::Alignment;
use ratatui::text::Line;
use ratatui::widgets::Block;

Block::bordered()
    .title_alignment(Alignment::Center)
    // This title won't be aligned in the center
    .title(Line::from("right").right_aligned())
    .title("foo")
    .title("bar");
```

--------------------------------

### Block Struct Methods

Source: https://docs.rs/tui-tree-widget/latest/tui_tree_widget/struct.Block.html

Documentation for the Block struct constructor, border configuration, title configuration, and styling methods.

```APIDOC
## Block::new

### Description
Creates a block with no borders or padding.

### Method
Constructor

### Signature
`Block::new()`

### Parameters
None

### Returns
A new `Block` instance with no borders or padding.
```

```APIDOC
## Block::bordered

### Description
Creates a block with all borders enabled.

### Method
Constructor

### Signature
`Block::bordered()`

### Parameters
None

### Returns
A new `Block` instance with all borders enabled.
```

```APIDOC
## Block::borders

### Description
Specifies which borders to display on the block.

### Method
Setter

### Signature
`Block::borders(borders: Borders)`

### Parameters
- **borders** (Borders) - Required - The borders to display.
```

```APIDOC
## Block::border_style

### Description
Sets the style of the borders.

### Method
Setter

### Signature
`Block::border_style(style: Style)`

### Parameters
- **style** (Style) - Required - The style to apply to the borders.
```

```APIDOC
## Block::border_type

### Description
Sets border symbols (single, double, thick, rounded, etc.).

### Method
Setter

### Signature
`Block::border_type(border_type: BorderType)`

### Parameters
- **border_type** (BorderType) - Required - The type of border symbols to use.
```

```APIDOC
## Block::border_set

### Description
Sets custom border symbols as a `border::Set`.

### Method
Setter

### Signature
`Block::border_set(border_set: border::Set)`

### Parameters
- **border_set** (border::Set) - Required - The custom border symbols to use.
```

```APIDOC
## Block::merge_borders

### Description
Controls how borders merge with adjacent blocks.

### Method
Setter

### Signature
`Block::merge_borders(merge: bool)`

### Parameters
- **merge** (bool) - Required - Whether to merge borders with adjacent blocks.
```

```APIDOC
## Block::title

### Description
Adds a title to the block. By default, the title is placed at the top.

### Method
Setter

### Signature
`Block::title<T: Into<Line>>(title: T)`

### Parameters
- **title** (Into<Line>) - Required - The title content, can be a string, `String`, or vector of `Span`s.
```

```APIDOC
## Block::title_top

### Description
Adds a title to the top of the block.

### Method
Setter

### Signature
`Block::title_top<T: Into<Line>>(title: T)`

### Parameters
- **title** (Into<Line>) - Required - The title content, can be a string, `String`, or vector of `Span`s.
```

```APIDOC
## Block::title_bottom

### Description
Adds a title to the bottom of the block.

### Method
Setter

### Signature
`Block::title_bottom<T: Into<Line>>(title: T)`

### Parameters
- **title** (Into<Line>) - Required - The title content, can be a string, `String`, or vector of `Span`s.
```

```APIDOC
## Block::title_alignment

### Description
Sets default alignment for all titles.

### Method
Setter

### Signature
`Block::title_alignment(alignment: Alignment)`

### Parameters
- **alignment** (Alignment) - Required - The default alignment for titles (left, center, right).
```

```APIDOC
## Block::title_style

### Description
Sets the style for all titles.

### Method
Setter

### Signature
`Block::title_style(style: Style)`

### Parameters
- **style** (Style) - Required - The style to apply to all titles.
```

```APIDOC
## Block::title_position

### Description
Sets default position for titles.

### Method
Setter

### Signature
`Block::title_position(position: Position)`

### Parameters
- **position** (Position) - Required - The default position for titles (top or bottom).
```

```APIDOC
## Block::style

### Description
Sets the base style of the block.

### Method
Setter

### Signature
`Block::style(style: Style)`

### Parameters
- **style** (Style) - Required - The base style to apply to the block.
```

```APIDOC
## Block::padding

### Description
Adds internal padding within the borders.

### Method
Setter

### Signature
`Block::padding(padding: Padding)`

### Parameters
- **padding** (Padding) - Required - The padding to apply inside the borders.
```

```APIDOC
## Block::inner

### Description
Calculates the inner area available for content.

### Method
Getter

### Signature
`Block::inner(area: Rect) -> Rect`

### Parameters
- **area** (Rect) - Required - The outer area of the block.

### Returns
The inner `Rect` available for content after accounting for borders and padding.
```

--------------------------------

### title_position example: setting default title position to bottom

Source: https://docs.rs/tui-tree-widget/latest/tui_tree_widget/struct.Block.html

Sets the default title position to bottom for all titles. A title explicitly set to Top overrides it. The example shows a block with two bottom titles and one top title.

```rust
use ratatui::widgets::{Block, TitlePosition};

Block::bordered()
    .title_position(TitlePosition::Bottom)
    .title("foo") // will be at the bottom
    .title_top("top") // will be at the top
    .title("bar"); // will be at the bottom
```

--------------------------------

### impl<T> Any for T

Source: https://docs.rs/tui-tree-widget/latest/tui_tree_widget/struct.ScrollbarState.html?search=

Provides the type_id method to get the TypeId of a value.

```APIDOC
## impl<T> Any for T

### Description
Provides the `type_id` method to get the `TypeId` of a value.

### Method
`fn type_id(&self) -> TypeId`

### Parameters
- `self` (&T) - Required - The value whose type ID is requested.

### Returns
- `TypeId` - The unique identifier of the type of `self`.

```

--------------------------------

### Block::new

Source: https://docs.rs/tui-tree-widget/latest/tui_tree_widget/struct.Block.html

Constructor method for creating a new Block widget.

```APIDOC
## [Constructor] Block::new

### Description
Creates a new `Block` with no borders, titles, or padding. This is the default constructor for the `Block` widget.

### Method
Constructor

### Signature
```rust
pub fn new() -> Block<'a>
```

### Parameters
None

### Returns
- **Block<'a>** - A new `Block` instance with default settings.

### Example
```rust
let block = Block::new();
```

```

--------------------------------

### impl<Q, K> Equivalent<K> for Q

Source: https://docs.rs/tui-tree-widget/latest/tui_tree_widget/struct.ScrollbarState.html?search=

Provides the equivalent method to compare self to a key and return true if they are equal.

```APIDOC
## impl<Q, K> Equivalent<K> for Q

### Description
Provides the `equivalent` method to compare `self` to a key and return `true` if they are equal.

### Method
`fn equivalent(&self, key: &K) -> bool`

### Parameters
- `self` (&Q) - Required - The value to compare.
- `key` (&K) - Required - The key to compare against.

### Returns
- `bool` - `true` if `self` is equivalent to `key`, otherwise `false`.

```

--------------------------------

### ScrollbarState::first

Source: https://docs.rs/tui-tree-widget/latest/tui_tree_widget/struct.ScrollbarState.html?search=u32+-%3E+bool

Sets the scroll position to the start of the scrollable content.

```APIDOC
## ScrollbarState::first

### Description
Sets the scroll position to the start of the scrollable content.

### Method
`pub const fn first(&mut self)`

### Parameters
- `self` (&mut ScrollbarState) - Required - The mutable reference to the state.

### Returns
- `()` - No return value.

```

--------------------------------

### Tree::new

Source: https://docs.rs/tui-tree-widget/latest/tui_tree_widget/struct.Tree.html?search=

Constructor for creating a new Tree widget.

```APIDOC
## Tree::new

### Description
Creates a new `Tree` widget from a slice of `TreeItem`s. Returns an error if there are duplicate identifiers in the children.

### Method
Constructor

### Signature
```rust
pub fn new(items: &'a [TreeItem<'a, Identifier>]) -> Result<Self>
```

### Parameters
- **items** (`&'a [TreeItem<'a, Identifier>]`) - Required - The tree items to display.

### Errors
Returns an error when there are duplicate identifiers in the children.

### Example
```rust
let item = TreeItem::new_leaf("l", "leaf");
let items = vec![item];
let tree_widget = Tree::new(&items).expect("all item identifiers are unique");
```
```

--------------------------------

### Border Configuration Methods

Source: https://docs.rs/tui-tree-widget/latest/tui_tree_widget/struct.Block.html?search=

Methods for configuring the borders of a Block.

```APIDOC
## [Method] Block::border_set

### Description
Sets the border set for the block. The border set defines which characters are used for the borders.

### Method
Method

### Signature
```rust
pub fn border_set(mut self, border_set: symbols::border::Set) -> Block<'a>
```

### Parameters
- **border_set** (symbols::border::Set) - Required - The border set to use.
```

```APIDOC
## [Method] Block::border_style

### Description
Sets the style of the borders. This style is applied to the border characters.

### Method
Method

### Signature
```rust
pub fn border_style(mut self, style: impl Into<Style>) -> Block<'a>
```

### Parameters
- **style** (impl Into<Style>) - Required - The style to apply to the borders.
```

```APIDOC
## [Method] Block::border_type

### Description
Sets the border type. The border type determines the style of the border (e.g., plain, rounded, double).

### Method
Method

### Signature
```rust
pub fn border_type(mut self, border_type: BorderType) -> Block<'a>
```

### Parameters
- **border_type** (BorderType) - Required - The border type to use.
```

```APIDOC
## [Method] Block::borders

### Description
Sets which borders are shown. This method takes a bitflags value that specifies which sides have borders.

### Method
Method

### Signature
```rust
pub fn borders(mut self, borders: Borders) -> Block<'a>
```

### Parameters
- **borders** (Borders) - Required - The borders to show.
```

--------------------------------

### Styling and Layout Methods

Source: https://docs.rs/tui-tree-widget/latest/tui_tree_widget/struct.Block.html?search=

Methods for styling and layout of a Block.

```APIDOC
## [Method] Block::style

### Description
Sets the style of the block. This style is applied to the entire block area.

### Method
Method

### Signature
```rust
pub fn style(mut self, style: impl Into<Style>) -> Block<'a>
```

### Parameters
- **style** (impl Into<Style>) - Required - The style to apply.
```

```APIDOC
## [Method] Block::padding

### Description
Sets the padding of the block. Padding is the space between the borders and the inner content.

### Method
Method

### Signature
```rust
pub fn padding(mut self, padding: Padding) -> Block<'a>
```

### Parameters
- **padding** (Padding) - Required - The padding to apply.
```

--------------------------------

### Move selection down with select_relative

Source: https://docs.rs/tui-tree-widget/latest/tui_tree_widget/struct.TreeState.html?search=std%3A%3Avec

Example of moving the selection one down using the select_relative method. The closure handles the case when nothing is selected by returning 0.

```rust
// Move the selection one down
state.select_relative(|current| {
    // When nothing is currently selected, select index 0
    // Otherwise select current + 1 (without panicking)
    current.map_or(0, |current| current.saturating_add(1))
});
```

--------------------------------

### key_up

Source: https://docs.rs/tui-tree-widget/latest/tui_tree_widget/struct.TreeState.html?search=std%3A%3Avec

Handles the up arrow key navigation.

```APIDOC
## key_up

### Description
Handles the up arrow key. Moves up in the current depth or to its parent. Returns `true` when the selection changed.

### Method
`pub fn key_up(&mut self) -> bool`

### Returns
- `bool` - `true` if the selection changed.
```

--------------------------------

### Move selection down with select_visible_relative

Source: https://docs.rs/tui-tree-widget/latest/tui_tree_widget/struct.TreeState.html?search=std%3A%3Avec

Example of moving the selection one down using the deprecated select_visible_relative method. The closure handles the case when nothing is selected by returning 0.

```rust
// Move the selection one down
state.select_visible_relative(|current| {
    // When nothing is currently selected, select index 0
    // Otherwise select current + 1 (without panicking)
    current.map_or(0, |current| current.saturating_add(1))
});
```

--------------------------------

### Default title alignment and multiple titles

Source: https://docs.rs/tui-tree-widget/latest/tui_tree_widget/struct.Block.html

Demonstrates default title alignment, multiple titles, and centered title behavior based on full block width.

```rust
use ratatui::text::Line;
use ratatui::widgets::Block;

Block::bordered()
    .title("Title")
    .title(Line::from("Left").left_aligned())
    .title(Line::from("Right").right_aligned())
    .title(Line::from("Center").centered());
```

--------------------------------

### Set padding to Padding::ZERO

Source: https://docs.rs/tui-tree-widget/latest/tui_tree_widget/struct.Block.html

Defines the padding inside a Block. The first example uses Padding::ZERO, which is the default, and shows no extra space around the content.

```rust
use ratatui::widgets::{Block, Padding};

Block::bordered().padding(Padding::ZERO);
// Renders
// ┌───────┐
// │content│
// └───────┘
```

--------------------------------

### Block Widget Methods

Source: https://docs.rs/tui-tree-widget/latest/tui_tree_widget/struct.Block.html?search=u32+-%3E+bool

Documentation for the Block widget methods: new, bordered, title, and title_top.

```APIDOC
## Block::new()

### Description
Creates a new block with no borders or padding.

### Method
Constructor

### Signature
`pub const fn new() -> Block<'a>`

### Returns
- **Block<'a>** - A new block instance with no borders or padding.
```

```APIDOC
## Block::bordered()

### Description
Creates a new block with all borders shown.

### Method
Constructor

### Signature
`pub const fn bordered() -> Block<'a>`

### Returns
- **Block<'a>** - A new block with all borders enabled.

### Example
```rust
use ratatui::widgets::{Block, Borders};

assert_eq!(Block::bordered(), Block::new().borders(Borders::ALL));
```
```

```APIDOC
## Block::title<T>(self, title: T) -> Block<'a>

### Description
Adds a title to the block using the default position (top). Can be called multiple times to add multiple titles. Accepts any type that can be converted into `Line`.

### Method
Builder method

### Signature
`pub fn title<T>(self, title: T) -> Block<'a> where T: Into<Line<'a>>`

### Parameters
- **title** (T) - Required - The title to add, convertible into `Line` (e.g., `&str`, `String`, `Cow<str>`, `Span`, `Vec<Span>`).

### Returns
- **Block<'a>** - The block with the added title.

### Example
```rust
use ratatui::text::Line;
use ratatui::widgets::Block;

Block::bordered()
    .title("Title")
    .title(Line::from("Left").left_aligned())
    .title(Line::from("Right").right_aligned())
    .title(Line::from("Center").centered());
```
```

```APIDOC
## Block::title_top<T>(self, title: T) -> Block<'a>

### Description
Adds a title to the top of the block. Accepts any type that can be converted into `Line`.

### Method
Builder method

### Signature
`pub fn title_top<T>(self, title: T) -> Block<'a> where T: Into<Line<'a>>`

### Parameters
- **title** (T) - Required - The title to add, convertible into `Line` (e.g., `&str`, `String`, `Cow<str>`, `Span`, `Vec<Span>`).

### Returns
- **Block<'a>** - The block with the added top title.

### Example
```rust
use ratatui::{ widgets::Block, text::Line };

Block::bordered()
    .title_top("Left1") // By default in the top left corner
    .title_top(Line::from("Left2").left_aligned())
    .title_top(Line::from("Right").right_aligned())
    .title_top(Line::from("Center").centered());
```
```

--------------------------------

### Set border_type to BorderType::Rounded

Source: https://docs.rs/tui-tree-widget/latest/tui_tree_widget/struct.Block.html

Sets the border symbols to a predefined style (e.g., rounded). Overwrites any custom border_set that was set. The example shows the rendered output with rounded borders.

```rust
use ratatui::widgets::{Block, BorderType};
Block::bordered()
    .border_type(BorderType::Rounded)
    .title("Block");
// Renders
// ╭Block╮
// │     │
// ╰─────╯
```

--------------------------------

### key_right

Source: https://docs.rs/tui-tree-widget/latest/tui_tree_widget/struct.TreeState.html?search=std%3A%3Avec

Handles the right arrow key navigation.

```APIDOC
## key_right

### Description
Handles the right arrow key. Opens the currently selected. Returns `true` when it was closed and has been opened. Returns `false` when it was already open or nothing being selected.

### Method
`pub fn key_right(&mut self) -> bool`

### Returns
- `bool` - `true` if the node was opened, `false` otherwise.
```

--------------------------------

### Block::bordered

Source: https://docs.rs/tui-tree-widget/latest/tui_tree_widget/struct.Block.html?search=

Creates a new block with all borders shown.

```APIDOC
## Block::bordered

### Description
Create a new block with all borders shown.

### Method
`pub fn bordered() -> Block<'a>`

### Parameters
None.

### Returns
A new `Block` instance with all borders enabled.

### Example
```rust
use ratatui::widgets::{Block, Borders};
assert_eq!(Block::bordered(), Block::new().borders(Borders::ALL));
```
```

--------------------------------

### Create default TreeState

Source: https://docs.rs/tui-tree-widget/latest/tui_tree_widget/struct.TreeState.html?search=Option%3CT%3E%2C+%28T+-%3E+U%29+-%3E+Option%3CU%3E

Shows how to create a default TreeState with a usize identifier type.

```rust
type Identifier = usize;

let mut state = TreeState::<Identifier>::default();
```

--------------------------------

### Compute inner area with Block::inner

Source: https://docs.rs/tui-tree-widget/latest/tui_tree_widget/struct.Block.html

Computes the inner area of a block after subtracting space for borders, titles, and padding. The example draws a block nested within another block using the computed inner area.

```rust
use ratatui::Frame;
use ratatui::widgets::Block;

let outer_block = Block::bordered().title("Outer");
let inner_block = Block::bordered().title("Inner");

let outer_area = frame.area();
let inner_area = outer_block.inner(outer_area);

frame.render_widget(outer_block, outer_area);
frame.render_widget(inner_block, inner_area);
// Renders
// ┌Outer────────┐
// │┌Inner──────┐│
// ││           ││
// │└───────────┘│
// └─────────────┘
```

--------------------------------

### Set border_set to symbols::border::DOUBLE

Source: https://docs.rs/tui-tree-widget/latest/tui_tree_widget/struct.Block.html

Sets the border symbols using a custom Set from ratatui_core::symbols::border. Overwrites any border_type that was set. The example uses the DOUBLE border set and shows the rendered output.

```rust
use ratatui::{widgets::Block, symbols};

Block::bordered().border_set(symbols::border::DOUBLE).title("Block");
// Renders
// ╔Block╗
// ║     ║
// ╚═════╝
```

--------------------------------

### Block::new

Source: https://docs.rs/tui-tree-widget/latest/tui_tree_widget/struct.Block.html?search=

Creates a new block with no borders or padding.

```APIDOC
## Block::new

### Description
Creates a new block with no `Borders` or `Padding`.

### Method
`pub const fn new() -> Block<'a>`

### Parameters
None.

### Returns
A new `Block` instance with no borders or padding.

### Example
```rust
use ratatui::widgets::Block;
let block = Block::new();
```
```

--------------------------------

### key_left

Source: https://docs.rs/tui-tree-widget/latest/tui_tree_widget/struct.TreeState.html?search=std%3A%3Avec

Handles the left arrow key navigation.

```APIDOC
## key_left

### Description
Handles the left arrow key. Closes the currently selected or moves to its parent. Returns `true` when the selection or the open state changed.

### Method
`pub fn key_left(&mut self) -> bool`

### Returns
- `bool` - `true` if the selection or open state changed.
```

--------------------------------

### Set merge_borders to MergeStrategy::Exact

Source: https://docs.rs/tui-tree-widget/latest/tui_tree_widget/struct.Block.html

Sets the block's MergeStrategy for overlapping characters, defaulting to Replace. Changing to Exact or Fuzzy collapses border characters that intersect with previously rendered borders. The example shows plain and thick borders with MergeStrategy::Exact and the resulting collapsed layout.

```rust
use ratatui::symbols::merge::MergeStrategy;

// Given several blocks with plain borders (1)
Block::bordered();
// and other blocks with thick borders (2) which are rendered on top of the first
Block::bordered()
    .border_type(BorderType::Thick)
    .merge_borders(MergeStrategy::Exact);
```

```text
┌───┐    ┌───┐  ┌───┲━━━┓┌───┐
│   │    │ 1 │  │   ┃   ┃│   │
│ 1 │    │ ┏━┿━┓│ 1 ┃ 2 ┃│ 1 │
│   │    │ ┃ │ ┃│   ┃   ┃│   │
└───╆━━━┓└─╂─┘ ┃└───┺━━━┛┢━━━┪
    ┃   ┃  ┃ 2 ┃         ┃   ┃
    ┃ 2 ┃  ┗━━━┛         ┃ 2 ┃
    ┃   ┃                ┃   ┃
    ┗━━━┛                ┗━━━┛
```

--------------------------------

### Block Constructors

Source: https://docs.rs/tui-tree-widget/latest/tui_tree_widget/struct.Block.html?search=

Constructor methods for creating a Block widget.

```APIDOC
## [Constructor] Block::new

### Description
Creates a new `Block` with no borders, titles, or padding. This is the default constructor for the `Block` widget.

### Method
Constructor

### Signature
```rust
pub fn new() -> Block<'a>
```

### Parameters
None

### Returns
- **Block<'a>** - A new `Block` instance with default settings.
```

```APIDOC
## [Constructor] Block::bordered

### Description
Creates a new `Block` with all borders enabled. This is a convenience constructor that sets the border set to all sides.

### Method
Constructor

### Signature
```rust
pub fn bordered() -> Block<'a>
```

### Parameters
None

### Returns
- **Block<'a>** - A new `Block` instance with borders on all sides.
```

--------------------------------

### Title Configuration Methods

Source: https://docs.rs/tui-tree-widget/latest/tui_tree_widget/struct.Block.html?search=

Methods for configuring the title of a Block.

```APIDOC
## [Method] Block::title

### Description
Sets the title of the block. The title is displayed in the top border by default.

### Method
Method

### Signature
```rust
pub fn title<T>(mut self, title: T) -> Block<'a>
where
    T: Into<Line<'a>>,
```

### Parameters
- **title** (T) - Required - The title to display.
```

```APIDOC
## [Method] Block::title_alignment

### Description
Sets the alignment of the title within the border.

### Method
Method

### Signature
```rust
pub fn title_alignment(mut self, alignment: Alignment) -> Block<'a>
```

### Parameters
- **alignment** (Alignment) - Required - The alignment of the title.
```

```APIDOC
## [Method] Block::title_bottom

### Description
Sets the title to be displayed at the bottom of the block.

### Method
Method

### Signature
```rust
pub fn title_bottom(mut self, title: Line<'a>) -> Block<'a>
```

### Parameters
- **title** (Line<'a>) - Required - The title to display at the bottom.
```

```APIDOC
## [Method] Block::title_position

### Description
Sets the position of the title (top or bottom).

### Method
Method

### Signature
```rust
pub fn title_position(mut self, position: Position) -> Block<'a>
```

### Parameters
- **position** (Position) - Required - The position of the title.
```

```APIDOC
## [Method] Block::title_style

### Description
Sets the style of the title.

### Method
Method

### Signature
```rust
pub fn title_style(mut self, style: impl Into<Style>) -> Block<'a>
```

### Parameters
- **style** (impl Into<Style>) - Required - The style to apply to the title.
```

```APIDOC
## [Method] Block::title_top

### Description
Sets the title to be displayed at the top of the block.

### Method
Method

### Signature
```rust
pub fn title_top(mut self, title: Line<'a>) -> Block<'a>
```

### Parameters
- **title** (Line<'a>) - Required - The title to display at the top.
```

--------------------------------

### Create a simple bordered block

Source: https://docs.rs/tui-tree-widget/latest/tui_tree_widget/struct.Block.html

Creates a simple bordered block with a title using the default title position (top).

```rust
use ratatui::widgets::Block;

let block = Block::bordered().title("My Block");
```

--------------------------------

### impl Widget for Block<'_>

Source: https://docs.rs/tui-tree-widget/latest/tui_tree_widget/struct.Block.html?search=std%3A%3Avec

Implements the Widget trait for Block, allowing it to be rendered to a buffer.

```APIDOC
## impl Widget for Block<'_>

### Description
Implements the Widget trait for Block, allowing it to be rendered to a buffer.

### Methods
- **render** - Draws the current state of the widget in the given buffer.

```

--------------------------------

### impl<T> CloneToUninit for T

Source: https://docs.rs/tui-tree-widget/latest/tui_tree_widget/struct.ScrollbarState.html?search=

Provides the unsafe clone_to_uninit method to perform copy-assignment from self to an uninitialized destination.

```APIDOC
## impl<T> CloneToUninit for T

### Description
Provides the unsafe `clone_to_uninit` method to perform copy-assignment from `self` to an uninitialized destination. This is a nightly-only experimental API.

### Method
`unsafe fn clone_to_uninit(&self, dest: *mut u8)`

### Parameters
- `self` (&T) - Required - The value to clone.
- `dest` (*mut u8) - Required - The destination pointer where the clone will be written.

### Safety
This method is unsafe because it writes to an uninitialized memory location.

```

--------------------------------

### Block::render (Widget for Block)

Source: https://docs.rs/tui-tree-widget/latest/tui_tree_widget/struct.Block.html

Draws the current state of the widget in the given buffer.

```APIDOC
## render

### Description
Draws the current state of the widget in the given buffer. That is the only method required to implement a custom widget.

### Method
render

### Signature
fn render(self, area: Rect, buf: &mut Buffer)

### Parameters
- **self** (Self) - The widget to render.
- **area** (Rect) - The area to render into.
- **buf** (&mut Buffer) - The buffer to draw into.

```

--------------------------------

### Flattened

Source: https://docs.rs/tui-tree-widget/latest/tui_tree_widget/struct.Flattened.html?search=u32+-%3E+bool

Documentation for the Flattened struct and its depth method.

```APIDOC
## Struct Flattened

### Description
A flattened item of all visible `TreeItem`s, generated via `TreeState::flatten`.

### Fields
- `identifier: Vec<Identifier>` - The identifier path of the item.
- `item: &'text TreeItem<'text, Identifier>` - The reference to the tree item.

### Methods
#### `depth`

##### Description
Returns the zero-based depth of the flattened item. Depth 0 means top level with 0 indentation.

##### Signature
`pub fn depth(&self) -> usize`

##### Parameters
- `self` - The flattened item.

##### Returns
- `usize` - The zero-based depth of the item.
```
Tokens:
Raw