OutlinedButton

Functions summary

Unit

@Composable OutlinedButton(     onClick: () -> Unit,     modifier: Modifier,     onLongClick: (() -> Unit)?,     onLongClickLabel: String?,     enabled: Boolean,     shape: Shape,     colors: ButtonColors,     border: BorderStroke?,     contentPadding: PaddingValues,     interactionSource: MutableInteractionSource?,     transformation: SurfaceTransformation?,     content: @Composable RowScope.() -> Unit ) Base level Wear Material3 OutlinedButton that offers a single slot to take any content.

Unit

@Composable OutlinedButton(     onClick: () -> Unit,     modifier: Modifier,     onLongClick: (() -> Unit)?,     onLongClickLabel: String?,     secondaryLabel: (@Composable RowScope.() -> Unit)?,     icon: (@Composable BoxScope.() -> Unit)?,     enabled: Boolean,     shape: Shape,     colors: ButtonColors,     border: BorderStroke?,     contentPadding: PaddingValues,     interactionSource: MutableInteractionSource?,     transformation: SurfaceTransformation?,     label: @Composable RowScope.() -> Unit ) Wear Material3 OutlinedButton that offers three slots and a specific layout for an icon, label and secondaryLabel.

Functions

OutlinedButton

Artifact: androidx.wear.compose:compose-material3

View Source

Added in 1.5.0

@Composable
fun OutlinedButton(
    onClick: () -> Unit,
    modifier: Modifier = Modifier,
    onLongClick: (() -> Unit)? = null,
    onLongClickLabel: String? = null,
    enabled: Boolean = true,
    shape: Shape = ButtonDefaults.shape,
    colors: ButtonColors = ButtonDefaults.outlinedButtonColors(),
    border: BorderStroke? = ButtonDefaults.outlinedButtonBorder(enabled),
    contentPadding: PaddingValues = ButtonDefaults.ContentPadding,
    interactionSource: MutableInteractionSource? = null,
    transformation: SurfaceTransformation? = null,
    content: @Composable RowScope.() -> Unit
): Unit

Base level Wear Material3 OutlinedButton that offers a single slot to take any content. Used as the container for more opinionated OutlinedButton components that take specific content such as icons and labels.

The OutlinedButton is Stadium-shaped by default and has a max height designed to take no more than two lines of text of Typography.labelMedium style. With localisation and/or large font sizes, the text can extend to a maximum of 3 lines in which case, the OutlinedButton height adjusts to accommodate the contents. The OutlinedButton can have an icon or image horizontally parallel to the two lines of text.

OutlinedButton takes the ButtonDefaults.outlinedButtonColors color scheme by default, with a transparent background and a thin border. This is a medium-emphasis button for important, non-primary actions that need attention.

Other recommended buttons with ButtonColors for different levels of emphasis are: Button which defaults to ButtonDefaults.buttonColors, FilledTonalButton which defaults to ButtonDefaults.filledTonalButtonColors, ChildButton which defaults to ButtonDefaults.childButtonColors. For a background image, see the overload of Button with a containerPainter parameter.

OutlinedButton can be enabled or disabled. A disabled button will not respond to click events.

Example of an OutlinedButton:

import androidx.compose.ui.semantics.onClick
import androidx.wear.compose.material3.Button
import androidx.wear.compose.material3.OutlinedButton
import androidx.wear.compose.material3.Text

OutlinedButton(
    onClick = { /* Do something */ },
    label = { Text("Outlined Button") },
    modifier = modifier,
)

Parameters
onClick: () -> Unit	Will be called when the user clicks the button
modifier: Modifier = Modifier	Modifier to be applied to the button
onLongClick: (() -> Unit)? = null	Called when this button is long clicked (long-pressed). When this callback is set, onLongClickLabel should be set as well.
onLongClickLabel: String? = null	Semantic / accessibility label for the onLongClick action.
enabled: Boolean = true	Controls the enabled state of the button. When false, this button will not be clickable
shape: Shape = ButtonDefaults.shape	Defines the button's shape. It is strongly recommended to use the default as this shape is a key characteristic of the Wear Material3 Theme
colors: ButtonColors = ButtonDefaults.outlinedButtonColors()	ButtonColors that will be used to resolve the background and content color for this button in different states. See ButtonDefaults.outlinedButtonColors.
border: BorderStroke? = ButtonDefaults.outlinedButtonBorder(enabled)	Optional BorderStroke that will be used to resolve the border for this button in different states. See ButtonDefaults.outlinedButtonBorder.
contentPadding: PaddingValues = ButtonDefaults.ContentPadding	The spacing values to apply internally between the container and the content
interactionSource: MutableInteractionSource? = null	an 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.
transformation: SurfaceTransformation? = null	Transformation to be used when button appears inside a container that needs to dynamically change its content separately from the background.
content: @Composable RowScope.() -> Unit	Slot for composable body content displayed on the OutlinedButton

OutlinedButton

Artifact: androidx.wear.compose:compose-material3

