← Back to Material 3 Compose
OutlinedButton
Component
in
Material 3
. Since 1.0.0Overview
Code Examples
Video
<a href="https://m3.material.io/components/buttons/overview" class="external" target="_blank">Material Design outlined button</a>.
Buttons help people initiate actions, from sending an email, to sharing a document, to liking a post.
!Outlined button image(https://developer.android.com/images/reference/androidx/compose/material3/outlined-button.png)
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.
Overloads
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,
contentPadding: PaddingValues = ButtonDefaults.ContentPadding,
interactionSource: MutableInteractionSource = remember { MutableInteractionSource() },
content: @Composable RowScope.() -> Unit
)
Parameters
Name | Description |
---|---|
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 | the MutableInteractionSource representing the stream of Interactions for this button. You can create and pass in your own remember ed instance to observe Interactions and customize the appearance / behavior of this button in different states |