TypstDocumentation

color

A color in a specific color space.

Typst supports:

Example

#rect(fill: aqua)
Preview

Predefined colors

Typst defines the following built-in colors:

ColorDefinition
blackluma(0)
grayluma(170)
silverluma(221)
whiteluma(255)
navyrgb("#001f3f")
bluergb("#0074d9")
aquargb("#7fdbff")
tealrgb("#39cccc")
easternrgb("#239dad")
purplergb("#b10dc9")
fuchsiargb("#f012be")
maroonrgb("#85144b")
redrgb("#ff4136")
orangergb("#ff851b")
yellowrgb("#ffdc00")
olivergb("#3d9970")
greenrgb("#2ecc40")
limergb("#01ff70")

The predefined colors and the most important color constructors are available globally and also in the color type's scope, so you can write either color.red or just red.

Preview

Predefined color maps

Typst also includes a number of preset color maps that can be used for gradients. Most of these color maps are chosen to be color blind friendly.

MapDetails
turboA perceptually uniform rainbow-like color map. Read this blog post for more details.
cividisA blue to gray to yellow color map. See this blog post for more details.
rainbowCycles through the full color spectrum. This color map is best used by setting the interpolation color space to HSL. The rainbow gradient is not suitable for data visualization because it is not perceptually uniform, so the differences between values become unclear to your readers. It should only be used for decorative purposes.
spectralRed to yellow to blue color map.
viridisA purple to teal to yellow color map.
infernoA black to red to yellow color map.
magmaA black to purple to yellow color map.
plasmaA purple to pink to yellow color map.
rocketA black to red to white color map.
makoA black to teal to yellow color map.
vlagA light blue to white to red color map.
icefireA light teal to black to yellow color map.
flareA orange to purple color map that is perceptually uniform.
crestA blue to white to red color map.

Some popular presets are not included because they are not available under a free licence. Others, like Jet, are not included because they are not color blind friendly. Feel free to use or create a package with other presets that are useful to you!

Preview

Definitions
Question mark

luma

Create a grayscale color.

A grayscale color is represented internally by a single lightness component.

These components are also available using the components method.

color.luma() -> color
#for x in range(250, step: 50) {
  box(square(fill: luma(x)))
}
Preview

lightness
int or ratio
RequiredPositional
Question mark

The lightness component.

color
color
RequiredPositional
Question mark

Alternatively: The color to convert to grayscale.

If this is given, the lightness should not be given.

oklab

Create an Oklab color.

This color space is well suited for the following use cases:

A linear Oklab color is represented internally by an array of four components:

These components are also available using the components method.

#square(
  fill: oklab(27%, 20%, -3%, 50%)
)
Preview

lightness
ratio
RequiredPositional
Question mark

The lightness component.

a
float or ratio
RequiredPositional
Question mark

The a ("green/red") component.

b
float or ratio
RequiredPositional
Question mark

The b ("blue/yellow") component.

alpha
ratio
RequiredPositional
Question mark

The alpha component.

color
color
RequiredPositional
Question mark

Alternatively: The color to convert to Oklab.

If this is given, the individual components should not be given.

oklch

Create an Oklch color.

This color space is well suited for the following use cases:

A linear Oklch color is represented internally by an array of four components:

These components are also available using the components method.

#square(
  fill: oklch(40%, 0.2, 160deg, 50%)
)
Preview

lightness
ratio
RequiredPositional
Question mark

The lightness component.

chroma
float or ratio
RequiredPositional
Question mark

The chroma component.

hue
angle
RequiredPositional
Question mark

The hue component.

alpha
ratio
RequiredPositional
Question mark

The alpha component.

color
color
RequiredPositional
Question mark

Alternatively: The color to convert to Oklch.

If this is given, the individual components should not be given.

linear-rgb

Create an RGB(A) color with linear luma.

This color space is similar to sRGB, but with the distinction that the color component are not gamma corrected. This makes it easier to perform color operations such as blending and interpolation. Although, you should prefer to use the oklab function for these.

A linear RGB(A) color is represented internally by an array of four components:

These components are also available using the components method.

#square(fill: color.linear-rgb(
  30%, 50%, 10%,
))
Preview

red
int or ratio
RequiredPositional
Question mark

The red component.

green
int or ratio
RequiredPositional
Question mark

The green component.

blue
int or ratio
RequiredPositional
Question mark

The blue component.

alpha
int or ratio
RequiredPositional
Question mark

The alpha component.

color
color
RequiredPositional
Question mark

Alternatively: The color to convert to linear RGB(A).

If this is given, the individual components should not be given.

rgb

Create an RGB(A) color.

The color is specified in the sRGB color space.

An RGB(A) color is represented internally by an array of four components:

These components are also available using the components method.

#square(fill: rgb("#b1f2eb"))
#square(fill: rgb(87, 127, 230))
#square(fill: rgb(25%, 13%, 65%))
Preview

red
int or ratio
RequiredPositional
Question mark

The red component.

green
int or ratio
RequiredPositional
Question mark

The green component.

blue
int or ratio
RequiredPositional
Question mark

The blue component.

alpha
int or ratio
RequiredPositional
Question mark

The alpha component.

hex
str
RequiredPositional
Question mark

Alternatively: The color in hexadecimal notation.

Accepts three, four, six or eight hexadecimal digits and optionally a leading hash.

