State of Compose 2023 results are in! Click here to learn more

← Back to Material Compose

TextButton

Component
in
Material
. Since 0.1.0-dev15

Overview

Code Examples

Video

<a href="https://material.io/components/buttons#text-button" class="external" target="_blank">Material Design text button</a>.

Text buttons are typically used for less-pronounced actions, including those located in dialogs and cards. In cards, text buttons help maintain an emphasis on card content.

!Text button image(https://developer.android.com/images/reference/androidx/compose/material/text-button.png)

The default text style for internal Text components will be set to Typography.button.

Overloads

TextButton

@Composable
@NonRestartableComposable
fun TextButton(
    onClick: () -> Unit,
    modifier: Modifier = Modifier,
    enabled: Boolean = true,
    interactionSource: MutableInteractionSource = remember { MutableInteractionSource() },
    elevation: ButtonElevation? = null,
    shape: Shape = MaterialTheme.shapes.small,
    border: BorderStroke? = null,
    colors: ButtonColors = ButtonDefaults.textButtonColors(),
    contentPadding: PaddingValues = ButtonDefaults.TextButtonContentPadding,
    content: @Composable RowScope.() -> Unit
)

Parameters

NameDescription
onClickWill be called when the user clicks the button
modifierModifier to be applied to the button
enabledControls the enabled state of the button. When false, this button will not be clickable
interactionSourcethe MutableInteractionSource representing the stream of Interactions for this Button. You can create and pass in your own remembered MutableInteractionSource if you want to observe Interactions and customize the appearance / behavior of this Button in different Interactions.
elevationButtonElevation used to resolve the elevation for this button in different states. A TextButton typically has no elevation, see Button for a button with elevation.
shapeDefines the button's shape as well as its shadow
borderBorder to draw around the button
colorsButtonColors that will be used to resolve the background and content color for this button in different states. See ButtonDefaults.textButtonColors.
contentPaddingThe spacing values to apply internally between the container and the conten