Composable Function

RemoteSwitchButton

The Wear Material RemoteSwitchButton offers four slots and a specific layout for an icon, a label, a secondaryLabel and a switch toggle control.

RemoteSwitchButton

Source set: Android
@Composable
public fun RemoteSwitchButton(
    checked: RemoteBoolean,
    onCheckedChange: Action,
    modifier: RemoteModifier = RemoteModifier,
    enabled: RemoteBoolean = true.rb,
    shape: RemoteShape = RemoteSwitchButtonDefaults.switchButtonShape,
    colors: RemoteSwitchButtonColors = RemoteSwitchButtonDefaults.switchButtonColors(),
    contentPadding: RemotePaddingValues = RemoteSwitchButtonDefaults.ContentPadding,
    border: RemoteDp? = null,
    borderColor: RemoteColor? = null,
    icon: (@Composable @RemoteComposable () -> Unit)? = null,
    secondaryLabel: (@Composable @RemoteComposable RemoteRowScope.() -> Unit)? = null,
    label: @Composable @RemoteComposable RemoteRowScope.() -> Unit,
)

The Wear Material RemoteSwitchButton offers four slots and a specific layout for an icon, a label, a secondaryLabel and a switch toggle control. The icon and secondaryLabel are optional. The items are laid out in a row with the optional icon at the start, a column containing the two label slots and a Switch at the end.

Parameters

checked Boolean flag indicating whether this button is currently checked.
onCheckedChange Callback to be invoked when this button is clicked.
modifier Modifier to be applied to the button.
enabled Controls the enabled state of the button. When false, this button will not be clickable. Note that only constant values are currently supported for enabled for click handling.
shape Defines the button's shape.
colors RemoteSwitchButtonColors that will be used to resolve the colors used for this button in different states.
contentPadding The spacing values to apply internally between the container and the content.
border Optional RemoteDp border stroke width.
borderColor Optional RemoteColor border color.
icon An optional slot for providing an icon to indicate the purpose of the button.
secondaryLabel A slot for providing the button's secondary label.
label A slot for providing the button's main label.

Content updated: