class RemoteColorScheme


Represents the color scheme for the Wear Material 3 theme in a remote context.

A RemoteColorScheme holds RemoteColor parameters for a RemoteMaterialTheme, mapping to the standard Material Design 3 color roles for Wearables.

Color schemes are designed to be harmonious, ensure accessible text, and distinguish UI elements and surfaces from one another.

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

Summary

Public constructors

Creates a RemoteColorScheme from a standard ColorScheme.

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

Public functions

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

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

Public properties

RemoteColor

The background color that appears behind other content.

RemoteColor

Color that indicates remove, delete, close or dismiss actions, such as Swipe to Reveal.

RemoteColor

A less prominent container color than error, for components using the error state.

RemoteColor

Indicates high priority errors or emergency actions, such as safety alerts, failed dialog overlays or stop buttons.

RemoteColor

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

RemoteColor

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

RemoteColor

Color used for text and icons on the errorContainer color.

RemoteColor

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

RemoteColor

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

RemoteColor

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

RemoteColor

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

RemoteColor

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

RemoteColor

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

RemoteColor

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

RemoteColor

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

RemoteColor

The main color for primary outline components.

RemoteColor

The secondary color for secondary outline components.

RemoteColor

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

RemoteColor

is a standout container color for key components.

RemoteColor

is less prominent than primary for component backgrounds

RemoteColor

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

RemoteColor

A tonal color to be used in containers.

RemoteColor

is less prominent than secondary for component backgrounds.

RemoteColor

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

RemoteColor

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

RemoteColor

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

RemoteColor

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

RemoteColor

A tonal color to be used in containers.

RemoteColor

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

Public constructors

RemoteColorScheme

Added in 1.0.0-alpha02
RemoteColorScheme(colorScheme: ColorScheme = ColorScheme())

Creates a RemoteColorScheme from a standard ColorScheme.

Colors are resolved using RemoteColor.createNamedRemoteColor with predefined canonical names (e.g., "WearM3.primary").

Parameters
colorScheme: ColorScheme = ColorScheme()

The local ColorScheme to retrieve colors from.

RemoteColorScheme

Added in 1.0.0-alpha02
RemoteColorScheme(
    primary: RemoteColor,
    primaryDim: RemoteColor,
    primaryContainer: RemoteColor,
    onPrimary: RemoteColor,
    onPrimaryContainer: RemoteColor,
    secondary: RemoteColor,
    secondaryDim: RemoteColor,
    secondaryContainer: RemoteColor,
    onSecondary: RemoteColor,
    onSecondaryContainer: RemoteColor,
    tertiary: RemoteColor,
    tertiaryDim: RemoteColor,
    tertiaryContainer: RemoteColor,
    onTertiary: RemoteColor,
    onTertiaryContainer: RemoteColor,
    surfaceContainerLow: RemoteColor,
    surfaceContainer: RemoteColor,
    surfaceContainerHigh: RemoteColor,
    onSurface: RemoteColor,
    onSurfaceVariant: RemoteColor,
    outline: RemoteColor,
    outlineVariant: RemoteColor,
    background: RemoteColor,
    onBackground: RemoteColor,
    error: RemoteColor,
    errorDim: RemoteColor,
    errorContainer: RemoteColor,
    onError: RemoteColor,
    onErrorContainer: RemoteColor
)

Public functions

copy

Added in 1.0.0-alpha02
fun copy(
    primary: RemoteColor = this.primary,
    primaryDim: RemoteColor = this.primaryDim,
    primaryContainer: RemoteColor = this.primaryContainer,
    onPrimary: RemoteColor = this.onPrimary,
    onPrimaryContainer: RemoteColor = this.onPrimaryContainer,
    secondary: RemoteColor = this.secondary,
    secondaryDim: RemoteColor = this.secondaryDim,
    secondaryContainer: RemoteColor = this.secondaryContainer,
    onSecondary: RemoteColor = this.onSecondary,
    onSecondaryContainer: RemoteColor = this.onSecondaryContainer,
    tertiary: RemoteColor = this.tertiary,
    tertiaryDim: RemoteColor = this.tertiaryDim,
    tertiaryContainer: RemoteColor = this.tertiaryContainer,
    onTertiary: RemoteColor = this.onTertiary,
    onTertiaryContainer: RemoteColor = this.onTertiaryContainer,
    surfaceContainerLow: RemoteColor = this.surfaceContainerLow,
    surfaceContainer: RemoteColor = this.surfaceContainer,
    surfaceContainerHigh: RemoteColor = this.surfaceContainerHigh,
    onSurface: RemoteColor = this.onSurface,
    onSurfaceVariant: RemoteColor = this.onSurfaceVariant,
    outline: RemoteColor = this.outline,
    outlineVariant: RemoteColor = this.outlineVariant,
    background: RemoteColor = this.background,
    onBackground: RemoteColor = this.onBackground,
    error: RemoteColor = this.error,
    errorDim: RemoteColor = this.errorDim,
    errorContainer: RemoteColor = this.errorContainer,
    onError: RemoteColor = this.onError,
    onErrorContainer: RemoteColor = this.onErrorContainer
): RemoteColorScheme

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

