Class

ColorScheme

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

Source set: Android
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

Source set: Android
var primary by mutableStateOf(primary, structuralEqualityPolicy())

onPrimary

Source set: Android
var onPrimary by mutableStateOf(onPrimary, structuralEqualityPolicy())

primaryContainer

Source set: Android
var primaryContainer by mutableStateOf(primaryContainer, structuralEqualityPolicy())

onPrimaryContainer

Source set: Android
var onPrimaryContainer by mutableStateOf(onPrimaryContainer, structuralEqualityPolicy())

inversePrimary

Source set: Android
var inversePrimary by mutableStateOf(inversePrimary, structuralEqualityPolicy())

secondary

Source set: Android
var secondary by mutableStateOf(secondary, structuralEqualityPolicy())

onSecondary

Source set: Android
var onSecondary by mutableStateOf(onSecondary, structuralEqualityPolicy())

secondaryContainer

Source set: Android
var secondaryContainer by mutableStateOf(secondaryContainer, structuralEqualityPolicy())

onSecondaryContainer

Source set: Android
var onSecondaryContainer by mutableStateOf(onSecondaryContainer, structuralEqualityPolicy())

tertiary

Source set: Android
var tertiary by mutableStateOf(tertiary, structuralEqualityPolicy())

onTertiary

Source set: Android
var onTertiary by mutableStateOf(onTertiary, structuralEqualityPolicy())

tertiaryContainer

Source set: Android
var tertiaryContainer by mutableStateOf(tertiaryContainer, structuralEqualityPolicy())

onTertiaryContainer

Source set: Android
var onTertiaryContainer by mutableStateOf(onTertiaryContainer, structuralEqualityPolicy())

background

Source set: Android
var background by mutableStateOf(background, structuralEqualityPolicy())

onBackground

Source set: Android
var onBackground by mutableStateOf(onBackground, structuralEqualityPolicy())

surface

Source set: Android
var surface by mutableStateOf(surface, structuralEqualityPolicy())

onSurface

Source set: Android
var onSurface by mutableStateOf(onSurface, structuralEqualityPolicy())

surfaceVariant

Source set: Android
var surfaceVariant by mutableStateOf(surfaceVariant, structuralEqualityPolicy())

onSurfaceVariant

Source set: Android
var onSurfaceVariant by mutableStateOf(onSurfaceVariant, structuralEqualityPolicy())

surfaceTint

Source set: Android
var surfaceTint by mutableStateOf(surfaceTint, structuralEqualityPolicy())

inverseSurface

Source set: Android
var inverseSurface by mutableStateOf(inverseSurface, structuralEqualityPolicy())

inverseOnSurface

Source set: Android
var inverseOnSurface by mutableStateOf(inverseOnSurface, structuralEqualityPolicy())

error

Source set: Android
var error by mutableStateOf(error, structuralEqualityPolicy())

onError

Source set: Android
var onError by mutableStateOf(onError, structuralEqualityPolicy())

errorContainer

Source set: Android
var errorContainer by mutableStateOf(errorContainer, structuralEqualityPolicy())

onErrorContainer

Source set: Android
var onErrorContainer by mutableStateOf(onErrorContainer, structuralEqualityPolicy())

border

Source set: Android
var border by mutableStateOf(border, structuralEqualityPolicy())

borderVariant

Source set: Android
var borderVariant by mutableStateOf(borderVariant, structuralEqualityPolicy())

scrim

Source set: Android
var scrim by mutableStateOf(scrim, structuralEqualityPolicy())

Functions

copy

Source set: Android
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

Source set: Android
override fun toString(): String
Jetpack Compose beyond MaterialFree components, screens and templates for apps that don’t look like Google’s. Copy them into your app, or let your coding agent add them.Browse for free

Content updated: