Cafeyn Group SDK

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

Foreground

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).

Constructors

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

Properties

val brand: Color

Text and icons tinted with the brand — a link, an active tab label.

val brandAccent: Color

Accent foreground, for the one thing on screen that should catch the eye.

val brandMedium: Color

Brand foreground at its middle tone.

val brandSoft: Color

Brand foreground at its lightest tone — its darkest in a dark scheme.

val brandStrong: Color

Brand foreground at its darkest tone — its lightest in a dark scheme — for text that needs to hold contrast on the page's surfaces.

val disabled: Color

Content of a control that cannot be used.

val emphasized: Color

Titles, body text and icons that carry the message. The highest-contrast foreground.

val error: Color

Text and icons reporting a failure.

val info: Color

Text and icons carrying neutral information.

val moderate: Color

Secondary text: subtitles, metadata, supporting labels.

val neutral: Color

Content sitting on a filled control, such as a Buttons.primary button. The same color as the page background, so not for text on the page itself.

val onBrand: Color

Content sitting on Surface.brand.

val onBrandAccent: Color

Content sitting on Surface.brandAccent.

val onBrandMedium: Color

Content sitting on Surface.brandMedium.

val onBrandSoft: Color

Content sitting on Surface.brandSoft.

val onBrandStrong: Color

Content sitting on Surface.brandStrong.

val subtle: Color

Tertiary text: captions, timestamps, hints. The lowest-contrast foreground still meant to be read.

val success: Color

Text and icons reporting that something worked.

val warning: Color

Text and icons reporting something that needs attention but is not a failure.