ColorScheme

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,
    outline: Color = this.outline,
    outlineVariant: Color = this.outlineVariant,
    scrim: Color = this.scrim,
    surfaceBright: Color = this.surfaceBright,
    surfaceDim: Color = this.surfaceDim,
    surfaceContainer: Color = this.surfaceContainer,
    surfaceContainerHigh: Color = this.surfaceContainerHigh,
    surfaceContainerHighest: Color = this.surfaceContainerHighest,
    surfaceContainerLow: Color = this.surfaceContainerLow,
    surfaceContainerLowest: Color = this.surfaceContainerLowest,
    primaryFixed: Color = this.primaryFixed,
    primaryFixedDim: Color = this.primaryFixedDim,
    onPrimaryFixed: Color = this.onPrimaryFixed,
    onPrimaryFixedVariant: Color = this.onPrimaryFixedVariant,
    secondaryFixed: Color = this.secondaryFixed,
    secondaryFixedDim: Color = this.secondaryFixedDim,
    onSecondaryFixed: Color = this.onSecondaryFixed,
    onSecondaryFixedVariant: Color = this.onSecondaryFixedVariant,
    tertiaryFixed: Color = this.tertiaryFixed,
    tertiaryFixedDim: Color = this.tertiaryFixedDim,
    onTertiaryFixed: Color = this.onTertiaryFixed,
    onTertiaryFixedVariant: Color = this.onTertiaryFixedVariant
): ColorScheme

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

val background: Color

The background color that appears behind scrollable content.

val error: Color

The error color is used to indicate errors in components, such as invalid text in a text field.

val errorContainer: Color

The preferred tonal color of error containers.

val inverseOnSurface: Color

A color that contrasts well with inverseSurface. Useful for content that sits on top of containers that are inverseSurface.

val inversePrimary: Color

Color to be used as a "primary" color in places where the inverse color scheme is needed, such as the button on a SnackBar.

val inverseSurface: Color

A color that contrasts sharply with surface. Useful for surfaces that sit on top of other surfaces with surface 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

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

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 onPrimaryFixed: Color

Color used for text and icons displayed on top of primaryFixed or primaryFixedDim. Maintains the same tone in light and dark themes.

val onPrimaryFixedVariant: Color

An onPrimaryFixed variant which provides less emphasis. Useful when a strong contrast is not required.

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 onSecondaryFixed: Color

Color used for text and icons displayed on top of secondaryFixed or secondaryFixedDim. Maintains the same tone in light and dark themes.

val onSecondaryFixedVariant: Color

An onSecondaryFixed variant which provides less emphasis. Useful when a strong contrast is not required.

val onSurface: Color

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

val onSurfaceVariant: Color

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

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 onTertiaryFixed: Color

Color used for text and icons displayed on top of tertiaryFixed or tertiaryFixedDim. Maintains the same tone in light and dark themes.

val onTertiaryFixedVariant: Color

An onTertiaryFixed variant which provides less emphasis. Useful when a strong contrast is not required.

val outline: Color

Subtle color used for boundaries. Outline color role adds contrast for accessibility purposes.

val outlineVariant: Color

Utility color used for boundaries for decorative elements when strong contrast is not required.

val primary: Color

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

val primaryContainer: Color

The preferred tonal color of containers.

val primaryFixed: Color

A primary variant that maintains the same tone in light and dark themes. The fixed color role may be used instead of the equivalent container role in situations where such fixed behavior is desired.

val primaryFixedDim: Color

A primary variant that maintains the same tone in light and dark themes. Dim roles provide a stronger, more emphasized tone relative to the equivalent fixed color.

val scrim: Color

Color of a scrim that obscures content.

val secondary: Color

The secondary color provides more ways to accent and distinguish your product. Secondary colors are best for:

• Floating action buttons

• Selection controls, like checkboxes and radio buttons

• Highlighting selected text

• Links and headlines

val secondaryContainer: Color

A tonal color to be used in containers.

val secondaryFixed: Color

A secondary variant that maintains the same tone in light and dark themes. The fixed color role may be used instead of the equivalent container role in situations where such fixed behavior is desired.

val secondaryFixedDim: Color

A secondary variant that maintains the same tone in light and dark themes. Dim roles provide a stronger, more emphasized tone relative to the equivalent fixed color.

val surface: Color

The surface color that affect surfaces of components, such as cards, sheets, and menus.

val surfaceBright: Color

A surface variant that is always brighter than surface, whether in light or dark mode.

val surfaceContainer: Color

A surface variant that affects containers of components, such as cards, sheets, and menus.

val surfaceContainerHigh: Color

A surface variant for containers with higher emphasis than surfaceContainer. Use this role for content which requires more emphasis than surfaceContainer.

val surfaceContainerHighest: Color

A surface variant for containers with higher emphasis than surfaceContainerHigh. Use this role for content which requires more emphasis than surfaceContainerHigh.

val surfaceContainerLow: Color

A surface variant for containers with lower emphasis than surfaceContainer. Use this role for content which requires less emphasis than surfaceContainer.

val surfaceContainerLowest: Color

A surface variant for containers with lower emphasis than surfaceContainerLow. Use this role for content which requires less emphasis than surfaceContainerLow.

val surfaceDim: Color

A surface variant that is always dimmer than surface, whether in light or dark mode.

val surfaceTint: Color

This color will be used by components that apply tonal elevation and is applied on top of surface. The higher the elevation the more this color is used.

val surfaceVariant: Color

Another option for a color with similar uses of surface.

val tertiary: Color

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

val tertiaryContainer: Color

A tonal color to be used in containers.

val tertiaryFixed: Color

A tertiary variant that maintains the same tone in light and dark themes. The fixed color role may be used instead of the equivalent container role in situations where such fixed behavior is desired.

val tertiaryFixedDim: Color

A tertiary variant that maintains the same tone in light and dark themes. Dim roles provide a stronger, more emphasized tone relative to the equivalent fixed color.

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.

fun ColorScheme.surfaceColorAtElevation(elevation: Dp): Color

Computes the surface tonal color at different elevation levels e.g. surface1 through surface5.