Colors

fun copy(
    primary: Color = this.primary,
    primaryVariant: Color = this.primaryVariant,
    secondary: Color = this.secondary,
    secondaryVariant: Color = this.secondaryVariant,
    background: Color = this.background,
    surface: Color = this.surface,
    error: Color = this.error,
    onPrimary: Color = this.onPrimary,
    onSecondary: Color = this.onSecondary,
    onBackground: Color = this.onBackground,
    onSurface: Color = this.onSurface,
    onError: Color = this.onError,
    isLight: Boolean = this.isLight
): Colors

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

val background: Color

The background color appears behind scrollable content.

val error: Color

The error color is used to indicate error within components, such as text fields.

val isLight: Boolean

Whether this Colors is considered as a 'light' or 'dark' set of colors. This affects default behavior for some components: for example, in a light theme a TopAppBar will use primary by default for its background color, when in a dark theme it will use surface.

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

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

val onSecondary: Color

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

val onSurface: Color

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

val primary: Color

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

val primaryVariant: Color

The primary variant color is used to distinguish two elements of the app using the primary color, such as the top app bar and the system bar.

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

The secondary variant color is used to distinguish two elements of the app using the secondary color.

val surface: Color

The surface color is used on surfaces of components, such as cards, sheets and menus.

fun Colors.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 Colors, and then will return the corresponding color used for content. For example, when backgroundColor is Colors.primary, this will return Colors.onPrimary.

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

val Colors.primarySurface: Color

primarySurface represents the background color of components that are Colors.primary in light theme, and Colors.surface in dark theme, such as androidx.compose.material.TabRow and androidx.compose.material.TopAppBar. This is to reduce brightness of large surfaces in dark theme, aiding contrast and readability. See Dark Theme.