Struct ColorPalette 

pub struct ColorPalette(/* private fields */);

Color palette for mapping named colors to RGB values.

The ColorPalette struct provides a way to define and lookup colors by name, which is useful for theming systems where colors are referenced by semantic names rather than direct RGB values. Color palette mapping named colors to RGB values.

This struct wraps a HashMap to provide named color lookups. Colors can be added with semantic names (like “primary”, “error”, “success”) and retrieved by those names, with optional fallback to default colors.

Example

use ratatui_toolkit::markdown_widget::extensions::theme::ColorPalette;
use ratatui::style::Color;

let mut palette = ColorPalette::new();
palette.add_color("primary", Color::Rgb(97, 175, 239));

let color = palette.get_or_default("primary");

Implementations

impl ColorPalette

pub fn new() -> ColorPalette

Available on crate feature markdown-preview only.

Create a new empty palette.

Returns

A new ColorPalette with no colors defined.

Example

use ratatui_toolkit::markdown_widget::extensions::theme::ColorPalette;

let palette = ColorPalette::new();
assert!(palette.get("any_color").is_none());

impl ColorPalette

Method to get a color by name from the palette.

pub fn get(&self, name: &str) -> Option<Color>

Available on crate feature markdown-preview only.

Get a color by name, with fallback.

Arguments

• name - The name of the color to retrieve

Returns

Some(Color) if the color exists in the palette, None otherwise.

Example

use ratatui_toolkit::markdown_widget::extensions::theme::ColorPalette;
use ratatui::style::Color;

let mut palette = ColorPalette::new();
palette.add_color("blue", Color::Rgb(97, 175, 239));

assert!(palette.get("blue").is_some());
assert!(palette.get("nonexistent").is_none());

impl ColorPalette

Method to get a color by name with a default fallback.

pub fn get_or_default(&self, name: &str) -> Color

Available on crate feature markdown-preview only.

Get a color by name with default fallback.

If the color is not found in the palette, returns Color::White as the default.

Arguments

• name - The name of the color to retrieve

Returns

The Color associated with the name, or Color::White if not found.

Example

use ratatui_toolkit::markdown_widget::extensions::theme::ColorPalette;
use ratatui::style::Color;

let palette = ColorPalette::new();
// Returns Color::White since "nonexistent" is not in the palette
let color = palette.get_or_default("nonexistent");

impl ColorPalette

Method to add a color to the palette.

pub fn add_color(&mut self, name: &str, color: Color)

Available on crate feature markdown-preview only.

Add a color to the palette.

Arguments

• name - The name to associate with the color (e.g., “primary”, “error”)
• color - The ratatui Color value

Example

use ratatui_toolkit::markdown_widget::extensions::theme::ColorPalette;
use ratatui::style::Color;

let mut palette = ColorPalette::new();
palette.add_color("blue", Color::Rgb(97, 175, 239));

Trait Implementations

impl Clone for ColorPalette

fn clone(&self) -> ColorPalette

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ColorPalette

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

Formats the value using the given formatter.

impl Default for ColorPalette

fn default() -> ColorPalette

Returns the “default value” for a type.