RemoteIconButton

Functions summary

Unit
@Composable
@RemoteComposable
RemoteIconButton(
    onClick: Action,
    modifier: RemoteModifier,
    colors: RemoteIconButtonColors,
    enabled: RemoteBoolean,
    border: RemoteDp?,
    borderColor: RemoteColor?,
    shape: RemoteShape,
    content: @Composable @RemoteComposable () -> Unit
)

Wear Material RemoteIconButton is a circular, icon-only button with transparent background and no border.

Functions

RemoteIconButton

@Composable
@RemoteComposable
fun RemoteIconButton(
    onClick: Action,
    modifier: RemoteModifier = RemoteModifier,
    colors: RemoteIconButtonColors = RemoteIconButtonDefaults.iconButtonColors(),
    enabled: RemoteBoolean = true.rb,
    border: RemoteDp? = null,
    borderColor: RemoteColor? = null,
    shape: RemoteShape = RemoteIconButtonDefaults.shape,
    content: @Composable @RemoteComposable () -> Unit
): Unit

Wear Material RemoteIconButton is a circular, icon-only button with transparent background and no border. It offers a single slot to take icon or image content.

The default RemoteIconButton has no border and a transparent background for low emphasis actions. For actions that require higher emphasis, consider overriding the colors by RemoteIconButtonColors.copy

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

Example of an RemoteIconButton with shape animation of rounded corners on press:

import androidx.compose.remote.creation.compose.state.rs
import androidx.wear.compose.remote.material3.RemoteIcon
import androidx.wear.compose.remote.material3.RemoteIconButton
import androidx.wear.compose.remote.material3.previews.TestImageVectors

RemoteIconButton(testAction, modifier = modifier, colors = tonalColors) {
    RemoteIcon(imageVector = TestImageVectors.VolumeUp, contentDescription = null)
}
Parameters
onClick: Action

Will be called when the user clicks the button.
modifier: RemoteModifier = RemoteModifier

Modifier to be applied to the button.
colors: RemoteIconButtonColors = RemoteIconButtonDefaults.iconButtonColors()

RemoteIconButtonColors that will be used to resolve the background and content color for this button in different states.
enabled: RemoteBoolean = true.rb

Controls the enabled state of the button. When false, this button will not be clickable. It must be a constant value.
border: RemoteDp? = null

Optional RemoteDp that will be used to resolve the border for this button in different states.
borderColor: RemoteColor? = null

Optional RemoteColor that will be used to resolve the border color for this button in different states.
shape: RemoteShape = RemoteIconButtonDefaults.shape

Defines the shape for this button. Defaults to a static shape based on RemoteIconButtonDefaults.shape
content: @Composable @RemoteComposable () -> Unit

The content displayed on the text button, expected to be text or image.