TextButton

Composable Component

Wear Material TextButton is a circular, text-only button with transparent background and no border. It offers a single slot for text.

Android
@Composable
public fun TextButton(
    onClick: () -> Unit,
    modifier: Modifier = Modifier,
    onLongClick: (() -> Unit)? = null,
    onLongClickLabel: String? = null,
    enabled: Boolean = true,
    shapes: TextButtonShapes = TextButtonDefaults.shapes(),
    colors: TextButtonColors = TextButtonDefaults.textButtonColors(),
    border: BorderStroke? = null,
    interactionSource: MutableInteractionSource? = null,
    content: @Composable BoxScope.() -> Unit,
)

Parameters

onClickWill be called when the user clicks the button.
modifierModifier to be applied to the button.
onLongClickCalled when this button is long clicked (long-pressed). When this callback is set, onLongClickLabel should be set as well.
onLongClickLabelSemantic / accessibility label for the onLongClick action.
enabledControls the enabled state of the button. When false, this button will not be clickable.
shapesDefines the shape for this button. Defaults to a static shape based on TextButtonDefaults.shape, but animated versions are available through TextButtonDefaults.animatedShapes.
colorsTextButtonColors that will be used to resolve the background and content color for this button in different states.
borderOptional BorderStroke that will be used to resolve the text button border in different states. See ButtonDefaults.outlinedButtonBorder.
interactionSourcean 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.
contentThe content displayed on the text button, expected to be text or image.