Composable Function

RemoteSplitCheckboxButton

The Wear Material SplitCheckboxButton offers two slots and shows the current toggle state via a checkbox.

RemoteSplitCheckboxButton

Source set: Android
@Composable
public fun RemoteSplitCheckboxButton(
    checked: RemoteBoolean,
    onCheckedChange: Action,
    toggleContentDescription: RemoteString?,
    onContainerClick: Action,
    modifier: RemoteModifier = RemoteModifier,
    enabled: RemoteBoolean = true.rb,
    shape: RemoteShape = RemoteSplitCheckboxButtonDefaults.shape,
    colors: RemoteSplitCheckboxButtonColors =
        RemoteSplitCheckboxButtonDefaults.splitCheckboxButtonColors(),
    contentPadding: RemotePaddingValues = RemoteSplitCheckboxButtonDefaults.ContentPadding,
    secondaryLabel: @Composable @RemoteComposable (RemoteRowScope.() -> Unit)? = null,
    label: @Composable @RemoteComposable RemoteRowScope.() -> Unit,
)

The Wear Material SplitCheckboxButton offers two slots and shows the current toggle state via a checkbox.

The RemoteSplitCheckboxButton is essentially a RemoteRow with two split areas. The first area containing label and optional secondaryLabel is clickable and triggers onContainerClick. The second area contains a checkbox toggle control and triggers onCheckedChange.

Parameters

checked RemoteBoolean flag indicating whether this button is currently checked.
onCheckedChange Action to be invoked when the toggle control is clicked.
toggleContentDescription Text used by accessibility services to describe what this toggle control represents.
onContainerClick Action to be invoked when the container area is clicked.
modifier RemoteModifier to be applied to the button.
enabled Controls the enabled state of the button. When false, this button will appear visually disabled and will not be clickable. Note that only constant values are currently supported for enabled for click handling.
shape Defines the button's shape. It is recommended to use the default shape.
colors RemoteSplitCheckboxButtonColors that will be used to resolve the container and content colors for this button in different states.
contentPadding The spacing values to apply internally between the container and the content.
secondaryLabel A slot for a secondary label, displayed below the label.
label A slot for the main label content.

Content updated: