Struct ColorPalette 

pub struct ColorPalette {
    pub primary: Color,
    pub secondary: Color,
    pub surface: Color,
    pub background: Color,
    pub error: Color,
    pub warning: Color,
    pub success: Color,
    pub on_primary: Color,
    pub on_secondary: Color,
    pub on_surface: Color,
    pub on_background: Color,
    pub on_error: Color,
}

A color palette for theming.

Fields

primary: Color

Primary brand color

secondary: Color

Secondary brand color

surface: Color

Surface/background color

background: Color

Background color

error: Color

Error/danger color

warning: Color

Warning color

success: Color

Success color

on_primary: Color

Text on primary

on_secondary: Color

Text on secondary

on_surface: Color

Text on surface

on_background: Color

Text on background

on_error: Color

Text on error

Implementations

impl ColorPalette

pub fn check_contrast(&self) -> Vec<ContrastCheck>

Check all foreground/background combinations for WCAG compliance. Returns a list of contrast checks for each semantic color pair.

pub fn passes_wcag_aa(&self) -> bool

Check if all color pairs pass WCAG AA.

pub fn passes_wcag_aaa(&self) -> bool

Check if all color pairs pass WCAG AAA.

pub fn failing_aa(&self) -> Vec<ContrastCheck>

Get any failing contrast pairs for WCAG AA.

pub fn light() -> ColorPalette

Create a light color palette. All color combinations pass WCAG AA (4.5:1 contrast ratio).

pub fn dark() -> ColorPalette

Create a dark color palette.

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.

impl<'de> Deserialize<'de> for ColorPalette

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for ColorPalette

fn eq(&self, other: &ColorPalette) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for ColorPalette

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ColorPalette