ImageButton
Android
Component in Wear Material 3 Compose
Base level Wear Material3 [ImageButton] that offers a single slot to take any content. Used as the container for more opinionated [ImageButton] components that take specific content such as icons and labels.
An Image background is a means to reinforce the meaning of information in a Button. Buttons should have a content color that contrasts with the background image and scrim.
[ImageButton] takes [containerPainter] for the image background to be drawn when the button is enabled and [disabledContainerPainter] for the image background when the button is disabled. It is recommended to use [ButtonDefaults.containerPainter] to create the painters so that a scrim is drawn on top of the container image, ensuring that any content above the background is legible.
The [ImageButton] is Stadium-shaped by default and has a max height designed to take no more than two lines of text of [Typography.labelMedium] style. With localisation and/or large font sizes, the text can extend to a maximum of 3 lines in which case, the [ImageButton] height adjusts to accommodate the contents.
[ImageButton] can be enabled or disabled. A disabled button will not respond to click events.
Last updated:
Installation
dependencies {
implementation("androidx.wear.compose:compose-material3:1.0.0-alpha36")
}
Overloads
@Composable
fun ImageButton(
onClick: () -> Unit,
containerPainter: Painter,
modifier: Modifier = Modifier,
onLongClick: (() -> Unit)? = null,
onLongClickLabel: String? = null,
enabled: Boolean = true,
disabledContainerPainter: Painter = ButtonDefaults.disabledContainerPainter(containerPainter),
shape: Shape = ButtonDefaults.shape,
colors: ButtonColors = ButtonDefaults.imageButtonColors(),
border: BorderStroke? = null,
contentPadding: PaddingValues = ButtonDefaults.ContentPadding,
interactionSource: MutableInteractionSource? = null,
transformation: SurfaceTransformation? = null,
content: @Composable RowScope.() -> Unit,
): Unit
Parameters
| name | description |
|---|---|
onClick | Will be called when the user clicks the button |
containerPainter | The [Painter] to use to draw the container image of the [ImageButton], such as returned by [ButtonDefaults.containerPainter]. |
modifier | Modifier to be applied to the button |
onLongClick | Called when this button is long clicked (long-pressed). When this callback is set, [onLongClickLabel] should be set as well. |
onLongClickLabel | Semantic / accessibility label for the [onLongClick] action. |
enabled | Controls the enabled state of the button. When false, this button will not be clickable |
disabledContainerPainter | [Painter] to use to draw the container of the [Button] when not enabled, such as returned by [ButtonDefaults.containerPainter] with alpha = [ButtonDefaults.DisabledContainerAlpha]. |
shape | Defines the button's shape. It is strongly recommended to use the default as this shape is a key characteristic of the Wear Material3 Theme |
colors | [ButtonColors] that will be used to resolve the background and content color for this button in different states. See [ButtonDefaults.outlinedButtonColors]. |
border | Optional [BorderStroke] that will be used to resolve the border for this button in different states. |
contentPadding | The spacing values to apply internally between the container and the content |
interactionSource | an optional hoisted [MutableInteractionSource] for observing and emitting [Interaction]s for this button. You can use this to change the button's appearance or preview the button in different states. Note that if null is provided, interactions will still happen internally. |
transformation | Transformation to be used when button appears inside a container that needs to dynamically change its content separately from the background. |
content | Slot for composable body content displayed on the OutlinedButton |
@Composable
fun ImageButton(
onClick: () -> Unit,
containerPainter: Painter,
modifier: Modifier = Modifier,
onLongClick: (() -> Unit)? = null,
onLongClickLabel: String? = null,
secondaryLabel: (@Composable RowScope.() -> Unit)? = null,
icon: (@Composable BoxScope.() -> Unit)? = null,
enabled: Boolean = true,
disabledContainerPainter: Painter = ButtonDefaults.disabledContainerPainter(containerPainter),
shape: Shape = ButtonDefaults.shape,
colors: ButtonColors = ButtonDefaults.imageButtonColors(),
border: BorderStroke? = null,
contentPadding: PaddingValues = ButtonDefaults.ContentPadding,
interactionSource: MutableInteractionSource? = null,
transformation: SurfaceTransformation? = null,
label: @Composable RowScope.() -> Unit,
): Unit
Parameters
| name | description |
|---|---|
onClick | Will be called when the user clicks the button |
containerPainter | The [Painter] to use to draw the container image of the [Button], such as returned by [ButtonDefaults.containerPainter]. |
modifier | Modifier to be applied to the button |
onLongClick | Called when this button is long clicked (long-pressed). When this callback is set, [onLongClickLabel] should be set as well. |
onLongClickLabel | Semantic / accessibility label for the [onLongClick] action. |
secondaryLabel | A slot for providing the button's secondary label. The contents are expected to be text which is "start" aligned if there is an icon preset and "start" or "center" aligned if not. label and secondaryLabel contents should be consistently aligned. |
icon | A slot for providing the button's icon. The contents are expected to be a horizontally and vertically aligned icon of size [ButtonDefaults.IconSize] or [ButtonDefaults.LargeIconSize]. |
enabled | Controls the enabled state of the button. When false, this button will not be clickable |
disabledContainerPainter | [Painter] to use to draw the container of the [Button] when not enabled, such as returned by [ButtonDefaults.containerPainter] with alpha = [ButtonDefaults.DisabledContainerAlpha]. |
shape | Defines the button's shape. It is strongly recommended to use the default as this shape is a key characteristic of the Wear Material3 Theme |
colors | [ButtonColors] that will be used to resolve the background and content color for this button in different states. See [ButtonDefaults.outlinedButtonColors]. |
border | Optional [BorderStroke] that will be used to resolve the button border in different states. |
contentPadding | The spacing values to apply internally between the container and the content |
interactionSource | an optional hoisted [MutableInteractionSource] for observing and emitting [Interaction]s for this button. You can use this to change the button's appearance or preview the button in different states. Note that if null is provided, interactions will still happen internally. |
transformation | Transformation to be used when button appears inside a container that needs to dynamically change its content separately from the background. |
label | A slot for providing the button's main label. The contents are expected to be text which is "start" aligned if there is an icon preset and "start" or "center" aligned if not. |
Code Example
ButtonWithImageSample
@Composable
fun ButtonWithImageSample(modifier: Modifier = Modifier.fillMaxWidth(), enabled: Boolean = true) {
ImageButton(
onClick = { /* Do something */ },
containerPainter =
ButtonDefaults.containerPainter(
image = painterResource(id = R.drawable.backgroundimage)
),
enabled = enabled,
label = { Text("Button") },
secondaryLabel = { Text("Secondary label") },
icon = {
Icon(
painter = painterResource(R.drawable.ic_favorite_rounded),
contentDescription = "Favorite icon",
)
},
modifier = modifier
)
}
Sponsored by
