RemoteEdgeButtonDefaults

Artifact: androidx.wear.compose.remote:remote-material3

View Source

Added in 1.0.0-alpha15

object RemoteEdgeButtonDefaults

---

Contains the default values used by RemoteEdgeButton.

Summary

Public functions
RemoteButtonColors	@Composable @RemoteComposable buttonColors() Creates a RemoteButtonColors that represents the default background and content colors used in a RemoteEdgeButton.
RemoteButtonColors	@Composable @RemoteComposable buttonColors(     containerColor: RemoteColor?,     contentColor: RemoteColor?,     secondaryContentColor: RemoteColor?,     iconColor: RemoteColor?,     disabledContainerColor: RemoteColor?,     disabledContentColor: RemoteColor?,     disabledSecondaryContentColor: RemoteColor?,     disabledIconColor: RemoteColor? ) Creates a RemoteButtonColors that represents the default background and content colors used in a RemoteEdgeButton.
RemoteButtonColors	@Composable @RemoteComposable filledTonalButtonColors() Creates a RemoteButtonColors with filled tonal colors for RemoteEdgeButton.
RemoteButtonColors	@Composable @RemoteComposable filledTonalButtonColors(     containerColor: RemoteColor?,     contentColor: RemoteColor?,     secondaryContentColor: RemoteColor?,     iconColor: RemoteColor?,     disabledContainerColor: RemoteColor?,     disabledContentColor: RemoteColor?,     disabledSecondaryContentColor: RemoteColor?,     disabledIconColor: RemoteColor? ) Creates a RemoteButtonColors with filled tonal colors for RemoteEdgeButton.
RemoteButtonColors	@Composable @RemoteComposable filledVariantButtonColors() Creates a RemoteButtonColors with higher chroma container colors for RemoteEdgeButton.
RemoteButtonColors	@Composable @RemoteComposable filledVariantButtonColors(     containerColor: RemoteColor?,     contentColor: RemoteColor?,     secondaryContentColor: RemoteColor?,     iconColor: RemoteColor?,     disabledContainerColor: RemoteColor?,     disabledContentColor: RemoteColor?,     disabledSecondaryContentColor: RemoteColor?,     disabledIconColor: RemoteColor? ) Creates a RemoteButtonColors with higher chroma container colors for RemoteEdgeButton.
RemoteDp	iconSizeFor(edgeButtonSize: RemoteEdgeButtonSize) Recommended icon size for a given edge button size.
RemoteButtonColors	@Composable @RemoteComposable outlinedButtonColors() Creates a RemoteButtonColors with outlined colors for RemoteEdgeButton.
RemoteButtonColors	@Composable @RemoteComposable outlinedButtonColors(     contentColor: RemoteColor?,     secondaryContentColor: RemoteColor?,     iconColor: RemoteColor?,     disabledContentColor: RemoteColor?,     disabledSecondaryContentColor: RemoteColor?,     disabledIconColor: RemoteColor? ) Creates a RemoteButtonColors with outlined colors for RemoteEdgeButton.
RemoteShape	shape(buttonSize: RemoteEdgeButtonSize) The recommended shape for RemoteEdgeButton of a given buttonSize.

Public properties
RemoteDp	BottomContentPadding The recommended bottom content padding for RemoteEdgeButton.
RemotePaddingValues	ContentPadding The default content padding used by RemoteEdgeButton.
RemoteDp	ExtraSmallIconSize The recommended icon size when used with RemoteEdgeButtonSize.ExtraSmall.
RemoteDp	HorizontalContentPadding The recommended horizontal content padding for RemoteEdgeButton.
RemoteDp	LargeIconSize The recommended icon size when used with RemoteEdgeButtonSize.Large.
RemoteDp	MediumIconSize The recommended icon size when used with RemoteEdgeButtonSize.Medium.
RemoteDp	SmallIconSize The recommended icon size when used with RemoteEdgeButtonSize.Small.
RemoteDp	TopContentPadding The recommended top content padding for RemoteEdgeButton.
RemoteDp	VerticalPadding Padding around the Edge Button on its top and bottom.

Public functions

buttonColors

Added in 1.0.0-alpha15

@Composable
@RemoteComposable
fun buttonColors(): RemoteButtonColors

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

buttonColors

Added in 1.0.0-alpha15

@Composable
@RemoteComposable
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 RemoteEdgeButton.

Parameters
containerColor: RemoteColor? = null	The background color of this RemoteEdgeButton when enabled.
contentColor: RemoteColor? = null	The content color of this RemoteEdgeButton when enabled.
secondaryContentColor: RemoteColor? = null	The secondary content color of this RemoteEdgeButton when enabled.
iconColor: RemoteColor? = null	The icon color of this RemoteEdgeButton when enabled.
disabledContainerColor: RemoteColor? = null	The background color of this RemoteEdgeButton when not enabled.
disabledContentColor: RemoteColor? = null	The content color of this RemoteEdgeButton when not enabled.
disabledSecondaryContentColor: RemoteColor? = null	The secondary content color of this RemoteEdgeButton when not enabled.
disabledIconColor: RemoteColor? = null	The icon color of this RemoteEdgeButton when not enabled.

filledTonalButtonColors

Added in 1.0.0-alpha15

@Composable
@RemoteComposable
fun filledTonalButtonColors(): RemoteButtonColors

Creates a RemoteButtonColors with filled tonal colors for RemoteEdgeButton.

filledTonalButtonColors

Added in 1.0.0-alpha15

