ColorScheme

Artifact: androidx.wear.protolayout:protolayout-material3

Kotlin |Java

class ColorScheme

A ColorScheme 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.

The Material color system and custom schemes provide default values for color as a starting point for customization.

To learn more about color schemes, see Material Design Color System.

Summary

Public constructors
ColorScheme( primary: LayoutColor, primaryDim: LayoutColor, primaryContainer: LayoutColor, onPrimary: LayoutColor, onPrimaryContainer: LayoutColor, secondary: LayoutColor, secondaryDim: LayoutColor, secondaryContainer: LayoutColor, onSecondary: LayoutColor, onSecondaryContainer: LayoutColor, tertiary: LayoutColor, tertiaryDim: LayoutColor, tertiaryContainer: LayoutColor, onTertiary: LayoutColor, onTertiaryContainer: LayoutColor, surfaceContainerLow: LayoutColor, surfaceContainer: LayoutColor, surfaceContainerHigh: LayoutColor, onSurface: LayoutColor, onSurfaceVariant: LayoutColor, outline: LayoutColor, outlineVariant: LayoutColor, background: LayoutColor, onBackground: LayoutColor, error: LayoutColor, onError: LayoutColor, errorContainer: LayoutColor, onErrorContainer: LayoutColor )

Public constructors

ColorScheme(
    primary: LayoutColor,
    primaryDim: LayoutColor,
    primaryContainer: LayoutColor,
    onPrimary: LayoutColor,
    onPrimaryContainer: LayoutColor,
    secondary: LayoutColor,
    secondaryDim: LayoutColor,
    secondaryContainer: LayoutColor,
    onSecondary: LayoutColor,
    onSecondaryContainer: LayoutColor,
    tertiary: LayoutColor,
    tertiaryDim: LayoutColor,
    tertiaryContainer: LayoutColor,
    onTertiary: LayoutColor,
    onTertiaryContainer: LayoutColor,
    surfaceContainerLow: LayoutColor,
    surfaceContainer: LayoutColor,
    surfaceContainerHigh: LayoutColor,
    onSurface: LayoutColor,
    onSurfaceVariant: LayoutColor,
    outline: LayoutColor,
    outlineVariant: LayoutColor,
    background: LayoutColor,
    onBackground: LayoutColor,
    error: LayoutColor,
    onError: LayoutColor,
    errorContainer: LayoutColor,
    onErrorContainer: LayoutColor
)

Public properties
`LayoutColor`	`background` color that appears behind other content
`LayoutColor`	`error` color that indicates remove, delete, close or dismiss actions.
`LayoutColor`	`errorContainer` is color that indicates errors or emergency actions, such as safety alerts.
`LayoutColor`	`onBackground` color is used for text and icons displayed on top of the background color
`LayoutColor`	`onError` color is used for text and icons displayed on top of the error color
`LayoutColor`	`onErrorContainer` is color used for text and icons on the errorContainer color
`LayoutColor`	`onPrimary` color is used for text and icons displayed on top of the primary color
`LayoutColor`	`onPrimaryContainer` color (and state variants) that should be used for content on top of `primaryContainer`
`LayoutColor`	`onSecondary` color is used for text and icons displayed on top of the secondary color
`LayoutColor`	`onSecondaryContainer` color (and state variants) should be used for content on top of `secondaryContainer`
`LayoutColor`	`onSurface` color is used for text and icons displayed on top of the surface color
`LayoutColor`	`onSurfaceVariant` is the color for secondary text and icons on top of `surfaceContainer`
`LayoutColor`	`onTertiary` color is used for text and icons displayed on top of the tertiary color
`LayoutColor`	`onTertiaryContainer` color (and state variants) that should be used for content on top of `tertiaryContainer`
`LayoutColor`	`outline` is the main color for primary outline components.
`LayoutColor`	`outlineVariant` is the secondary color for secondary outline components
`LayoutColor`	`primary` is the color displayed most frequently across your app’s screens and components
`LayoutColor`	`primaryContainer` is a standout container color for key components
`LayoutColor`	`primaryDim` is less prominent than `primary` for component backgrounds
`LayoutColor`	`secondary` color provides more ways to accent and distinguish your product
`LayoutColor`	`secondaryContainer` is a tonal color to be used in containers
`LayoutColor`	`secondaryDim` is less prominent than `secondary` for component backgrounds
`LayoutColor`	`surfaceContainer` is the main surface color that affect surfaces of components with large containment areas, such as Card and Button
`LayoutColor`	`surfaceContainerHigh` is a surface color used for large containment components such Card and Button with high prominence
`LayoutColor`	`surfaceContainerLow` is a surface color used for large containment components such as Card and Button with low prominence
`LayoutColor`	`tertiary` color that can be used to balance primary and secondary colors, or bring heightened attention to an element
`LayoutColor`	`tertiaryContainer` is a tonal color to be used in containers
`LayoutColor`	`tertiaryDim` is a less prominent tertiary color that can be used to balance primary and secondary colors, or bring heightened attention to an element

