Compose Component

CompactButton

A Wear Material3 CompactButton that offers two slots and a specific layout for an icon and label.

CompactButton social preview

CompactButtonSample

@Sampled
@Composable
fun CompactButtonSample(modifier: Modifier = Modifier) {
    CompactButton(
        onClick = { /* Do something */ },
        icon = {
            Icon(
                painter = painterResource(R.drawable.ic_favorite_rounded),
                contentDescription = "Favorite icon",
                modifier = Modifier.size(CompactButtonDefaults.ExtraSmallIconSize),
            )
        },
        modifier = modifier,
        label = { Text("Compact Button", maxLines = 1, overflow = TextOverflow.Ellipsis) },
    )
}

FilledTonalCompactButtonSample

@Sampled
@Composable
fun FilledTonalCompactButtonSample(modifier: Modifier = Modifier) {
    CompactButton(
        onClick = { /* Do something */ },
        icon = {
            Icon(
                painter = painterResource(R.drawable.ic_favorite_rounded),
                contentDescription = "Favorite icon",
                modifier = Modifier.size(CompactButtonDefaults.ExtraSmallIconSize),
            )
        },
        colors = ButtonDefaults.filledTonalButtonColors(),
        modifier = modifier,
        label = {
            Text("Filled Tonal Compact Button", maxLines = 1, overflow = TextOverflow.Ellipsis)
        },
    )
}

OutlinedCompactButtonSample

@Sampled
@Composable
fun OutlinedCompactButtonSample(modifier: Modifier = Modifier) {
    Column(horizontalAlignment = Alignment.CenterHorizontally) {
        var expanded by remember { mutableStateOf(false) }
        if (expanded) {
            Text("A multiline string showing two lines")
        } else {
            Text("One line text")
        }
        Spacer(Modifier.height(ButtonDefaults.IconSpacing))
        CompactButton(
            onClick = { expanded = !expanded },
            colors = ButtonDefaults.outlinedButtonColors(),
            border = ButtonDefaults.outlinedButtonBorder(enabled = true),
            modifier = modifier,
            content = {
                if (expanded) {
                    Text("Show Less", maxLines = 1, overflow = TextOverflow.Ellipsis)
                } else {
                    Text("Show More", maxLines = 1, overflow = TextOverflow.Ellipsis)
                }
                Spacer(Modifier.width(ButtonDefaults.IconSpacing))
                if (expanded) {
                    Icon(
                        Icons.Filled.KeyboardArrowUp,
                        contentDescription = "Collapse",
                        modifier = Modifier.size(CompactButtonDefaults.ExtraSmallIconSize),
                    )
                } else {
                    Icon(
                        Icons.Filled.KeyboardArrowDown,
                        contentDescription = "Expand",
                        modifier = Modifier.size(CompactButtonDefaults.ExtraSmallIconSize),
                    )
                }
            },
        )
    }
}

CompactButtonWithOnLongClickSample

@Sampled
@Composable
fun CompactButtonWithOnLongClickSample(
    onClickHandler: () -> Unit,
    onLongClickHandler: () -> Unit,
    modifier: Modifier = Modifier,
) {
    CompactButton(
        onClick = onClickHandler,
        onLongClick = onLongClickHandler,
        onLongClickLabel = "Long click",
        label = { Text("Long clickable") },
        modifier =
            modifier.semantics {
                // Also override the 'click label' to say 'Double tap to press' instead of
                // the usual 'Double tap to activate'.
                onClick("press") { false }
            },
    )
}

CompactButtonWithContentSample

@Sampled
@Composable
fun CompactButtonWithContentSample(modifier: Modifier = Modifier) {
    CompactButton(
        onClick = { /* Do something */ },
        modifier = modifier,
        content = {
            Box(
                Modifier.size(CompactButtonDefaults.ExtraSmallIconSize)
                    .clip(CircleShape)
                    .background(Color.Green)
            )
            Spacer(Modifier.width(ButtonDefaults.IconSpacing))
            Text(
                "Custom content",
                maxLines = 1,
                overflow = TextOverflow.Ellipsis,
                fontWeight = FontWeight.Bold,
                fontStyle = FontStyle.Italic,
                letterSpacing = 0.5.sp,
            )
        },
    )
}
Jetpack Compose beyond MaterialFree components, screens and templates for apps that don’t look like Google’s. Copy them into your app, or let your coding agent add them.Browse for free

Content updated: