Struct MarkdownState 

pub struct MarkdownState {

    pub scroll: ScrollState,
    pub source: SourceState,
    pub cache: CacheState,
    pub display: DisplaySettings,
    pub collapse: CollapseState,
    pub expandable: ExpandableState,
    pub git_stats: GitStatsState,
    pub vim: VimState,
    pub selection: SelectionState,
    pub double_click: DoubleClickState,
    pub toc_hovered: bool,
    pub toc_hovered_entry: Option<usize>,
    pub toc_scroll_offset: usize,
    pub selection_active: bool,
    pub cached_git_stats: Option<GitStats>,
    pub rendered_lines: Vec<Line<'static>>,
    pub filter: Option<String>,
    pub filter_mode: bool,
    /* private fields */
}

Unified state for the markdown widget.

This struct bundles all component states together, making it easier to manage widget state without passing many individual references.

Example

use ratatui_toolkit::markdown_widget::state::MarkdownState;
use ratatui_toolkit::MarkdownWidget;

let mut state = MarkdownState::default();
state.source.set_content("# Hello World");

let widget = MarkdownWidget::from_state(&mut state)
    .show_toc(true)
    .show_statusline(true);

Fields

scroll: ScrollState

Core scroll state (position, viewport, current line).

source: SourceState

Content source state.

cache: CacheState

Render cache state.

display: DisplaySettings

Display settings (line numbers, themes).

collapse: CollapseState

Section collapse state.

expandable: ExpandableState

Expandable content state.

git_stats: GitStatsState

Git stats state.

vim: VimState

Vim keybinding state.

selection: SelectionState

Selection state for text selection/copy.

double_click: DoubleClickState

Double-click detection state.

toc_hovered: bool

Whether the TOC is currently hovered.

toc_hovered_entry: Option<usize>

Index of the hovered TOC entry.

toc_scroll_offset: usize

Scroll offset for the TOC list.

selection_active: bool

Whether selection mode is active.

cached_git_stats: Option<GitStats>

Git statistics for the file (cached from git_stats state).

rendered_lines: Vec<Line<'static>>

Cached rendered lines for selection text extraction. This persists between frames so mouse events can access line data.

filter: Option<String>

Current filter text (when in filter mode).

filter_mode: bool

Whether filter mode is currently active.

Implementations

impl MarkdownState

pub fn inner_area(&self) -> Rect

Available on crate feature markdown-preview only.

Get the inner area for mouse event handling.

Returns the inner area that was set during the last render.

pub fn set_inner_area(&mut self, area: Rect)

Available on crate feature markdown-preview only.

Set the inner area for mouse event handling.

This is typically called by the widget during render.

pub fn content(&self) -> &str

Available on crate feature markdown-preview only.

Get the content from the source state.

Returns the content if set, or an empty string.

pub fn update_git_stats(&mut self)

Available on crate feature markdown-preview only.

Update git stats from the source path.

This should be called periodically to refresh git information.

pub fn reload_source_if_changed(&mut self) -> Result<bool, Error>

Available on crate feature markdown-preview only.

Reload file content if the watcher detected changes.

Returns true when content changed and caches were invalidated.

impl MarkdownState

Default implementation for MarkdownState.

This module is kept for compatibility but Default is now derived on the MarkdownState struct directly. Constructor for MarkdownState.

pub fn new() -> MarkdownState

Available on crate feature markdown-preview only.

Create a new MarkdownState with all default values.

This is equivalent to MarkdownState::default().

pub fn with_display(display: DisplaySettings) -> MarkdownState

Available on crate feature markdown-preview only.

Create a new MarkdownState with custom display settings.

Trait Implementations

impl Clone for MarkdownState

fn clone(&self) -> MarkdownState

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Default for MarkdownState

fn default() -> MarkdownState

Returns the “default value” for a type.