RemoteEdgeButton

RemoteEdgeButton

@Composable
public fun RemoteEdgeButton(
    onClick: Action,
    modifier: RemoteModifier = RemoteModifier,
    buttonSize: RemoteEdgeButtonSize = RemoteEdgeButtonSize.Small,
    enabled: RemoteBoolean = true.rb,
    colors: RemoteButtonColors = RemoteEdgeButtonDefaults.buttonColors(),
    border: RemoteDp? = null,
    borderColor: RemoteColor? = null,
    shape: RemoteShape = RemoteEdgeButtonDefaults.shape(buttonSize),
    contentPadding: RemotePaddingValues = RemoteEdgeButtonDefaults.ContentPadding,
    content: @Composable @RemoteComposable RemoteRowScope.() -> Unit,
)

Wear Material 3 RemoteEdgeButton that offers a single slot to take any content.

The RemoteEdgeButton has a special shape designed for the bottom of the screen, as it almost follows the screen's curvature, so it should be allowed to take the full width and touch the bottom of the screen.

This button represents the most important action on the screen, and must take the whole width of the screen as well as being anchored to the screen bottom. This assumes that the Remote Compose Player is taking the full width of the screen.

RemoteEdgeButton has 4 standard sizes, taking 1 line of text for extra small, 2 for small and medium, and 3 for large. Specify it using the buttonSize parameter. Optionally, a single icon can be used instead of text.

RemoteEdgeButton takes the RemoteEdgeButtonDefaults.buttonColors color scheme by default, with colored background, contrasting content color and no border. This is a high-emphasis button for the primary, most important or most common action on a screen. Other possible colors for different levels of emphasis are: filled tonal button which defaults to RemoteEdgeButtonDefaults.filledTonalButtonColors and outlined button which defaults to RemoteEdgeButtonDefaults.outlinedButtonColors.

RemoteEdgeButton can be enabled or disabled. A disabled button will not respond to click events.

Example of a RemoteEdgeButton:

Example of a RemoteEdgeButton with an icon:

Example of a RemoteEdgeButton with filled tonal colors:

Example of a RemoteEdgeButton with multi-line text:

Parameters