OutlinedIconButton

Functions summary

`Unit`	`@Composable OutlinedIconButton( onClick: () -> Unit, modifier: Modifier, enabled: Boolean, shape: Shape, colors: IconButtonColors, border: BorderStroke?, interactionSource: MutableInteractionSource?, content: @Composable () -> Unit )` Material Design outlined icon button	Cmn
`Unit`	`@ExperimentalMaterial3ExpressiveApi @Composable OutlinedIconButton( onClick: () -> Unit, shapes: IconButtonShapes, modifier: Modifier, enabled: Boolean, colors: IconButtonColors, border: BorderStroke?, interactionSource: MutableInteractionSource?, content: @Composable () -> Unit )` Material Design outlined icon button	Cmn

Functions

OutlinedIconButton

Cmn

Artifact: androidx.compose.material3:material3

View Source

Added in 1.0.0

@Composable
fun OutlinedIconButton(
    onClick: () -> Unit,
    modifier: Modifier = Modifier,
    enabled: Boolean = true,
    shape: Shape = IconButtonDefaults.outlinedShape,
    colors: IconButtonColors = IconButtonDefaults.outlinedIconButtonColors(),
    border: BorderStroke? = IconButtonDefaults.outlinedIconButtonBorder(enabled),
    interactionSource: MutableInteractionSource? = null,
    content: @Composable () -> Unit
): Unit

Material Design outlined icon button

Icon buttons help people take supplementary actions with a single tap. They’re used when a compact button is required, such as in a toolbar or image list.

Use this "contained" icon button when the component requires more visual separation from the background.

content should typically be an Icon (see androidx.compose.material3.internal.Icons). If using a custom icon, note that the typical size for the internal icon is 24 x 24 dp. The outlined icon button has an overall minimum touch target size of 48 x 48dp, to meet accessibility guidelines.

import androidx.compose.material.icons.Icons
import androidx.compose.material.icons.filled.Lock
import androidx.compose.material.icons.outlined.Lock
import androidx.compose.material3.Icon
import androidx.compose.material3.IconButton
import androidx.compose.material3.OutlinedIconButton
import androidx.compose.material3.PlainTooltip
import androidx.compose.material3.Text
import androidx.compose.material3.TooltipAnchorPosition
import androidx.compose.material3.TooltipBox
import androidx.compose.material3.TooltipDefaults
import androidx.compose.material3.rememberTooltipState
import androidx.compose.runtime.remember

val description = "Localized description"
// Icon button should have a tooltip associated with it for a11y.
TooltipBox(
    positionProvider =
        TooltipDefaults.rememberTooltipPositionProvider(TooltipAnchorPosition.Above),
    tooltip = { PlainTooltip { Text(description) } },
    state = rememberTooltipState(),
) {
    OutlinedIconButton(onClick = { /* doSomething() */ }) {
        Icon(Icons.Filled.Lock, contentDescription = description)
    }
}

Large-sized uniform rounded shape

import androidx.compose.foundation.layout.size
import androidx.compose.material.icons.Icons
import androidx.compose.material.icons.filled.Lock
import androidx.compose.material.icons.outlined.Lock
import androidx.compose.material3.Icon
import androidx.compose.material3.IconButton
import androidx.compose.material3.IconButtonDefaults
import androidx.compose.material3.OutlinedIconButton
import androidx.compose.material3.PlainTooltip
import androidx.compose.material3.Text
import androidx.compose.material3.TooltipAnchorPosition
import androidx.compose.material3.TooltipBox
import androidx.compose.material3.TooltipDefaults
import androidx.compose.material3.rememberTooltipState
import androidx.compose.runtime.remember
import androidx.compose.ui.Modifier

val description = "Localized description"
// Icon button should have a tooltip associated with it for a11y.
TooltipBox(
    positionProvider =
        TooltipDefaults.rememberTooltipPositionProvider(TooltipAnchorPosition.Above),
    tooltip = { PlainTooltip { Text(description) } },
    state = rememberTooltipState(),
) {
    OutlinedIconButton(
        onClick = { /* doSomething() */ },
        modifier = Modifier.size(IconButtonDefaults.largeContainerSize()),
        shape = IconButtonDefaults.largeRoundShape,
    ) {
        Icon(
            Icons.Filled.Lock,
            contentDescription = description,
            modifier = Modifier.size(IconButtonDefaults.largeIconSize),
        )
    }
}

