Colors¶

Custom colors for the PrairieLearn project based on Coloraide.

Based on https://gist.github.com/facelessuser/0b129c1faf7f3f59c0de40eeaaab5691/.

from prairielearn.colors import ...

PrairieLearnColor ¶

Custom sRGB class to handle custom PrairieLearn colors, via Coloraide.

match ¶

match(
    string: str, start: int = 0, fullmatch: bool = True
) -> tuple[tuple[Vector, float], int] | None

Match a color string, first trying PrairieLearn. If no match is found, defaults to sRGB class' implementation.

Returns:

Type	Description
`tuple[tuple[Vector, float], int] \| None`	The matched color

to_string ¶

to_string(
    parent: Color,
    *,
    alpha: bool | None = None,
    fit: bool | str | dict[str, Any] = True,
    names: bool = False,
    **kwargs: Any,
) -> str

Convert the color to a string.

Returns:

Type	Description
`str`	The color as a string.

get_css_color ¶

get_css_color(name: str) -> str | None

Get the hex code value from a named css color.

Returns:

Type	Description
`str \| None`	The hex code of the color, otherwise `None`.