colour

Types

Colour

pub type Colour =
  colour.Colour

ColourPalette

</>

pub type ColourPalette {
  ColourPalette(
    base: ColourScale,
    primary: ColourScale,
    secondary: ColourScale,
    success: ColourScale,
    warning: ColourScale,
    danger: ColourScale,
  )
}

Constructors

ColourPalette(
  base: ColourScale,
  primary: ColourScale,
  secondary: ColourScale,
  success: ColourScale,
  warning: ColourScale,
  danger: ColourScale,
)

ColourScale

</>

pub type ColourScale {
  ColourScale(
    bg: Colour,
    bg_subtle: Colour,
    tint: Colour,
    tint_subtle: Colour,
    tint_strong: Colour,
    accent: Colour,
    accent_subtle: Colour,
    accent_strong: Colour,
    solid: Colour,
    solid_subtle: Colour,
    solid_strong: Colour,
    solid_text: Colour,
    text: Colour,
    text_subtle: Colour,
  )
}

Constructors

ColourScale(
  bg: Colour,
  bg_subtle: Colour,
  tint: Colour,
  tint_subtle: Colour,
  tint_strong: Colour,
  accent: Colour,
  accent_subtle: Colour,
  accent_strong: Colour,
  solid: Colour,
  solid_subtle: Colour,
  solid_strong: Colour,
  solid_text: Colour,
  text: Colour,
  text_subtle: Colour,
)

Functions

amber

</>

pub fn amber() -> ColourScale

amber_dark

</>

pub fn amber_dark() -> ColourScale

blue

</>

pub fn blue() -> ColourScale

blue_dark

</>

pub fn blue_dark() -> ColourScale

bronze

</>

pub fn bronze() -> ColourScale

bronze_dark

</>

pub fn bronze_dark() -> ColourScale

brown

</>

pub fn brown() -> ColourScale

brown_dark

</>

pub fn brown_dark() -> ColourScale

contrast_ratio

</>

pub fn contrast_ratio(a: Colour, b: Colour) -> Float

crimson

</>

pub fn crimson() -> ColourScale

crimson_dark

</>

pub fn crimson_dark() -> ColourScale

cyan

</>

pub fn cyan() -> ColourScale

cyan_dark

</>

pub fn cyan_dark() -> ColourScale

decoder

</>

pub fn decoder(
  json: Dynamic,
) -> Result(ColourScale, List(DecodeError))

default_dark_palette

</>

pub fn default_dark_palette() -> ColourPalette

Lustre UI’s default dark colour palette. You can use this if you don’t have any strict requirements around colours and you want to start building your app straight away.

This is the dark mode palette used by the default theme, but it is not required to only use this palette for dark mode!

default_light_palette

</>

pub fn default_light_palette() -> ColourPalette

Lustre UI’s default light colour palette. You can use this if you don’t have any strict requirements around colours and you want to start building your app straight away.

This is the light mode palette used by the default theme.

encode

</>

pub fn encode(scale: ColourScale) -> Json

encode_palette

</>

pub fn encode_palette(palette: ColourPalette) -> Json

gold

</>

pub fn gold() -> ColourScale

gold_dark

</>

pub fn gold_dark() -> ColourScale

grass

</>

pub fn grass() -> ColourScale

grass_dark

</>

pub fn grass_dark() -> ColourScale

gray

</>

pub fn gray() -> ColourScale

gray_dark

</>

pub fn gray_dark() -> ColourScale

green

</>

pub fn green() -> ColourScale

green_dark

</>

pub fn green_dark() -> ColourScale

hsl

</>

pub fn hsl(h: Float, s: Float, l: Float) -> Colour

indigo

</>

pub fn indigo() -> ColourScale

indigo_dark

</>

pub fn indigo_dark() -> ColourScale

iris

</>

pub fn iris() -> ColourScale

iris_dark

</>

pub fn iris_dark() -> ColourScale

jade

</>

pub fn jade() -> ColourScale

jade_dark

</>

pub fn jade_dark() -> ColourScale

lime

</>

pub fn lime() -> ColourScale

lime_dark

</>

pub fn lime_dark() -> ColourScale

luminance

</>

pub fn luminance(colour: Colour) -> Float

mauve

</>

pub fn mauve() -> ColourScale

mauve_dark

</>

pub fn mauve_dark() -> ColourScale

maximum_contrast

</>

pub fn maximum_contrast(
  base: Colour,
  options: List(Colour),
) -> Colour

mint

</>

pub fn mint() -> ColourScale

mint_dark

</>

pub fn mint_dark() -> ColourScale

olive

</>

pub fn olive() -> ColourScale

olive_dark

</>

pub fn olive_dark() -> ColourScale

orange

</>

pub fn orange() -> ColourScale

orange_dark

</>

pub fn orange_dark() -> ColourScale

palette_decoder

</>

pub fn palette_decoder(
  json: Dynamic,
) -> Result(ColourPalette, List(DecodeError))

pink

</>

pub fn pink() -> ColourScale

pink_dark

</>

pub fn pink_dark() -> ColourScale

plum

</>

pub fn plum() -> ColourScale

plum_dark

</>

pub fn plum_dark() -> ColourScale

purple

</>

pub fn purple() -> ColourScale

purple_dark

</>

pub fn purple_dark() -> ColourScale

red

</>

pub fn red() -> ColourScale

red_dark

</>

pub fn red_dark() -> ColourScale

rgb

</>

pub fn rgb(r: Int, g: Int, b: Int) -> Colour

rgba

</>

pub fn rgba(r: Int, g: Int, b: Int, a: Float) -> Colour

ruby

</>

pub fn ruby() -> ColourScale

ruby_dark

</>

pub fn ruby_dark() -> ColourScale

sage

</>

pub fn sage() -> ColourScale

sage_dark

</>

pub fn sage_dark() -> ColourScale

sand

</>

pub fn sand() -> ColourScale

sand_dark

</>

pub fn sand_dark() -> ColourScale

sky

</>

pub fn sky() -> ColourScale

sky_dark

</>

pub fn sky_dark() -> ColourScale

slate

</>

pub fn slate() -> ColourScale

slate_dark

</>

pub fn slate_dark() -> ColourScale

teal

</>

pub fn teal() -> ColourScale

teal_dark

</>

pub fn teal_dark() -> ColourScale

tomato

</>

pub fn tomato() -> ColourScale

tomato_dark

</>

pub fn tomato_dark() -> ColourScale

violet

</>

pub fn violet() -> ColourScale

violet_dark

</>

pub fn violet_dark() -> ColourScale

yellow

</>

pub fn yellow() -> ColourScale

yellow_dark

</>

pub fn yellow_dark() -> ColourScale