New Compose Multiplatform components arrived on Composables UICheck it out →

← Component in Jetpack Glance

OutlineButton

Android

An outline button styled per Material3. It has a transparent background. It is more opinionated than [Button] and suitable for uses where M3 is preferred.

Last updated:

Installation

dependencies {
   implementation("androidx.glance:glance-appwidget:1.1.0")
}

Overloads

@Composable
fun OutlineButton(
    text: String,
    contentColor: ColorProvider,
    onClick: () -> Unit,
    modifier: GlanceModifier = GlanceModifier,
    enabled: Boolean = true,
    icon: ImageProvider? = null,
    maxLines: Int = Int.MAX_VALUE,
    key: String? = null
)

Parameters

namedescription
textThe text that this button will show.
onClickThe action to be performed when this button is clicked.
modifierThe modifier to be applied to this button.
enabledIf false, the button will not be clickable.
iconAn optional leading icon placed before the text.
contentColorThe color used for the text, optional icon tint, and outline.
maxLinesAn optional maximum number of lines for the text to span, wrapping if necessary. If the text exceeds the given number of lines, it will be truncated.
keyA stable and unique key that identifies the action for this button. This ensures that the correct action is triggered, especially in cases of items that change order. If not provided we use the key that is automatically generated by the Compose runtime, which is unique for every exact code location in the composition tree.
@Composable
fun OutlineButton(
    text: String,
    contentColor: ColorProvider,
    onClick: Action,
    modifier: GlanceModifier = GlanceModifier,
    enabled: Boolean = true,
    icon: ImageProvider? = null,
    maxLines: Int = Int.MAX_VALUE,
)

Parameters

namedescription
textThe text that this button will show.
onClickThe action to be performed when this button is clicked.
modifierThe modifier to be applied to this button.
enabledIf false, the button will not be clickable.
iconAn optional leading icon placed before the text.
contentColorThe color used for the text, optional icon tint, and outline.
maxLinesAn optional maximum number of lines for the text to span, wrapping if necessary. If the text exceeds the given number of lines, it will be truncated.