OutlinedIconButton

Composable Component

Material Design standard icon button for TV.

Android

@Composable
fun OutlinedIconButton(
    onClick: () -> Unit,
    modifier: Modifier = Modifier,
    onLongClick: (() -> Unit)? = null,
    enabled: Boolean = true,
    scale: ButtonScale = OutlinedIconButtonDefaults.scale(),
    glow: ButtonGlow = OutlinedIconButtonDefaults.glow(),
    shape: ButtonShape = OutlinedIconButtonDefaults.shape(),
    colors: ButtonColors = OutlinedIconButtonDefaults.colors(),
    border: ButtonBorder = OutlinedIconButtonDefaults.border(),
    interactionSource: MutableInteractionSource? = null,
    content: @Composable BoxScope.() -> Unit
)

Parameters


onClick	called when this button is clicked.
modifier	the `Modifier` to be applied to this button.
onLongClick	called when this card is long clicked (long-pressed).
enabled	controls the enabled state of this button. When `false`, this component will not respond to user input, and it will appear visually disabled and disabled to accessibility services.
scale	Defines size of the Button relative to its original size
glow	Shadow to be shown behind the Button.
shape	Defines the Button's shape.
colors	Color to be used for background and content of the Button
border	Defines a border around the Button.
interactionSource	an optional hoisted `MutableInteractionSource` for observing and emitting `Interaction`s 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.
content	the content of the button, typically an `Icon`

Code Examples

OutlinedIconButtonSample

@Composable
fun OutlinedIconButtonSample() {
    OutlinedIconButton(onClick = { /* doSomething() */ }) {
        Icon(Icons.Outlined.FavoriteBorder, contentDescription = "Localized description")
    }
}

Create your own Component Library

Material Components are meant to be used as is and they do not allow customizations. To build your own Jetpack Compose component library use Compose Unstyled