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
30
31
32
33
34
35
36
37
38
39
40
41

//! Display settings shared by document viewers.

/// Presentation toggles for read-only documents.
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct DisplaySettings {
    /// Whether to show a line-number gutter.
    pub show_line_numbers: bool,
    /// Whether line numbers should be relative to the current line.
    pub relative_line_numbers: bool,
    /// Whether to highlight the current line.
    pub highlight_current_line: bool,
    /// Whether to show an outline pane when entries exist.
    pub show_outline: bool,
    /// Number of spaces used when expanding tabs.
    pub tab_width: usize,
}

impl Default for DisplaySettings {
    /// Creates default display settings.
    fn default() -> Self {
        Self {
            show_line_numbers: true,
            relative_line_numbers: false,
            highlight_current_line: false,
            show_outline: false,
            tab_width: 4,
        }
    }
}

impl DisplaySettings {
    /// Sets absolute or hidden line-number rendering.
    pub fn set_show_line_numbers(&mut self, show: bool) {
        self.show_line_numbers = show;
    }

    /// Sets relative line-number rendering.
    pub fn set_relative_line_numbers(&mut self, relative: bool) {
        self.relative_line_numbers = relative;
    }
}