IconButton

Component in Tv Material Compose

Material Design standard icon button for TV.

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.

[content] should typically be an [Icon]. If using a custom icon, note that the typical size for the internal icon is 24 x 24 dp.

The default text style for internal [Text] components will be set to [Typography.labelLarge].

Last updated: 2024-10-22 13:47

Installation

dependencies {
   implementation("androidx.tv:tv-material:1.0.0")
}

Overloads

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

Parameters

name	description
onClick	called when this button is clicked.
modifier	the [Modifier] to be applied to this button.
onLongClick	called when this button 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 Example

IconButtonSample

@Composable
fun IconButtonSample() {
    IconButton(onClick = { /* doSomething() */ }) {
        Icon(Icons.Filled.Favorite, contentDescription = "Localized description")
    }
}