Skip to content
Catppuccin Whiskers

Context Variables Reference

These are all of the context variables available to use in your templates, alongside all of the existing Tera built-ins.

Single-Flavor Mode

Section titled “Single-Flavor Mode”
VariableDescription
flavor (Flavor)The flavor being templated.
rosewater, flamingo, pink, etc. (Color)All colors of the flavor being templated.
Any FrontmatterAll frontmatter variables as described in the Frontmatter Reference.

Multi-Flavor Mode

Section titled “Multi-Flavor Mode”
VariableDescription
flavors
(Map<String, Flavor>)		An array containing all of the named flavors, with every other context variable.
Any FrontmatterAll frontmatter variables as described in the Frontmatter Reference.

Types

Section titled “Types”

These types are designed to closely match the palette.json.

Flavor

Section titled “Flavor”

name

Section titled “name”
  • Description: The name of the flavor.
  • Type: String
  • Examples: "Latte", "Frappé", "Macchiato", "Mocha"

identifier

Section titled “identifier”
  • Description: The identifier of the flavor.
  • Type: String
  • Examples: "latte", "frappe", "macchiato", "mocha"

emoji

Section titled “emoji”
  • Description: Emoji associated with the flavor.
  • Type: char
  • Examples: '🌻', '🪴', '🌺', '🌿'

order

Section titled “order”
  • Description: Order of the flavor in the palette spec.
  • Type: u32
  • Examples: 0 to 3

dark

Section titled “dark”
  • Description: Whether the flavor is dark.
  • Type: bool
  • Examples: false for Latte, true for others

light

Section titled “light”
  • Description: Whether the flavor is light.
  • Type: bool
  • Examples: true for Latte, false for others

colors

Section titled “colors”
  • Description: A map of color identifiers to their respective values.
  • Type: Map<String,Color>

Color

Section titled “Color”

name

Section titled “name”
  • Description: The name of the color.
  • Type: String
  • Examples: "Rosewater", "Surface 0", "Base"

identifier

Section titled “identifier”
  • Description: The identifier of the color.
  • Type: String
  • Examples: "rosewater", "surface0", "base"

order

Section titled “order”
  • Description: Order of the color in the palette spec.
  • Type: u32
  • Examples: 0 to 25

accent

Section titled “accent”
  • Description: Whether the color is an accent color.
  • Type: bool

hex

Section titled “hex”
  • Description: The color in hexadecimal format.
  • Type: String
  • Examples: "1e1e2e"

int24

Section titled “int24”
  • Description: Big-endian 24-bit color in RGB order.
  • Type: u32
  • Examples: 1973806

uint32

Section titled “uint32”
  • Description: Big-endian unsigned 32-bit color in ARGB order.
  • Type: u32
  • Examples: 4280163886

sint32

Section titled “sint32”
  • Description: Big-endian signed 32-bit color in ARGB order.
  • Type: i32
  • Examples: -14803410

rgb

Section titled “rgb”
  • Description: The color in RGB format.
  • Type: RGB

hsl

Section titled “hsl”
  • Description: The color in HSL format.
  • Type: HSL

opacity

Section titled “opacity”
  • Description: The opacity of the color.
  • Type: u8
  • Examples: 0 to 255

RGB

Section titled “RGB”

r

Section titled “r”
  • Description: The red channel of the color.
  • Type: u8

g

Section titled “g”
  • Description: The green channel of the color.
  • Type: u8

b

Section titled “b”
  • Description: The blue channel of the color.
  • Type: u8

channels

Section titled “channels”
  • Description: An array containing the [R, G, B] channels of the color.
  • Type: [u8; 3]
  • Examples: [30, 30, 46]

HSL

Section titled “HSL”

h

Section titled “h”
  • Description: The hue of the color.
  • Type: u16

s

Section titled “s”
  • Description: The saturation of the color.
  • Type: u8

l

Section titled “l”
  • Description: The lightness of the color.
  • Type: u8