← Back to Tv Material
OutlinedIconButton
Overview
Examples
Community Notes
Video
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. This icon button has an overall minimum touch target size of 48 x 48dp, to meet accessibility guidelines.
The default text style for internal Text components will be set to Typography.labelLarge.
@param onClick called when this button is clicked @param modifier the Modifier to be applied to this button @param 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. @param scale Defines size of the Button relative to its original size @param glow Shadow to be shown behind the Button. @param shape Defines the Button's shape. @param colors Color to be used for background and content of the Button @param border Defines a border around the Button. @param interactionSource the MutableInteractionSource representing the stream of Interactions for this button. You can create and pass in your own remember
ed instance to observe Interactions and customize the appearance / behavior of this button in different states. @param content the content of the button, typically an Icon
Overloads
OutlinedIconButton
@ExperimentalTvMaterial3Api
@NonRestartableComposable
@Composable
fun OutlinedIconButton(
onClick: () -> Unit,
modifier: Modifier = Modifier,
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 = remember { MutableInteractionSource() },
content: @Composable BoxScope.() -> Unit
)
Parameters
Name | Description |
---|---|
onClick | called when this button is clicked |
modifier | the Modifier to be applied to this button |
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 | the MutableInteractionSource representing the stream of Interactions for this button. You can create and pass in your own remember ed instance to observe Interactions and customize the appearance / behavior of this button in different states. |
content | the content of the button, typically an Icon |