Skip to main content

TocConfig

Struct TocConfig 

Source
pub struct TocConfig {
Show 17 fields pub compact_width: u16, pub expanded_width: u16, pub height: u16, pub style: TocStyle, pub text_style: Style, pub active_style: Style, pub hover_style: Style, pub accent_style: Style, pub active_accent_style: Style, pub background_style: Style, pub line_style: Style, pub active_line_style: Style, pub show_border: bool, pub border_style: Style, pub title_style: Style, pub title: String, pub line_spacing: u8,
}
Expand description

Configuration for TOC appearance.

Fields§

§compact_width: u16

Width of the TOC in compact mode.

§expanded_width: u16

Width of the TOC in expanded mode.

§height: u16

Height of the TOC.

§style: TocStyle

Visual style mode for the TOC.

§text_style: Style

Style for normal heading text.

§active_style: Style

Style for the current/active heading.

§hover_style: Style

Style for hovered heading.

§accent_style: Style

Style for the accent bar in clerk mode (left border indicator).

§active_accent_style: Style

Style for the active accent bar in clerk mode.

§background_style: Style

Background style for the TOC panel.

§line_style: Style

Style for the compact mode lines.

§active_line_style: Style

Style for the active line in compact mode.

§show_border: bool

Whether to show a border around the TOC (only in expanded mode).

§border_style: Style

Style for the border.

§title_style: Style

Style for the title text in the border.

§title: String

Title text to show in the border header.

§line_spacing: u8

Spacing between lines in compact mode (in 1/8 cell units). 1 = tightest (8 lines per row), 8 = one line per row.

Implementations§

Source§

impl TocConfig

Theme application for TocConfig.

Source

pub fn with_theme(self, theme: &AppTheme) -> TocConfig

Available on crate feature markdown-preview only.

Creates a TocConfig with colors derived from the application theme.

This applies theme colors to:

  • Text style (using markdown text color)
  • Active style (using theme primary color)
  • Hover style (using theme accent with background_element)
  • Background style (using theme background_panel)
  • Line style (using theme border color)
  • Active line style (using theme text color)
  • Border style (using theme border_active color)
  • Title style (using theme primary color)
§Arguments
  • theme - The application theme to derive colors from
§Returns

Self for method chaining.

§Example

let theme = AppTheme::default();
let config = TocConfig::default().with_theme(&theme);

Trait Implementations§

Source§

impl Clone for TocConfig

Source§

fn clone(&self) -> TocConfig

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for TocConfig

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for TocConfig

Default trait implementation for TocConfig.

Source§

fn default() -> TocConfig

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more