Parameters
`onClick: () -> Unit`	called when this icon button is clicked
`modifier: Modifier = Modifier`	the `Modifier` to be applied to this icon button
`enabled: Boolean = true`	controls the enabled state of this icon button. When `false`, this component will not respond to user input, and it will appear visually disabled and disabled to accessibility services.
`shape: Shape = IconButtonDefaults.outlinedShape`	defines the shape of this icon button's container and border (when `border` is not null)
`colors: IconButtonColors = IconButtonDefaults.outlinedIconButtonColors()`	`IconButtonColors` that will be used to resolve the colors used for this icon button in different states. See `IconButtonDefaults.outlinedIconButtonVibrantColors` and `IconButtonDefaults.outlinedIconButtonColors`.
`border: BorderStroke? = IconButtonDefaults.outlinedIconButtonBorder(enabled)`	the border to draw around the container of this icon button. Pass `null` for no border. See `IconButtonDefaults.outlinedIconButtonBorder` and `IconButtonDefaults.outlinedIconButtonBorder`.
`interactionSource: MutableInteractionSource? = null`	an optional hoisted `MutableInteractionSource` for observing and emitting `Interaction`s for this icon button. You can use this to change the icon button's appearance or preview the icon button in different states. Note that if `null` is provided, interactions will still happen internally.
`content: @Composable () -> Unit`	the content of this icon button, typically an `Icon`

OutlinedIconButton

Cmn

Artifact: androidx.compose.material3:material3

View Source

Added in 1.5.0-alpha16

@ExperimentalMaterial3ExpressiveApi
@Composable
fun OutlinedIconButton(
    onClick: () -> Unit,
    shapes: IconButtonShapes,
    modifier: Modifier = Modifier,
    enabled: Boolean = true,
    colors: IconButtonColors = IconButtonDefaults.outlinedIconButtonColors(),
    border: BorderStroke? = IconButtonDefaults.outlinedIconButtonBorder(enabled),
    interactionSource: MutableInteractionSource? = null,
    content: @Composable () -> Unit
): Unit

Material Design outlined icon button

Icon buttons help people take supplementary actions with a single tap. They’re used when a compact button is required, such as in a toolbar or image list.

Outlined icon button
image

Icon buttons help people take supplementary actions with a single tap. They’re used when a compact button is required, such as in a toolbar or image list.

Use this "contained" icon button when the component requires more visual separation from the background.

Toggleable filled tonal icon button with animatable shape sample:

import androidx.compose.material.icons.Icons
import androidx.compose.material.icons.filled.Lock
import androidx.compose.material.icons.outlined.Lock
import androidx.compose.material3.Icon
import androidx.compose.material3.IconButton
import androidx.compose.material3.IconButtonDefaults
import androidx.compose.material3.OutlinedIconButton
import androidx.compose.material3.PlainTooltip
import androidx.compose.material3.Text
import androidx.compose.material3.TooltipAnchorPosition
import androidx.compose.material3.TooltipBox
import androidx.compose.material3.TooltipDefaults
import androidx.compose.material3.rememberTooltipState
import androidx.compose.runtime.remember

val description = "Localized description"
// Icon button should have a tooltip associated with it for a11y.
TooltipBox(
    positionProvider =
        TooltipDefaults.rememberTooltipPositionProvider(TooltipAnchorPosition.Above),
    tooltip = { PlainTooltip { Text(description) } },
    state = rememberTooltipState(),
) {
    OutlinedIconButton(
        onClick = { /* doSomething() */ },
        shapes = IconButtonDefaults.shapes(),
    ) {
        Icon(Icons.Filled.Lock, contentDescription = description)
    }
}

Parameters
`onClick: () -> Unit`	called when this icon button is clicked
`shapes: IconButtonShapes`	the `IconButtonShapes` that the icon button will morph between depending on the user's interaction with the icon button.
`modifier: Modifier = Modifier`	the `Modifier` to be applied to this icon button
`enabled: Boolean = true`	controls the enabled state of this icon button. When `false`, this component will not respond to user input, and it will appear visually disabled and disabled to accessibility services.
`colors: IconButtonColors = IconButtonDefaults.outlinedIconButtonColors()`	`IconButtonColors` that will be used to resolve the colors used for this icon button in different states. See `IconButtonDefaults.outlinedIconButtonVibrantColors` and `IconButtonDefaults.outlinedIconButtonColors`.
`border: BorderStroke? = IconButtonDefaults.outlinedIconButtonBorder(enabled)`	the border to draw around the container of this icon button. Pass `null` for no border. See `IconButtonDefaults.outlinedIconButtonBorder` and `IconButtonDefaults.outlinedIconButtonBorder`.
`interactionSource: MutableInteractionSource? = null`	an optional hoisted `MutableInteractionSource` for observing and emitting `Interaction`s for this icon button. You can use this to change the icon button's appearance or preview the icon button in different states. Note that if `null` is provided, interactions will still happen internally.
`content: @Composable () -> Unit`	the content of this icon button, typically an `Icon`