Struct Palette 

pub struct Palette {
    pub name: Cow<'static, str>,
    pub color: [[Color; 8]; 19],
    pub aliased: Cow<'static, [(Cow<'static, str>, ColorIdx)]>,
}

Color palette.

This provides the palette used for a theme.

Fields

name: Cow<'static, str>

Name of the color palette.

color: [[Color; 8]; 19]

Color palette. Use Colors for indexing.

aliased: Cow<'static, [(Cow<'static, str>, ColorIdx)]>

Sorted list of aliases. Must be pre-sorted for binary-search.

Implementations

impl Palette

pub fn white(&self, n: usize) -> Style

Create a style from the given white shade. n is 0..=7 with 4..=7 as darker variants of the first 3.

pub fn black(&self, n: usize) -> Style

Create a style from the given black shade. n is 0..=7 with 4..=7 as darker variants of the first 3.

pub fn gray(&self, n: usize) -> Style

Create a style from the given gray shade. n is 0..=7 with 4..=7 as darker variants of the first 3.

pub fn red(&self, n: usize) -> Style

Create a style from the given red shade. n is 0..=7 with 4..=7 as darker variants of the first 3.

pub fn orange(&self, n: usize) -> Style

Create a style from the given orange shade. n is 0..=7 with 4..=7 as darker variants of the first 3.

pub fn yellow(&self, n: usize) -> Style

Create a style from the given yellow shade. n is 0..=7 with 4..=7 as darker variants of the first 3.

pub fn limegreen(&self, n: usize) -> Style

Create a style from the given limegreen shade. n is 0..=7 with 4..=7 as darker variants of the first 3.

pub fn green(&self, n: usize) -> Style

Create a style from the given green shade. n is 0..=7 with 4..=7 as darker variants of the first 3.

pub fn bluegreen(&self, n: usize) -> Style

Create a style from the given bluegreen shade. n is 0..=7 with 4..=7 as darker variants of the first 3.

pub fn cyan(&self, n: usize) -> Style

Create a style from the given cyan shade. n is 0..=7 with 4..=7 as darker variants of the first 3.

pub fn blue(&self, n: usize) -> Style

Create a style from the given blue shade. n is 0..=7 with 4..=7 as darker variants of the first 3.

pub fn deepblue(&self, n: usize) -> Style

Create a style from the given deepblue shade. n is 0..=7 with 4..=7 as darker variants of the first 3.

pub fn purple(&self, n: usize) -> Style

Create a style from the given purple shade. n is 0..=7 with 4..=7 as darker variants of the first 3.

pub fn magenta(&self, n: usize) -> Style

Create a style from the given magenta shade. n is 0..=7 with 4..=7 as darker variants of the first 3.

pub fn redpink(&self, n: usize) -> Style

Create a style from the given redpink shade. n is 0..=7 with 4..=7 as darker variants of the first 3.

pub fn primary(&self, n: usize) -> Style

Create a style from the given primary shade. n is 0..=7 with 4..=7 as darker variants of the first 3.

pub fn secondary(&self, n: usize) -> Style

Create a style from the given secondary shade. n is 0..=7 with 4..=7 as darker variants of the first 3.

impl Palette

pub fn color(&self, id: Colors, n: usize) -> Color

The Color for the id + index n.

pub fn style(&self, id: Colors, n: usize) -> Style

Create a style with the given background color. The foreground is chosen from the text-colors for a normal contrast.

pub fn high_style(&self, id: Colors, n: usize) -> Style

Create a style with the given background color. The foreground is chosen from the text-colors for high contrast.

pub fn fg_bg_style(&self, fg: Colors, n: usize, bg: Colors, m: usize) -> Style

Create a style with the given fg/bg.

pub fn fg_style(&self, id: Colors, n: usize) -> Style

Create a style with only fg set.

pub fn bg_style(&self, id: Colors, n: usize) -> Style

Create a style with only bg set.

pub fn add_aliased(&mut self, id: &str, color_idx: ColorIdx)

Add an alias.

pub fn try_aliased(&self, id: &str) -> Option<ColorIdx>

Try to find an alias.

pub fn aliased(&self, id: &str) -> ColorIdx

Get the ColorIdx of an aliased color.

Panic

With debug_assertions this panics if the alias is not found. Otherwise, it returns a default.

pub fn color_alias(&self, id: &str) -> Color

Get an aliased color.

pub fn style_alias(&self, bg: &str) -> Style

Get a Style for a color-alias. Uses the color as bg() and finds the matching text-color for normal contrast.

pub fn high_style_alias(&self, bg: &str) -> Style

Get a Style for a color-alias. Uses the color as bg() and finds the matching text-color for high contrast.

pub fn fg_bg_style_alias(&self, fg: &str, bg: &str) -> Style

Get a Style for a color-alias. Uses explicit aliases for fg() and bg()

pub fn fg_style_alias(&self, fg: &str) -> Style

Get a Style for a color-alias. This creates a style with only the fg() color set.

pub fn bg_style_alias(&self, bg: &str) -> Style

Get a Style for a color-alias. This creates a style with only the bg() color set.

impl Palette

pub fn high_contrast(&self, color: Color) -> Style

Create a style with the given background color. Uses white[3] or black[0] for the foreground, based on rate_text_color.

pub fn normal_contrast(&self, color: Color) -> Style

Create a style with the given background color. Uses text_light or text_dark for the foreground, based on rate_text_color.

pub fn normal_contrast_color(&self, bg: Color, text: &[Color]) -> Style

Pick a color from the choice with a good contrast to the given background.

pub fn high_contrast_color(&self, bg: Color, text: &[Color]) -> Style

Pick a color from the choice with the best contrast to the given background.

pub const fn grayscale(color: Color) -> Color

Converts the given color to an equivalent grayscale.

pub const fn color_from_u32(c: u32) -> Color

Color from u32

pub const fn color_to_u32(color: Color) -> u32

Color to u32

pub const fn interpolatec(c0: Color, c3: Color, dark_scale_to: u8) -> [Color; 8]

Calculates a linear interpolation for the two colors and fills the first 4 colors with it. The next 4 colors are scaled down versions using dark_scale_to.

pub const fn interpolate(c0: u32, c3: u32, dark_scale_to: u8) -> [Color; 8]

Calculates a linear interpolation for the two colors and fills the first 4 colors with it. The next 4 colors are scaled down versions using dark_scale_to.

pub const fn interpolatec2( c0: Color, c3: Color, c4: Color, c7: Color, ) -> [Color; 8]

Calculates a linear interpolation for the two colors and fills the first 4 colors with it. The next 4 colors are scaled down versions using dark_scale_to.

pub const fn interpolate2(c0: u32, c3: u32, c4: u32, c7: u32) -> [Color; 8]

Calculates a linear interpolation for the two colors and fills the first 4 colors with it. The next 4 colors are scaled down versions using dark_scale_to.

pub const fn scale_to(v: u8, scale_to: u8) -> u8

Scale the u8 down to scale_to.

pub const fn color_to_rgb(color: Color) -> (u8, u8, u8)

Gives back the rgb for any ratatui Color. Has the indexed and the named colors too.

Trait Implementations

impl Clone for Palette

fn clone(&self) -> Palette

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Palette

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

Formats the value using the given formatter.

impl Default for Palette

fn default() -> Self

Returns the “default value” for a type.