OutlineButton

Component in Jetpack Glance

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: 2024-10-22 13:47

Installation

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

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

name	description
text	The text that this button will show.
onClick	The action to be performed when this button is clicked.
modifier	The modifier to be applied to this button.
enabled	If false, the button will not be clickable.
icon	An optional leading icon placed before the text.
contentColor	The color used for the text, optional icon tint, and outline.
maxLines	An optional maximum number of lines for the text to span, wrapping ifnecessary. If the text exceeds the given number of lines, it will be truncated.
key	A stable and unique key that identifies the action for this button. This ensuresthat the correct action is triggered, especially in cases of items that change order. If notprovided we use the key that is automatically generated by the Compose runtime, which is uniquefor 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

name	description
text	The text that this button will show.
onClick	The action to be performed when this button is clicked.
modifier	The modifier to be applied to this button.
enabled	If false, the button will not be clickable.
icon	An optional leading icon placed before the text.
contentColor	The color used for the text, optional icon tint, and outline.
maxLines	An optional maximum number of lines for the text to span, wrapping ifnecessary. If the text exceeds the given number of lines, it will be truncated.