RemoteButtonDefaults - API Reference Item in Wear Remote Material 3

Contains the default values used by RemoteButton

Android

public object RemoteButtonDefaults

Contains the default values used by RemoteButton

Functions

buttonColors

@Composable
public fun buttonColors(): RemoteButtonColors

Creates a RemoteButtonColors that represents the default background and content colors used in a RemoteButton.

buttonColors

@Composable
public fun buttonColors(
    containerColor: RemoteColor? = null,
    contentColor: RemoteColor? = null,
    secondaryContentColor: RemoteColor? = null,
    iconColor: RemoteColor? = null,
    disabledContainerColor: RemoteColor? = null,
    disabledContentColor: RemoteColor? = null,
    disabledSecondaryContentColor: RemoteColor? = null,
    disabledIconColor: RemoteColor? = null,
): RemoteButtonColors

Creates a RemoteButtonColors that represents the default background and content colors used in a RemoteButton.

Parameters


containerColor	The background color of this RemoteButton when enabled
contentColor	The content color of this RemoteButton when enabled
secondaryContentColor	The content color of this RemoteButton when enabled
iconColor	The content color of this RemoteButton when enabled
disabledContainerColor	The background color of this RemoteButton when not enabled
disabledContentColor	The content color of this RemoteButton when not enabled
disabledSecondaryContentColor	The content color of this RemoteButton when not enabled
disabledIconColor	The content color of this RemoteButton when not enabled

buttonWithContainerPainterColors

@Composable
public fun buttonWithContainerPainterColors(): RemoteButtonColors

Creates a RemoteButtonColors for the content in a RemoteButton with an image container painter.

containerPainter

@Composable
public fun containerPainter(
    image: RemotePainter,
    scrim: RemoteBrush? = image.intrinsicSize?.let { scrimBrush(it) },
    alpha: RemoteFloat = DefaultAlpha.rf,
): RemotePainter

Creates a RemotePainter for the background of a RemoteButton with container painter, that displays an image with a scrim on top to make sure that any content above the background will be legible.

An Image background is a means to reinforce the meaning of information in a Button. Buttons should have a content color that contrasts with the background image and scrim.

Parameters


image	The RemotePainter to use to draw the container background of the RemoteButton.
scrim	The RemoteBrush to use to paint a scrim over the container image to ensure that any text drawn over the image is legible.
alpha	Opacity of the container image painter and scrim.

disabledContainerPainter

@Composable
public fun disabledContainerPainter(containerPainter: RemotePainter): RemotePainter

Creates a RemotePainter for the disabled background of a RemoteButton with container painter - draws the containerPainter with an alpha applied to achieve a disabled effect.

An Image background is a means to reinforce the meaning of information in a Button. Buttons should have a content color that contrasts with the background image and scrim.

Parameters


containerPainter	The RemotePainter to use to draw the container background of the RemoteButton.

scrimBrush

@Composable
public fun scrimBrush(size: RemoteSize): RemoteBrush

Creates a RemoteBrush for the recommended scrim drawn on top of image container backgrounds.