Struct ComponentRoot 

pub struct ComponentRoot { /* private fields */ }

Implementations

impl ComponentRoot

pub fn new(file_name: Option<String>, components: Vec<Component>) -> Self

pub fn children(&self) -> Vec<&Component>

Examples found in repository

examples/demo.rs (line 89)

    fn draw(&mut self, frame: &mut Frame) {
        self.area = frame.area();

        self.markdown = Some(parser::parse_markdown(None, CONTENT, self.area.width));

        if let Some(markdown) = &mut self.markdown {
            markdown.set_scroll(self.scroll);

            let area = Rect {
                width: self.area.width - 1,
                height: self.area.height - 1,
                x: 1,
                ..self.area
            };

            for child in markdown.children() {
                if let Component::TextComponent(comp) = child {
                    if comp.y_offset().saturating_sub(comp.scroll_offset()) >= area.height
                        || (comp.y_offset() + comp.height()).saturating_sub(comp.scroll_offset())
                            == 0
                    {
                        continue;
                    }

                    frame.render_widget(comp.clone(), area);
                }
            }
        }
    }

pub fn children_mut(&mut self) -> Vec<&mut Component>

pub fn components(&self) -> Vec<&TextComponent>

pub fn components_mut(&mut self) -> Vec<&mut TextComponent>

pub fn file_name(&self) -> Option<&str>

pub fn words(&self) -> Vec<&Word>

pub fn find_and_mark(&mut self, search: &str)

pub fn search_results_heights(&self) -> Vec<usize>

pub fn clear(&mut self)

pub fn select(&mut self, index: usize) -> Result<u16, String>

pub fn deselect(&mut self)

pub fn find_footnote(&self, search: &str) -> String

pub fn link_index_and_height(&self) -> Vec<(usize, u16)>

pub fn set_scroll(&mut self, scroll: u16)

Sets the y offset of the components

Examples found in repository

examples/demo.rs (line 80)

    fn draw(&mut self, frame: &mut Frame) {
        self.area = frame.area();

        self.markdown = Some(parser::parse_markdown(None, CONTENT, self.area.width));

        if let Some(markdown) = &mut self.markdown {
            markdown.set_scroll(self.scroll);

            let area = Rect {
                width: self.area.width - 1,
                height: self.area.height - 1,
                x: 1,
                ..self.area
            };

            for child in markdown.children() {
                if let Component::TextComponent(comp) = child {
                    if comp.y_offset().saturating_sub(comp.scroll_offset()) >= area.height
                        || (comp.y_offset() + comp.height()).saturating_sub(comp.scroll_offset())
                            == 0
                    {
                        continue;
                    }

                    frame.render_widget(comp.clone(), area);
                }
            }
        }
    }

pub fn heading_offset(&self, heading: &str) -> Result<u16, String>

pub fn content(&self) -> Vec<String>

Return the content of the components, where each element a line

pub fn selected(&self) -> &str

pub fn selected_underlying_type(&self) -> WordType

pub fn transform(&mut self, width: u16)

Transforms the content of the components to fit the given width

pub fn add_missing_components(self) -> Self

Because of the parsing, every table has a missing newline at the end

pub fn height(&self) -> u16

Examples found in repository

examples/demo.rs (line 56)

    fn scroll_down(&mut self) -> bool {
        if let Some(markdown) = &self.markdown {
            let len = markdown.height();
            if self.area.height > len {
                self.scroll = 0;
            } else {
                self.scroll = std::cmp::min(
                    self.scroll.saturating_add(1),
                    len.saturating_sub(self.area.height),
                )
            }
        }
        true
    }

pub fn num_links(&self) -> usize

pub fn recompute_visibility(&mut self)

Walk all components and set their hidden flag based on whether any of their owning_details_ids references a currently-folded <details> block. Must be called after parse and after every fold-toggle so that height(), num_links(), etc. return the post-fold values used by set_scroll and the renderer.

pub fn num_details(&self) -> usize

Count of <details> summary headers that are currently visible (i.e. not hidden by an outer folded block). Used by the event handler to bound the cyclable selection index.

pub fn details_index_and_height(&self) -> Vec<(usize, u16)>

Returns (index, y_offset) for each visible details summary, in document order. Parallels link_index_and_height — callers use it to pick the summary nearest the current scroll position.

pub fn select_details(&mut self, index: usize) -> Result<u16, String>

Visually mark the index-th visible details summary as focused, returning its y_offset so the caller can scroll it into view. Clears any prior details focus first.

pub fn deselect_details(&mut self)

Clear focus from whichever details summary currently has it.

pub fn toggle_selected_details(&mut self) -> Result<(), String>

Flip the folded flag on the currently-focused details summary and recompute visibility. Returns Err if no details summary is focused.