← Back to Tv Material
WideButton
Overview
Examples
Community Notes
Video
Material Design wide button for TV.
@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 interactionSource the MutableInteractionSource representing the stream of Interactions for this button. You can create and pass in your own remembered instance to observe Interactions and customize the appearance / behavior of this button in different states. @param background the background to be applied to the WideButton @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 contentColor Color to be used for the text content of the Button @param tonalElevation tonal elevation used to apply a color shift to the button to give the it higher emphasis @param border Defines a border around the Button. @param contentPadding the spacing values to apply internally between the container and the content @param content the content of the button
Overloads
WideButton
@ExperimentalTvMaterial3Api
@NonRestartableComposable
@Composable
fun WideButton(
onClick: () -> Unit,
modifier: Modifier = Modifier,
enabled: Boolean = true,
interactionSource: MutableInteractionSource = remember { MutableInteractionSource() },
background: @Composable () -> Unit = {
WideButtonDefaults.Background(
enabled = enabled,
interactionSource = interactionSource,
)
},
scale: ButtonScale = WideButtonDefaults.scale(),
glow: ButtonGlow = WideButtonDefaults.glow(),
shape: ButtonShape = WideButtonDefaults.shape(),
contentColor: WideButtonContentColor = WideButtonDefaults.contentColor(),
tonalElevation: Dp = Elevation.Level0,
border: ButtonBorder = WideButtonDefaults.border(),
contentPadding: PaddingValues = WideButtonDefaults.ContentPadding,
content: @Composable RowScope.() -> 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. |
interactionSource | the MutableInteractionSource representing the stream of Interactions for this button. You can create and pass in your own remembered instance to observe Interactions and customize the appearance / behavior of this button in different states. |
background | the background to be applied to the WideButton |
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. |
contentColor | Color to be used for the text content of the Button |
tonalElevation | tonal elevation used to apply a color shift to the button to give the it higher emphasis |
border | Defines a border around the Button. |
contentPadding | the spacing values to apply internally between the container and the content |
content | the content of the butto |
WideButton
@ExperimentalTvMaterial3Api
@NonRestartableComposable
@Composable
fun WideButton(
onClick: () -> Unit,
title: @Composable () -> Unit,
modifier: Modifier = Modifier,
enabled: Boolean = true,
icon: (@Composable () -> Unit)? = null,
subtitle: (@Composable () -> Unit)? = null,
interactionSource: MutableInteractionSource = remember { MutableInteractionSource() },
background: @Composable () -> Unit = {
WideButtonDefaults.Background(
enabled = enabled,
interactionSource = interactionSource
)
},
scale: ButtonScale = WideButtonDefaults.scale(),
glow: ButtonGlow = WideButtonDefaults.glow(),
shape: ButtonShape = WideButtonDefaults.shape(),
contentColor: WideButtonContentColor = WideButtonDefaults.contentColor(),
tonalElevation: Dp = Elevation.Level0,
border: ButtonBorder = WideButtonDefaults.border(),
contentPadding: PaddingValues = WideButtonDefaults.ContentPadding,
)
Parameters
| Name | Description |
|---|---|
onClick | called when this button is clicked |
title | the title content of the button, typically a Text |
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. |
icon | the leading icon content of the button, typically an Icon |
subtitle | the subtitle content of the button, typically a Text |
interactionSource | the MutableInteractionSource representing the stream of Interactions for this button. You can create and pass in your own remembered instance to observe Interactions and customize the appearance / behavior of this button in different states. |
background | the background to be applied to the WideButton |
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. |
contentColor | Color to be used for the text content of the Button |
tonalElevation | tonal elevation used to apply a color shift to the button to give the it higher emphasis |
border | Defines a border around the Button. |
contentPadding | the spacing values to apply internally between the container and the conten |
