New Compose Multiplatform components arrived on Composables UICheck it out →

← Component in Material Compose

TextButton

Common

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

Last updated:

Installation

dependencies {
   implementation("androidx.compose.material:material:1.7.0-beta04")
}

Overloads

@NonRestartableComposable
@Composable
fun TextButton(
    onClick: () -> Unit,
    modifier: Modifier = Modifier,
    enabled: Boolean = true,
    interactionSource: MutableInteractionSource? = null,
    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
interactionSourcean 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.
elevation[ButtonElevation] 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
colors[ButtonColors] 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 content

Code Example

TextButtonSample

@Composable
@Sampled
fun TextButtonSample() {
    TextButton(onClick = { /* Do something! */ }) {
        Text("Text Button")
    }
}