Struct TocState 

pub struct TocState {
    pub scroll_offset: usize,
    pub hovered_entry: Option<usize>,
    pub hovered: bool,
    pub entries: Vec<TocEntry>,
}

Available on crate feature markdown-preview only.

State for the Table of Contents sidebar.

Manages scroll position, hover state, and TOC entries.

Fields

scroll_offset: usize

Current scroll offset within the TOC.

hovered_entry: Option<usize>

Index of the currently hovered entry, if any.

hovered: bool

Whether the TOC itself is hovered.

entries: Vec<TocEntry>

List of TOC entries extracted from the document.

Implementations

impl TocState

Constructor for TocState.

pub fn new() -> TocState

Create a new empty TocState.

impl TocState

Entry management methods for TocState.

pub fn entries(&self) -> &[TocEntry]

Get all TOC entries.

pub fn set_entries(&mut self, entries: Vec<TocEntry>)

Set the TOC entries.

pub fn clear_entries(&mut self)

Clear all TOC entries.

pub fn entry_count(&self) -> usize

Get the number of entries.

pub fn get_entry(&self, index: usize) -> Option<&TocEntry>

Get an entry by index.

pub fn has_entries(&self) -> bool

Check if the TOC has any entries.

impl TocState

Extract TOC entries from markdown content.

pub fn from_content(content: &str) -> TocState

Create a TocState with entries extracted from markdown content.

This scans the content for headings and populates the entries.

Arguments

• content - The markdown content to scan.

Returns

A new TocState with extracted entries.

pub fn update_from_content(&mut self, content: &str)

Update entries from markdown content.

Arguments

• content - The markdown content to scan.

impl TocState

Hover methods for TocState.

pub fn is_hovered(&self) -> bool

Check if the TOC is currently hovered.

pub fn set_hovered(&mut self, hovered: bool)

Set the hover state of the TOC.

pub fn hovered_entry(&self) -> Option<usize>

Get the currently hovered entry index, if any.

pub fn set_hovered_entry(&mut self, index: Option<usize>)

Set the hovered entry index.

pub fn is_entry_hovered(&self, index: usize) -> bool

Check if a specific entry is hovered.

impl TocState

Scroll methods for TocState.

pub fn scroll_offset(&self) -> usize

Get the current scroll offset.

pub fn set_scroll_offset(&mut self, offset: usize)

Set the scroll offset.

pub fn scroll_up(&mut self, amount: usize)

Scroll up by a given amount, clamping at 0.

pub fn scroll_down(&mut self, amount: usize)

Scroll down by a given amount, clamping at max entries.

pub fn scroll_to_top(&mut self)

Scroll to the top.

pub fn scroll_to_bottom(&mut self)

Scroll to the bottom.

Trait Implementations

impl Clone for TocState

fn clone(&self) -> TocState

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TocState

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Default for TocState

fn default() -> TocState

Returns the “default value” for a type.