Public properties

background

Added in 1.0.0-alpha02
val backgroundRemoteColor

The background color that appears behind other content.

error

Added in 1.0.0-alpha02
val errorRemoteColor

Color that indicates remove, delete, close or dismiss actions, such as Swipe to Reveal. Added as a slightly less alarming and urgent alternative to errorContainer than the error dim color.

errorContainer

Added in 1.0.0-alpha02
val errorContainerRemoteColor

A less prominent container color than error, for components using the error state. Can also indicate an active error state which feels less interactive than a filled state, such as an active emergency sharing button, or on a failed overlay dialog..

errorDim

Added in 1.0.0-alpha02
val errorDimRemoteColor

Indicates high priority errors or emergency actions, such as safety alerts, failed dialog overlays or stop buttons.

onBackground

Added in 1.0.0-alpha02
val onBackgroundRemoteColor

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

onError

Added in 1.0.0-alpha02
val onErrorRemoteColor

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

onErrorContainer

Added in 1.0.0-alpha02
val onErrorContainerRemoteColor

Color used for text and icons on the errorContainer color.

onPrimary

Added in 1.0.0-alpha02
val onPrimaryRemoteColor

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

onPrimaryContainer

Added in 1.0.0-alpha02
val onPrimaryContainerRemoteColor

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

onSecondary

Added in 1.0.0-alpha02
val onSecondaryRemoteColor

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

onSecondaryContainer

Added in 1.0.0-alpha02
val onSecondaryContainerRemoteColor

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

onSurface

Added in 1.0.0-alpha02
val onSurfaceRemoteColor

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

onSurfaceVariant

Added in 1.0.0-alpha02
val onSurfaceVariantRemoteColor

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

onTertiary

Added in 1.0.0-alpha02
val onTertiaryRemoteColor

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

onTertiaryContainer

Added in 1.0.0-alpha02
val onTertiaryContainerRemoteColor

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

outline

Added in 1.0.0-alpha02
val outlineRemoteColor

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

outlineVariant

Added in 1.0.0-alpha02
val outlineVariantRemoteColor

The secondary color for secondary outline components.

primary

Added in 1.0.0-alpha02
val primaryRemoteColor

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

primaryContainer

Added in 1.0.0-alpha02
val primaryContainerRemoteColor

is a standout container color for key components.

primaryDim

Added in 1.0.0-alpha02
val primaryDimRemoteColor

is less prominent than primary for component backgrounds

secondary

Added in 1.0.0-alpha02
val secondaryRemoteColor

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

secondaryContainer

Added in 1.0.0-alpha02
val secondaryContainerRemoteColor

A tonal color to be used in containers.

secondaryDim

Added in 1.0.0-alpha02
val secondaryDimRemoteColor

is less prominent than secondary for component backgrounds.

surfaceContainer

Added in 1.0.0-alpha02
val surfaceContainerRemoteColor

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

surfaceContainerHigh

Added in 1.0.0-alpha02
val surfaceContainerHighRemoteColor

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

surfaceContainerLow

Added in 1.0.0-alpha02
val surfaceContainerLowRemoteColor

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

tertiary

Added in 1.0.0-alpha02
val tertiaryRemoteColor

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

tertiaryContainer

Added in 1.0.0-alpha02
val tertiaryContainerRemoteColor

A tonal color to be used in containers.

tertiaryDim

Added in 1.0.0-alpha02
val tertiaryDimRemoteColor

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