Public constructors

ColorScheme

Added in 1.3.0-alpha06

ColorScheme(
    primary: LayoutColor = ColorTokens.PRIMARY.argb,
    primaryDim: LayoutColor = ColorTokens.PRIMARY_DIM.argb,
    primaryContainer: LayoutColor = ColorTokens.PRIMARY_CONTAINER.argb,
    onPrimary: LayoutColor = ColorTokens.ON_PRIMARY.argb,
    onPrimaryContainer: LayoutColor = ColorTokens.ON_PRIMARY_CONTAINER.argb,
    secondary: LayoutColor = ColorTokens.SECONDARY.argb,
    secondaryDim: LayoutColor = ColorTokens.SECONDARY_DIM.argb,
    secondaryContainer: LayoutColor = ColorTokens.SECONDARY_CONTAINER.argb,
    onSecondary: LayoutColor = ColorTokens.ON_SECONDARY.argb,
    onSecondaryContainer: LayoutColor = ColorTokens.ON_SECONDARY_CONTAINER.argb,
    tertiary: LayoutColor = ColorTokens.TERTIARY.argb,
    tertiaryDim: LayoutColor = ColorTokens.TERTIARY_DIM.argb,
    tertiaryContainer: LayoutColor = ColorTokens.TERTIARY_CONTAINER.argb,
    onTertiary: LayoutColor = ColorTokens.ON_TERTIARY.argb,
    onTertiaryContainer: LayoutColor = ColorTokens.ON_TERTIARY_CONTAINER.argb,
    surfaceContainerLow: LayoutColor = ColorTokens.SURFACE_CONTAINER_LOW.argb,
    surfaceContainer: LayoutColor = ColorTokens.SURFACE_CONTAINER.argb,
    surfaceContainerHigh: LayoutColor = ColorTokens.SURFACE_CONTAINER_HIGH.argb,
    onSurface: LayoutColor = ColorTokens.ON_SURFACE.argb,
    onSurfaceVariant: LayoutColor = ColorTokens.ON_SURFACE_VARIANT.argb,
    outline: LayoutColor = ColorTokens.OUTLINE.argb,
    outlineVariant: LayoutColor = ColorTokens.OUTLINE_VARIANT.argb,
    background: LayoutColor = ColorTokens.BACKGROUND.argb,
    onBackground: LayoutColor = ColorTokens.ON_BACKGROUND.argb,
    error: LayoutColor = ColorTokens.ERROR.argb,
    onError: LayoutColor = ColorTokens.ON_ERROR.argb,
    errorContainer: LayoutColor = ColorTokens.ERROR_CONTAINER.argb,
    onErrorContainer: LayoutColor = ColorTokens.ON_ERROR_CONTAINER.argb
)

Public properties

background

Added in 1.3.0-alpha06

val background: LayoutColor

color that appears behind other content

error

Added in 1.3.0-alpha06

val error: LayoutColor

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

errorContainer

Added in 1.3.0-alpha06

val errorContainer: LayoutColor

is 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.