ColorScheme

class ColorScheme(
    primary: Color,
    onPrimary: Color,
    primaryContainer: Color,
    onPrimaryContainer: Color,
    inversePrimary: Color,
    secondary: Color,
    onSecondary: Color,
    secondaryContainer: Color,
    onSecondaryContainer: Color,
    tertiary: Color,
    onTertiary: Color,
    tertiaryContainer: Color,
    onTertiaryContainer: Color,
    background: Color,
    onBackground: Color,
    surface: Color,
    onSurface: Color,
    surfaceVariant: Color,
    onSurfaceVariant: Color,
    surfaceTint: Color,
    inverseSurface: Color,
    inverseOnSurface: Color,
    error: Color,
    onError: Color,
    errorContainer: Color,
    onErrorContainer: Color,
    border: Color,
    borderVariant: Color,
    scrim: Color,
)

A color scheme 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. There are two built-in baseline schemes, lightColorScheme and a darkColorScheme, that can be used as-is or customized.

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

To learn more about colors, see Material Design colors.

Properties

primary

var primary by mutableStateOf(primary, structuralEqualityPolicy())

onPrimary

var onPrimary by mutableStateOf(onPrimary, structuralEqualityPolicy())

primaryContainer

var primaryContainer by mutableStateOf(primaryContainer, structuralEqualityPolicy())

onPrimaryContainer

var onPrimaryContainer by mutableStateOf(onPrimaryContainer, structuralEqualityPolicy())

inversePrimary

var inversePrimary by mutableStateOf(inversePrimary, structuralEqualityPolicy())

secondary

var secondary by mutableStateOf(secondary, structuralEqualityPolicy())

onSecondary

var onSecondary by mutableStateOf(onSecondary, structuralEqualityPolicy())

secondaryContainer

var secondaryContainer by mutableStateOf(secondaryContainer, structuralEqualityPolicy())

onSecondaryContainer

var onSecondaryContainer by mutableStateOf(onSecondaryContainer, structuralEqualityPolicy())

tertiary

var tertiary by mutableStateOf(tertiary, structuralEqualityPolicy())

onTertiary

var onTertiary by mutableStateOf(onTertiary, structuralEqualityPolicy())

tertiaryContainer

var tertiaryContainer by mutableStateOf(tertiaryContainer, structuralEqualityPolicy())

onTertiaryContainer

var onTertiaryContainer by mutableStateOf(onTertiaryContainer, structuralEqualityPolicy())

background

var background by mutableStateOf(background, structuralEqualityPolicy())

onBackground

var onBackground by mutableStateOf(onBackground, structuralEqualityPolicy())

surface

var surface by mutableStateOf(surface, structuralEqualityPolicy())

onSurface

var onSurface by mutableStateOf(onSurface, structuralEqualityPolicy())

surfaceVariant

var surfaceVariant by mutableStateOf(surfaceVariant, structuralEqualityPolicy())

onSurfaceVariant

var onSurfaceVariant by mutableStateOf(onSurfaceVariant, structuralEqualityPolicy())

surfaceTint

var surfaceTint by mutableStateOf(surfaceTint, structuralEqualityPolicy())

inverseSurface

var inverseSurface by mutableStateOf(inverseSurface, structuralEqualityPolicy())

inverseOnSurface

var inverseOnSurface by mutableStateOf(inverseOnSurface, structuralEqualityPolicy())

error

var error by mutableStateOf(error, structuralEqualityPolicy())

onError

var onError by mutableStateOf(onError, structuralEqualityPolicy())

errorContainer

var errorContainer by mutableStateOf(errorContainer, structuralEqualityPolicy())

onErrorContainer

var onErrorContainer by mutableStateOf(onErrorContainer, structuralEqualityPolicy())

border

var border by mutableStateOf(border, structuralEqualityPolicy())

borderVariant

var borderVariant by mutableStateOf(borderVariant, structuralEqualityPolicy())

scrim

var scrim by mutableStateOf(scrim, structuralEqualityPolicy())

Functions

copy

fun copy(
        primary: Color = this.primary,
        onPrimary: Color = this.onPrimary,
        primaryContainer: Color = this.primaryContainer,
        onPrimaryContainer: Color = this.onPrimaryContainer,
        inversePrimary: Color = this.inversePrimary,
        secondary: Color = this.secondary,
        onSecondary: Color = this.onSecondary,
        secondaryContainer: Color = this.secondaryContainer,
        onSecondaryContainer: Color = this.onSecondaryContainer,
        tertiary: Color = this.tertiary,
        onTertiary: Color = this.onTertiary,
        tertiaryContainer: Color = this.tertiaryContainer,
        onTertiaryContainer: Color = this.onTertiaryContainer,
        background: Color = this.background,
        onBackground: Color = this.onBackground,
        surface: Color = this.surface,
        onSurface: Color = this.onSurface,
        surfaceVariant: Color = this.surfaceVariant,
        onSurfaceVariant: Color = this.onSurfaceVariant,
        surfaceTint: Color = this.surfaceTint,
        inverseSurface: Color = this.inverseSurface,
        inverseOnSurface: Color = this.inverseOnSurface,
        error: Color = this.error,
        onError: Color = this.onError,
        errorContainer: Color = this.errorContainer,
        onErrorContainer: Color = this.onErrorContainer,
        border: Color = this.border,
        borderVariant: Color = this.borderVariant,
        scrim: Color = this.scrim,
    ): ColorScheme

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

toString

override fun toString(): String