@Composable
@RemoteComposable
fun filledTonalButtonColors(
    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 with filled tonal colors for RemoteEdgeButton.

Parameters
containerColor: RemoteColor? = null	The background color of this RemoteEdgeButton when enabled.
contentColor: RemoteColor? = null	The content color of this RemoteEdgeButton when enabled.
secondaryContentColor: RemoteColor? = null	The secondary content color of this RemoteEdgeButton when enabled.
iconColor: RemoteColor? = null	The icon color of this RemoteEdgeButton when enabled.
disabledContainerColor: RemoteColor? = null	The background color of this RemoteEdgeButton when not enabled.
disabledContentColor: RemoteColor? = null	The content color of this RemoteEdgeButton when not enabled.
disabledSecondaryContentColor: RemoteColor? = null	The secondary content color of this RemoteEdgeButton when not enabled.
disabledIconColor: RemoteColor? = null	The icon color of this RemoteEdgeButton when not enabled.

filledVariantButtonColors

Added in 1.0.0-alpha15

@Composable
@RemoteComposable
fun filledVariantButtonColors(): RemoteButtonColors

Creates a RemoteButtonColors with higher chroma container colors for RemoteEdgeButton.

filledVariantButtonColors

Added in 1.0.0-alpha15

@Composable
@RemoteComposable
fun filledVariantButtonColors(
    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 with higher chroma container colors for RemoteEdgeButton.

Parameters
containerColor: RemoteColor? = null	The background color of this RemoteEdgeButton when enabled.
contentColor: RemoteColor? = null	The content color of this RemoteEdgeButton when enabled.
secondaryContentColor: RemoteColor? = null	The secondary content color of this RemoteEdgeButton when enabled.
iconColor: RemoteColor? = null	The icon color of this RemoteEdgeButton when enabled.
disabledContainerColor: RemoteColor? = null	The background color of this RemoteEdgeButton when not enabled.
disabledContentColor: RemoteColor? = null	The content color of this RemoteEdgeButton when not enabled.
disabledSecondaryContentColor: RemoteColor? = null	The secondary content color of this RemoteEdgeButton when not enabled.
disabledIconColor: RemoteColor? = null	The icon color of this RemoteEdgeButton when not enabled.

iconSizeFor

Added in 1.0.0-alpha15

fun iconSizeFor(edgeButtonSize: RemoteEdgeButtonSize): RemoteDp

Recommended icon size for a given edge button size.

Parameters
edgeButtonSize: RemoteEdgeButtonSize	The size of the edge button

outlinedButtonColors

Added in 1.0.0-alpha15

@Composable
@RemoteComposable
fun outlinedButtonColors(): RemoteButtonColors

Creates a RemoteButtonColors with outlined colors for RemoteEdgeButton.

outlinedButtonColors

Added in 1.0.0-alpha15

@Composable
@RemoteComposable
fun outlinedButtonColors(
    contentColor: RemoteColor? = null,
    secondaryContentColor: RemoteColor? = null,
    iconColor: RemoteColor? = null,
    disabledContentColor: RemoteColor? = null,
    disabledSecondaryContentColor: RemoteColor? = null,
    disabledIconColor: RemoteColor? = null
): RemoteButtonColors

Creates a RemoteButtonColors with outlined colors for RemoteEdgeButton.

Parameters
contentColor: RemoteColor? = null	The content color of this RemoteEdgeButton when enabled.
secondaryContentColor: RemoteColor? = null	The secondary content color of this RemoteEdgeButton when enabled.
iconColor: RemoteColor? = null	The icon color of this RemoteEdgeButton when enabled.
disabledContentColor: RemoteColor? = null	The content color of this RemoteEdgeButton when not enabled.
disabledSecondaryContentColor: RemoteColor? = null	The secondary content color of this RemoteEdgeButton when not enabled.
disabledIconColor: RemoteColor? = null	The icon color of this RemoteEdgeButton when not enabled.

shape

Added in 1.0.0-alpha15

fun shape(buttonSize: RemoteEdgeButtonSize = RemoteEdgeButtonSize.Small): RemoteShape

The recommended shape for RemoteEdgeButton of a given buttonSize.

Parameters
buttonSize: RemoteEdgeButtonSize = RemoteEdgeButtonSize.Small	The RemoteEdgeButtonSize of the edge button.

Public properties

BottomContentPadding

Added in 1.0.0-alpha15

val BottomContentPadding: RemoteDp

The recommended bottom content padding for RemoteEdgeButton.

ContentPadding

Added in 1.0.0-alpha15

val ContentPadding: RemotePaddingValues

The default content padding used by RemoteEdgeButton.

ExtraSmallIconSize

Added in 1.0.0-alpha15

val ExtraSmallIconSize: RemoteDp

The recommended icon size when used with RemoteEdgeButtonSize.ExtraSmall.

HorizontalContentPadding

Added in 1.0.0-alpha15

val HorizontalContentPadding: RemoteDp

The recommended horizontal content padding for RemoteEdgeButton.

LargeIconSize

Added in 1.0.0-alpha15

val LargeIconSize: RemoteDp

The recommended icon size when used with RemoteEdgeButtonSize.Large.

MediumIconSize

Added in 1.0.0-alpha15

val MediumIconSize: RemoteDp

The recommended icon size when used with RemoteEdgeButtonSize.Medium.

SmallIconSize

Added in 1.0.0-alpha15

val SmallIconSize: RemoteDp

The recommended icon size when used with RemoteEdgeButtonSize.Small.

TopContentPadding

Added in 1.0.0-alpha15

val TopContentPadding: RemoteDp

The recommended top content padding for RemoteEdgeButton.

VerticalPadding

Added in 1.0.0-alpha15

val VerticalPadding: RemoteDp

Padding around the Edge Button on its top and bottom.