ColorScheme

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

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,
    onError: Color = this.onError,
    errorContainer: Color = this.errorContainer,
    onErrorContainer: Color = this.onErrorContainer
): ColorScheme

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

open fun toString(): String

val background: Color

The background color that appears behind other content.

val error: Color

Color that indicates remove, delete, close or dismiss actions, such as Swipe to Reveal. Added as an errorContainer alternative that is slightly less alarming and urgent color.

val errorContainer: Color

Color that indicates errors or emergency actions, such as safety alerts. This color is for use-cases that are more alarming and urgent than the error color.

val onBackground: Color

Color used for text and icons displayed on top of the background color.

val onError: Color

Color used for text and icons displayed on top of the error color.

val onErrorContainer: Color

Color used for text and icons on the errorContainer color.

val onPrimary: Color

Color used for text and icons displayed on top of the primary color.

val onPrimaryContainer: Color

The color (and state variants) that should be used for content on top of primaryContainer.

val onSecondary: Color

Color used for text and icons displayed on top of the secondary color.

val onSecondaryContainer: Color

The color (and state variants) that should be used for content on top of secondaryContainer.

val onSurface: Color

Color used for text and icons displayed on top of the surface color.

val onSurfaceVariant: Color

The color for secondary text and icons on top of surfaceContainer.

val onTertiary: Color

Color used for text and icons displayed on top of the tertiary color.

val onTertiaryContainer: Color

The color (and state variants) that should be used for content on top of tertiaryContainer.

val outline: Color

The main color for primary outline components. The outline color role adds contrast for accessibility purposes.

val outlineVariant: Color

The secondary color for secondary outline components.

val primary: Color

The primary color is the color displayed most frequently across your app’s screens and components.

val primaryContainer: Color

is a standout container color for key components.

val primaryDim: Color

is less prominent than primary for component backgrounds

val secondary: Color

The secondary color provides more ways to accent and distinguish your product.

val secondaryContainer: Color

A tonal color to be used in containers.

val secondaryDim: Color

is less prominent than secondary for component backgrounds.

val surfaceContainer: Color

The main surface color that affect surfaces of components with large containment areas, such as Card and Button.

val surfaceContainerHigh: Color

A surface color used for large containment components such Card and Button with high prominence.

val surfaceContainerLow: Color

A surface color used for large containment components such as Card and Button with low prominence.

val tertiary: Color

The tertiary color that can be used to balance primary and secondary colors, or bring heightened attention to an element.

val tertiaryContainer: Color

A tonal color to be used in containers.

val tertiaryDim: Color

A less prominent tertiary color that can be used to balance primary and secondary colors, or bring heightened attention to an element.

fun ColorScheme.contentColorFor(backgroundColor: Color): Color

The Material color system contains pairs of colors that are typically used for the background and content color inside a component. For example, a Button typically uses primary for its background, and onPrimary for the color of its content (usually text or iconography).

This function tries to match the provided backgroundColor to a 'background' color in this ColorScheme, and then will return the corresponding color used for content. For example, when backgroundColor is ColorScheme.primary, this will return ColorScheme.onPrimary.

If backgroundColor does not match a background color in the theme, this will return Color.Unspecified.