If this is given, the individual components should not be given.

View example
#text(16pt, rgb("#239dad"))[
  *Typst*
]
Preview

color
color
RequiredPositional
Question mark

Alternatively: The color to convert to RGB(a).

If this is given, the individual components should not be given.

cmyk

Create a CMYK color.

This is useful if you want to target a specific printer. The conversion to RGB for display preview might differ from how your printer reproduces the color.

An HSL color is represented internally by an array of four components:

These components are also available using the components method.

color.cmyk() -> color
#square(
  fill: cmyk(27%, 0%, 3%, 5%)
)
Preview

cyan
ratio
RequiredPositional
Question mark

The cyan component.

magenta
ratio
RequiredPositional
Question mark

The magenta component.

yellow
ratio
RequiredPositional
Question mark

The yellow component.

key
ratio
RequiredPositional
Question mark

The key component.

color
color
RequiredPositional
Question mark

Alternatively: The color to convert to CMYK.

If this is given, the individual components should not be given.

hsl

Create an HSL color.

This color space is useful for specifying colors by hue, saturation and lightness. It is also useful for color manipulation, such as saturating while keeping perceived hue.

An HSL color is represented internally by an array of four components:

These components are also available using the components method.

#square(
  fill: color.hsl(30deg, 50%, 60%)
)
Preview

hue
angle
RequiredPositional
Question mark

The hue angle.

saturation
int or ratio
RequiredPositional
Question mark

The saturation component.

lightness
int or ratio
RequiredPositional
Question mark

The lightness component.

alpha
int or ratio
RequiredPositional
Question mark

The alpha component.

color
color
RequiredPositional
Question mark

Alternatively: The color to convert to HSL.

If this is given, the individual components should not be given.

hsv

Create an HSV color.

This color space is useful for specifying colors by hue, saturation and value. It is also useful for color manipulation, such as saturating while keeping perceived hue.

An HSV color is represented internally by an array of four components:

These components are also available using the components method.

#square(
  fill: color.hsv(30deg, 50%, 60%)
)
Preview

hue
angle
RequiredPositional
Question mark

The hue angle.

saturation
int or ratio
RequiredPositional
Question mark

The saturation component.

value
int or ratio
RequiredPositional
Question mark

The value component.

alpha
int or ratio
RequiredPositional
Question mark

The alpha component.

color
color
RequiredPositional
Question mark

Alternatively: The color to convert to HSL.

If this is given, the individual components should not be given.

components

Extracts the components of this color.

The size and values of this array depends on the color space. You can obtain the color space using space. Below is a table of the color spaces and their components:

Color spaceC1C2C3C4
lumaLightness
oklabLightnessabAlpha
oklchLightnessChromaHueAlpha
linear-rgbRedGreenBlueAlpha
rgbRedGreenBlueAlpha
cmykCyanMagentaYellowKey
hslHueSaturationLightnessAlpha
hsvHueSaturationValueAlpha

For the meaning and type of each individual value, see the documentation of the corresponding color space. The alpha component is optional and only included if the alpha argument is true. The length of the returned array depends on the number of components and whether the alpha component is included.

self.components() -> array
// note that the alpha component is included by default
#(rgb(40%, 60%, 80%).components() == (40%, 60%, 80%, 100%))
Preview

alpha

Whether to include the alpha component.

Default: true

space

Returns the constructor function for this color's space:

self.space(
) -> any
#let color = cmyk(1%, 2%, 3%, 4%)
#(color.space() == cmyk)
Preview

to-hex

Returns the color's RGB(A) hex representation (such as #ffaa32 or #020304fe). The alpha component (last two digits in #020304fe) is omitted if it is equal to ff (255 / 100%).

self.to-hex(
) -> str

lighten

Lightens a color by a given factor.

self.lighten() -> color

factor
ratio
RequiredPositional
Question mark

The factor to lighten the color by.

darken

Darkens a color by a given factor.

self.darken() -> color

factor
ratio
RequiredPositional
Question mark

The factor to darken the color by.

saturate

Increases the saturation of a color by a given factor.

self.saturate() -> color

factor
ratio
RequiredPositional
Question mark

The factor to saturate the color by.

desaturate

Decreases the saturation of a color by a given factor.

self.desaturate() -> color

factor
ratio
RequiredPositional
Question mark

The factor to desaturate the color by.

negate

Produces the negative of the color.

self.negate(
) -> color

rotate

Rotates the hue of the color by a given angle.

self.rotate() -> color

angle
angle
RequiredPositional
Question mark

The angle to rotate the hue by.

space
any

The color space used to rotate. By default, this happens in a perceptual color space (oklch).

Default: oklch

mix

Create a color by mixing two or more colors.

color.mix() -> color
#set block(height: 20pt, width: 100%)
#block(fill: red.mix(blue))
#block(fill: red.mix(blue, space: rgb))
#block(fill: color.mix(red, blue, white))
#block(fill: color.mix((red, 70%), (blue, 30%)))
Preview

colors
color or array
RequiredPositional
Question mark
Variadic
Question mark

The colors, optionally with weights, specified as a pair (array of length two) of color and weight (float or ratio).

The weights do not need to add to 100%, they are relative to the sum of all weights.

space
any

The color space to mix in. By default, this happens in a perceptual color space (oklab).

Default: oklab