ColorScheme

Class

Android
public class ColorScheme(
    public val primary: Color = ColorTokens.Primary,
    public val primaryDim: Color = ColorTokens.PrimaryDim,
    public val primaryContainer: Color = ColorTokens.PrimaryContainer,
    public val onPrimary: Color = ColorTokens.OnPrimary,
    public val onPrimaryContainer: Color = ColorTokens.OnPrimaryContainer,
    public val secondary: Color = ColorTokens.Secondary,
    public val secondaryDim: Color = ColorTokens.SecondaryDim,
    public val secondaryContainer: Color = ColorTokens.SecondaryContainer,
    public val onSecondary: Color = ColorTokens.OnSecondary,
    public val onSecondaryContainer: Color = ColorTokens.OnSecondaryContainer,
    public val tertiary: Color = ColorTokens.Tertiary,
    public val tertiaryDim: Color = ColorTokens.TertiaryDim,
    public val tertiaryContainer: Color = ColorTokens.TertiaryContainer,
    public val onTertiary: Color = ColorTokens.OnTertiary,
    public val onTertiaryContainer: Color = ColorTokens.OnTertiaryContainer,
    public val surfaceContainerLow: Color = ColorTokens.SurfaceContainerLow,
    public val surfaceContainer: Color = ColorTokens.SurfaceContainer,
    public val surfaceContainerHigh: Color = ColorTokens.SurfaceContainerHigh,
    public val onSurface: Color = ColorTokens.OnSurface,
    public val onSurfaceVariant: Color = ColorTokens.OnSurfaceVariant,
    public val outline: Color = ColorTokens.Outline,
    public val outlineVariant: Color = ColorTokens.OutlineVariant,
    public val background: Color = ColorTokens.Background,
    public val onBackground: Color = ColorTokens.OnBackground,
    public val error: Color = ColorTokens.Error,
    public val errorDim: Color = ColorTokens.ErrorDim,
    public val errorContainer: Color = ColorTokens.ErrorContainer,
    public val onError: Color = ColorTokens.OnError,
    public val onErrorContainer: Color = ColorTokens.OnErrorContainer,
)

A ColorScheme holds all the named color parameters for a MaterialTheme.

Color schemes are designed to be harmonious, ensure accessible text, and distinguish UI elements and surfaces from one another.

The Material color system and custom schemes provide default values for color as a starting point for customization.

To learn more about color schemes, see Material Design Color System(https://m3.material.io/styles/color/the-color-system/color-roles).

Functions

public fun copy(
        primary: Color = this.primary,
        primaryDim: Color = this.primaryDim,
        primaryContainer: Color = this.primaryContainer,
        onPrimary: Color = this.onPrimary,
        onPrimaryContainer: Color = this.onPrimaryContainer,
        secondary: Color = this.secondary,
        secondaryDim: Color = this.secondaryDim,
        secondaryContainer: Color = this.secondaryContainer,
        onSecondary: Color = this.onSecondary,
        onSecondaryContainer: Color = this.onSecondaryContainer,
        tertiary: Color = this.tertiary,
        tertiaryDim: Color = this.tertiaryDim,
        tertiaryContainer: Color = this.tertiaryContainer,
        onTertiary: Color = this.onTertiary,
        onTertiaryContainer: Color = this.onTertiaryContainer,
        surfaceContainerLow: Color = this.surfaceContainerLow,
        surfaceContainer: Color = this.surfaceContainer,
        surfaceContainerHigh: Color = this.surfaceContainerHigh,
        onSurface: Color = this.onSurface,
        onSurfaceVariant: Color = this.onSurfaceVariant,
        outline: Color = this.outline,
        outlineVariant: Color = this.outlineVariant,
        background: Color = this.background,
        onBackground: Color = this.onBackground,
        error: Color = this.error,
        errorDim: Color = this.errorDim,
        errorContainer: Color = this.errorContainer,
        onError: Color = this.onError,
        onErrorContainer: Color = this.onErrorContainer,
    ): ColorScheme

Returns a copy of this Colors, optionally overriding some of the values.