Struct ColorMapping 

pub struct ColorMapping {
    pub dark: Option<String>,
    pub light: Option<String>,
}

Available on crate feature markdown-preview only.

Color mapping for light/dark modes.

This struct holds color names (not actual colors) that map to entries in a ColorPalette. When resolving the actual color, the appropriate variant (dark or light) is selected based on the current color scheme.

Fields

• dark - Color name to use in dark mode
• light - Color name to use in light mode

Example

use ratatui_toolkit::markdown_widget::extensions::theme::{ColorMapping, ColorPalette, palettes};

// ColorMapping references color names, not actual RGB values
let mapping = ColorMapping {
    dark: Some("blue".to_string()),
    light: Some("oceanBlue".to_string()),
};

let palette = palettes::dark_default();
let color = mapping.get_color(&palette, true); // true = dark mode

Fields

dark: Option<String>

Color name to use in dark mode.

light: Option<String>

Color name to use in light mode.

Implementations

impl ColorMapping

pub fn get_color(&self, palette: &ColorPalette, is_dark: bool) -> Color

Get color for the specified color scheme.

Resolves the appropriate color name (dark or light) based on the is_dark parameter, then looks up that color in the provided palette.

If the preferred variant (dark/light) is not set, falls back to the other variant. If neither variant is set, returns Color::White.

Arguments

• palette - The ColorPalette to look up color names in
• is_dark - Whether to use dark mode colors (true) or light mode colors (false)

Returns

The resolved Color for the current color scheme.

Example

use ratatui_toolkit::markdown_widget::extensions::theme::{ColorMapping, palettes};

let mapping = ColorMapping {
    dark: Some("blue".to_string()),
    light: Some("oceanBlue".to_string()),
};

let palette = palettes::dark_default();

// Get dark mode color
let dark_color = mapping.get_color(&palette, true);

// Get light mode color
let light_color = mapping.get_color(&palette, false);

Trait Implementations

impl Clone for ColorMapping

fn clone(&self) -> ColorMapping

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ColorMapping

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ColorMapping

fn deserialize<__D>( __deserializer: __D, ) -> Result<ColorMapping, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.