Colors

Artifact: androidx.compose.material:material

View Source

Added in 1.0.0

Common/AllAndroid/JVM

• Cmn

  class Colors

---

Material Design color system.

The Material Design color system can help you create a color theme that reflects your brand or style.

To create a light set of colors using the baseline values, use lightColors To create a dark set of colors using the baseline values, use darkColors

Summary

Public constructors
Colors(     primary: Color,     primaryVariant: Color,     secondary: Color,     secondaryVariant: Color,     background: Color,     surface: Color,     error: Color,     onPrimary: Color,     onSecondary: Color,     onBackground: Color,     onSurface: Color,     onError: Color,     isLight: Boolean )	Cmn

Public functions
Colors	copy(     primary: Color,     primaryVariant: Color,     secondary: Color,     secondaryVariant: Color,     background: Color,     surface: Color,     error: Color,     onPrimary: Color,     onSecondary: Color,     onBackground: Color,     onSurface: Color,     onError: Color,     isLight: Boolean ) Returns a copy of this Colors, optionally overriding some of the values.	Cmn
open String	toString()	Cmn

Public properties
Color	background The background color appears behind scrollable content.	Cmn
Color	error The error color is used to indicate error within components, such as text fields.	Cmn
Boolean	isLight Whether this Colors is considered as a 'light' or 'dark' set of colors.	Cmn
Color	onBackground Color used for text and icons displayed on top of the background color.	Cmn
Color	onError Color used for text and icons displayed on top of the error color.	Cmn
Color	onPrimary Color used for text and icons displayed on top of the primary color.	Cmn
Color	onSecondary Color used for text and icons displayed on top of the secondary color.	Cmn
Color	onSurface Color used for text and icons displayed on top of the surface color.	Cmn
Color	primary The primary color is the color displayed most frequently across your app’s screens and components.	Cmn
Color	primaryVariant 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.	Cmn
Color	secondary The secondary color provides more ways to accent and distinguish your product.	Cmn
Color	secondaryVariant The secondary variant color is used to distinguish two elements of the app using the secondary color.	Cmn
Color	surface The surface color is used on surfaces of components, such as cards, sheets and menus.	Cmn

Extension functions
Color	Colors.contentColorFor(backgroundColor: Color) The Material color system contains pairs of colors that are typically used for the background and content color inside a component.	Cmn

Extension properties
Color	Colors.primarySurface 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.	Cmn

Public constructors

Colors

Cmn

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

Public functions

copy

Cmn

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.

toString

Cmn

open fun toString(): String

Public properties

background

Cmn

Added in 1.0.0

val background: Color

The background color appears behind scrollable content.

error

Cmn

Added in 1.0.0

val error: Color

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

isLight

Cmn

Added in 1.0.0

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.

onBackground

Cmn

Added in 1.0.0

val onBackground: Color

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

onError

Cmn

Added in 1.0.0

val onError: Color

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

onPrimary

Cmn

Added in 1.0.0

val onPrimary: Color

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

onSecondary

Cmn

Added in 1.0.0

val onSecondary: Color

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

onSurface

Cmn

Added in 1.0.0

val onSurface: Color

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

primary

Cmn

Added in 1.0.0

val primary: Color

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

primaryVariant

Cmn

Added in 1.0.0

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.

secondary

Cmn

Added in 1.0.0

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

secondaryVariant

Cmn

Added in 1.0.0

val secondaryVariant: Color

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

surface

Cmn

Added in 1.0.0

val surface: Color

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

Extension functions

contentColorFor

Cmn

Artifact: androidx.compose.material:material

View Source

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.

Returns
Color	the matching content color for backgroundColor. If backgroundColor is not present in the theme's Colors, then returns Color.Unspecified.

See also
contentColorFor

Extension properties

primarySurface

Cmn

Artifact: androidx.compose.material:material

View Source

Added in 1.0.0

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.

Returns
Color	Colors.primary if in light theme, else Colors.surface