Icon buttons help people take supplementary actions with a single tap. They’re used when a compact button is required, such as in a toolbar or image list.
OutlinedIconButton
Common
@Composable
fun OutlinedIconButton(
onClick: () -> Unit,
modifier: Modifier = Modifier,
enabled: Boolean = true,
shape: Shape = IconButtonDefaults.outlinedShape,
colors: IconButtonColors = IconButtonDefaults.outlinedIconButtonColors(),
border: BorderStroke? = IconButtonDefaults.outlinedIconButtonBorder(enabled),
interactionSource: MutableInteractionSource? = null,
content: @Composable () -> Unit,
) =
SurfaceIconButton(
onClick = onClick,
modifier = modifier,
enabled = enabled,
shape = shape,
colors = colors,
border = border,
interactionSource = interactionSource,
content = content,
)Parameters
| onClick | called when this icon button is clicked |
| modifier | the Modifier to be applied to this icon button |
| enabled | controls the enabled state of this icon button. When false, this component will not respond to user input, and it will appear visually disabled and disabled to accessibility services. |
| shape | defines the shape of this icon button's container and border (when border is not null) |
| colors | IconButtonColors that will be used to resolve the colors used for this icon button in different states. See IconButtonDefaults.outlinedIconButtonVibrantColors and IconButtonDefaults.outlinedIconButtonColors. |
| border | the border to draw around the container of this icon button. Pass null for no border. See IconButtonDefaults.outlinedIconButtonBorder and IconButtonDefaults.outlinedIconButtonBorder. |
| interactionSource | an optional hoisted MutableInteractionSource for observing and emitting Interactions for this icon button. You can use this to change the icon button's appearance or preview the icon button in different states. Note that if null is provided, interactions will still happen internally. |
| content | the content of this icon button, typically an Icon |
OutlinedIconButton
Common
@ExperimentalMaterial3ExpressiveApi
@Composable
fun OutlinedIconButton(
onClick: () -> Unit,
shapes: IconButtonShapes,
modifier: Modifier = Modifier,
enabled: Boolean = true,
colors: IconButtonColors = IconButtonDefaults.outlinedIconButtonColors(),
border: BorderStroke? = IconButtonDefaults.outlinedIconButtonBorder(enabled),
interactionSource: MutableInteractionSource? = null,
content: @Composable () -> Unit,
) =
SurfaceIconButton(
onClick = onClick,
modifier = modifier,
enabled = enabled,
shapes = shapes,
colors = colors,
border = border,
interactionSource = interactionSource,
content = content,
)Parameters
| shapes | the IconButtonShapes that the icon button will morph between depending on the user's interaction with the icon button. |
| onClick | called when this icon button is clicked |
| modifier | the Modifier to be applied to this icon button |
| enabled | controls the enabled state of this icon button. When false, this component will not respond to user input, and it will appear visually disabled and disabled to accessibility services. |
| colors | IconButtonColors that will be used to resolve the colors used for this icon button in different states. See IconButtonDefaults.outlinedIconButtonVibrantColors and IconButtonDefaults.outlinedIconButtonColors. |
| border | the border to draw around the container of this icon button. Pass null for no border. See IconButtonDefaults.outlinedIconButtonBorder and IconButtonDefaults.outlinedIconButtonBorder. |
| interactionSource | an optional hoisted MutableInteractionSource for observing and emitting Interactions for this icon button. You can use this to change the icon button's appearance or preview the icon button in different states. Note that if null is provided, interactions will still happen internally. |
| content | the content of this icon button, typically an Icon |
