ratkit 0.2.15

A comprehensive collection of reusable TUI components for ratatui including resizable splits, tree views, markdown rendering, toast notifications, dialogs, and terminal embedding
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29

//! Complete normalized rendered document.

use super::{DocumentLine, DocumentOutlineItem};

/// A rendered document ready for viewport rendering.
#[derive(Debug, Clone, Default, PartialEq, Eq)]
pub struct RenderedDocument {
    /// Renderable lines.
    pub lines: Vec<DocumentLine>,
    /// Optional outline entries.
    pub outline: Vec<DocumentOutlineItem>,
}

impl RenderedDocument {
    /// Creates a rendered document from lines and outline entries.
    pub fn new(lines: Vec<DocumentLine>, outline: Vec<DocumentOutlineItem>) -> Self {
        Self { lines, outline }
    }

    /// Returns the number of renderable lines.
    pub fn line_count(&self) -> usize {
        self.lines.len()
    }

    /// Returns true when the document has no lines.
    pub fn is_empty(&self) -> bool {
        self.lines.is_empty()
    }
}