Compose Multiplatform Material3/androidx.compose.material3/OutlinedButton

OutlinedButton

@Composable
fun OutlinedButton(onClick: () -> Unit, modifier: Modifier = Modifier, enabled: Boolean = true, shape: Shape = ButtonDefaults.outlinedShape, colors: ButtonColors = ButtonDefaults.outlinedButtonColors(), elevation: ButtonElevation? = null, border: BorderStroke? = ButtonDefaults.outlinedButtonBorder(enabled), contentPadding: PaddingValues = ButtonDefaults.ContentPadding, interactionSource: MutableInteractionSource? = null, content: @Composable RowScope.() -> Unit)

Material Design outlined button.

Buttons help people initiate actions, from sending an email, to sharing a document, to liking a post.

Outlined button image

Outlined buttons are medium-emphasis buttons. They contain actions that are important, but are not the primary action in an app. Outlined buttons pair well with Buttons to indicate an alternative, secondary action.

Parameters

onClick

called when this button is clicked

modifier

the Modifier to be applied to this button

enabled

controls the enabled state of this 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 button's container, border (when border is not null), and shadow (when using elevation).

colors

ButtonColors that will be used to resolve the colors for this button in different states. See ButtonDefaults.outlinedButtonColors.

elevation

ButtonElevation used to resolve the elevation for this button in different states. This controls the size of the shadow below the button. Additionally, when the container color is ColorScheme.surface, this controls the amount of primary color applied as an overlay.

border

the border to draw around the container of this button. Pass null for no border.

contentPadding

the spacing values to apply internally between the container and the content

interactionSource

an optional hoisted MutableInteractionSource for observing and emitting Interactions 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.

Samples

androidx.compose.material3.samples.OutlinedButtonSample