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

Common
@Composable
fun TextButton(
onClick: () -> Unit,
modifier: Modifier = Modifier,
enabled: Boolean = true,
shape: Shape = ButtonDefaults.textShape,
colors: ButtonColors = ButtonDefaults.textButtonColors(),
elevation: ButtonElevation? = null,
border: BorderStroke? = null,
contentPadding: PaddingValues = ButtonDefaults.TextButtonContentPadding,
interactionSource: MutableInteractionSource? = null,
content: @Composable RowScope.() -> Unit,
) =
Button(
onClick = onClick,
modifier = modifier,
enabled = enabled,
shape = shape,
colors = colors,
elevation = elevation,
border = border,
contentPadding = contentPadding,
interactionSource = interactionSource,
content = content,
)
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.textButtonColors . |
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. A TextButton typically has no elevation, and the default value is null . See ElevatedButton for a button with elevation. |
border | the border to draw around the container of this button |
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. |
content | The content displayed on the button, expected to be text. |
Common
@ExperimentalMaterial3ExpressiveApi
@Composable
fun TextButton(
onClick: () -> Unit,
shapes: ButtonShapes,
modifier: Modifier = Modifier,
enabled: Boolean = true,
colors: ButtonColors = ButtonDefaults.textButtonColors(),
elevation: ButtonElevation? = null,
border: BorderStroke? = null,
contentPadding: PaddingValues = ButtonDefaults.TextButtonContentPadding,
interactionSource: MutableInteractionSource? = null,
content: @Composable RowScope.() -> Unit,
) =
Button(
onClick = onClick,
shapes = shapes,
modifier = modifier,
enabled = enabled,
colors = colors,
elevation = elevation,
border = border,
contentPadding = contentPadding,
interactionSource = interactionSource,
content = content,
)
Parameters
onClick | called when this button is clicked |
shapes | the ButtonShapes that this button with morph between depending on the user's interaction with the button. |
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. |
colors | ButtonColors that will be used to resolve the colors for this button in different states. See ButtonDefaults.textButtonColors . |
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. A TextButton typically has no elevation, and the default value is null . See ElevatedButton for a button with elevation. |
border | the border to draw around the container of this button |
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. |
content | The content displayed on the button, expected to be text. |
Code Examples
TextButtonWithAnimatedShapeSample
@OptIn(ExperimentalMaterial3ExpressiveApi::class)
@Preview
@Composable
fun TextButtonWithAnimatedShapeSample() {
TextButton(onClick = {}, shapes = ButtonDefaults.shapes()) { Text("Text Button") }
}
TextButtonSample
@Preview
@Composable
fun TextButtonSample() {
TextButton(onClick = { /* Do something! */ }) { Text("Text Button") }
}
Create your own Component Library
Material Components are meant to be used as is and they do not allow customizations. To build your own Jetpack Compose component library use Compose Unstyled