View Source

Added in 1.5.0

@Composable
fun OutlinedButton(
    onClick: () -> Unit,
    modifier: Modifier = Modifier,
    onLongClick: (() -> Unit)? = null,
    onLongClickLabel: String? = null,
    secondaryLabel: (@Composable RowScope.() -> Unit)? = null,
    icon: (@Composable BoxScope.() -> Unit)? = null,
    enabled: Boolean = true,
    shape: Shape = ButtonDefaults.shape,
    colors: ButtonColors = ButtonDefaults.outlinedButtonColors(),
    border: BorderStroke? = ButtonDefaults.outlinedButtonBorder(enabled),
    contentPadding: PaddingValues = ButtonDefaults.ContentPadding,
    interactionSource: MutableInteractionSource? = null,
    transformation: SurfaceTransformation? = null,
    label: @Composable RowScope.() -> Unit
): Unit

Wear Material3 OutlinedButton that offers three slots and a specific layout for an icon, label and secondaryLabel. The icon and secondaryLabel are optional. The items are laid out with the icon, if provided, at the start of a row, with a column next containing the two label slots.

The OutlinedButton is stadium-shaped by default and its standard height is designed to take 2 lines of text of Typography.labelMedium style - either a two-line label or both a single line label and a secondary label. With localisation and/or large font sizes, the OutlinedButton height adjusts to accommodate the contents. The label and secondary label should be consistently aligned.

If a icon is provided then the labels should be "start" aligned, e.g. left aligned in ltr so that the text starts next to the icon.

OutlinedButton takes the ButtonDefaults.outlinedButtonColors color scheme by default, with a transparent background and a thin border. This is a medium-emphasis button for important, non-primary actions that need attention.

Other recommended buttons with ButtonColors for different levels of emphasis are: Button which defaults to ButtonDefaults.buttonColors, FilledTonalButton which defaults to ButtonDefaults.filledTonalButtonColors, ChildButton which defaults to ButtonDefaults.childButtonColors. For a background image, see the overload of Button with a containerPainter parameter.

OutlinedButton can be enabled or disabled. A disabled button will not respond to click events.

Example of an OutlinedButton with an icon and secondary label:

import androidx.compose.foundation.layout.size
import androidx.compose.ui.Modifier
import androidx.compose.ui.res.painterResource
import androidx.compose.ui.semantics.onClick
import androidx.wear.compose.material3.Button
import androidx.wear.compose.material3.ButtonDefaults
import androidx.wear.compose.material3.Icon
import androidx.wear.compose.material3.OutlinedButton
import androidx.wear.compose.material3.Text

OutlinedButton(
    onClick = { /* Do something */ },
    label = { Text("Outlined Button") },
    secondaryLabel = { Text("Secondary label") },
    icon = {
        Icon(
            painter = painterResource(R.drawable.ic_favorite_rounded),
            contentDescription = "Favorite icon",
            modifier = Modifier.size(ButtonDefaults.IconSize),
        )
    },
    modifier = modifier,
)

Parameters
onClick: () -> Unit	Will be called when the user clicks the button
modifier: Modifier = Modifier	Modifier to be applied to the button
onLongClick: (() -> Unit)? = null	Called when this button is long clicked (long-pressed). When this callback is set, onLongClickLabel should be set as well.
onLongClickLabel: String? = null	Semantic / accessibility label for the onLongClick action.
secondaryLabel: (@Composable RowScope.() -> Unit)? = null	A slot for providing the button's secondary label. The contents are expected to be text which is "start" aligned if there is an icon preset and "start" or "center" aligned if not. label and secondaryLabel contents should be consistently aligned.
icon: (@Composable BoxScope.() -> Unit)? = null	A slot for providing the button's icon. The contents are expected to be a horizontally and vertically aligned icon of size ButtonDefaults.IconSize or ButtonDefaults.LargeIconSize.
enabled: Boolean = true	Controls the enabled state of the button. When false, this button will not be clickable
shape: Shape = ButtonDefaults.shape	Defines the button's shape. It is strongly recommended to use the default as this shape is a key characteristic of the Wear Material3 Theme
colors: ButtonColors = ButtonDefaults.outlinedButtonColors()	ButtonColors that will be used to resolve the background and content color for this button in different states. See ButtonDefaults.outlinedButtonColors.
border: BorderStroke? = ButtonDefaults.outlinedButtonBorder(enabled)	Optional BorderStroke that will be used to resolve the button border in different states. See ButtonDefaults.outlinedButtonBorder.
contentPadding: PaddingValues = ButtonDefaults.ContentPadding	The spacing values to apply internally between the container and the content
interactionSource: MutableInteractionSource? = null	an 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.
transformation: SurfaceTransformation? = null	Transformation to be used when button appears inside a container that needs to dynamically change its content separately from the background.
label: @Composable RowScope.() -> Unit	A slot for providing the button's main label. The contents are expected to be text which is "start" aligned if there is an icon preset and "start" or "center" aligned if not.