ui/co.cafeyn.cgs.api.foundation.design/CgsColors

CgsColors

class CgsColors(val foreground: CgsColors.Foreground, val border: CgsColors.Border, val background: CgsColors.Background, val surface: CgsColors.Surface, val floating: CgsColors.Floating, val buttons: CgsColors.Buttons, val brand: CgsColors.Brand)

The full color palette of the design system, grouped by the semantic groups.

Each group is a small immutable set of tokens; in the schemes the SDK builds, the brand-* tokens of foreground, border and surface are fed by the brand set, which is the only layer that changes per flavour.

Constructors

CgsColors

constructor(foreground: CgsColors.Foreground, border: CgsColors.Border, background: CgsColors.Background, surface: CgsColors.Surface, floating: CgsColors.Floating, buttons: CgsColors.Buttons, brand: CgsColors.Brand)

Types

Background

@Immutable

class Background(val default: Color, val subtle: Color)

Background colors (the page background).

Border

@Immutable

class Border(val emphasized: Color, val moderate: Color, val subtle: Color, val brand: Color, val brandSoft: Color, val brandMedium: Color, val brandStrong: Color, val brandAccent: Color, val success: Color, val error: Color, val warning: Color, val info: Color, val disabled: Color)

Border colors.

Brand

@Immutable

class Brand(val brand: Color, val soft: Color, val medium: Color, val strong: Color, val accent: Color, val onBrand: Color, val onSoft: Color, val onMedium: Color, val onStrong: Color, val onAccent: Color)

The Brand color set.

Buttons

@Immutable

class Buttons(val primary: Color, val secondary: Color, val tertiary: Color, val success: Color, val error: Color, val warning: Color, val info: Color, val disabled: Color)

Button surface colors.

Floating

@Immutable

class Floating(val default: Color)

Floating surface color (floating panels, sheets over content).

Foreground

@Immutable

class Foreground(val emphasized: Color, val moderate: Color, val subtle: Color, val neutral: Color, val brand: Color, val brandSoft: Color, val brandMedium: Color, val brandStrong: Color, val brandAccent: Color, val onBrand: Color, val onBrandSoft: Color, val onBrandMedium: Color, val onBrandStrong: Color, val onBrandAccent: Color, val success: Color, val warning: Color, val error: Color, val info: Color, val disabled: Color)

Foreground colors (text and icon tint).

Surface

@Immutable

class Surface(val primary: Color, val secondary: Color, val tertiary: Color, val brand: Color, val brandSoft: Color, val brandMedium: Color, val brandStrong: Color, val brandAccent: Color, val success: Color, val error: Color, val warning: Color, val info: Color)

Surface colors (cards, containers, buttons-as-surface).