← Compose Multiplatform Component in Jetpack Glance
RadioButton
Android
Adds a radio button to the glance view.
When showing a [Row] or [Column] that has [RadioButton] children, use [GlanceModifier.selectableGroup] to enable the radio group effect (unselecting the previously selected radio button when another is selected).
Last updated:
Installation
dependencies {
implementation("androidx.glance:glance-appwidget:1.1.0")
}
Overloads
@Composable
fun RadioButton(
checked: Boolean,
onClick: Action?,
modifier: GlanceModifier = GlanceModifier,
enabled: Boolean = true,
text: String = "",
style: TextStyle? = null,
colors: RadioButtonColors = RadioButtonDefaults.colors(),
maxLines: Int = Int.MAX_VALUE,
)
Parameters
| name | description |
|---|---|
checked | whether the radio button is checked |
onClick | the action to be run when the radio button is clicked |
modifier | the modifier to apply to the radio button |
enabled | if false, the radio button will not be clickable |
text | the text to display to the end of the radio button |
style | the style to apply to [text] |
colors | the color tint to apply to the radio button |
maxLines | An optional maximum number of lines for the text to span, wrapping if necessary. If the text exceeds the given number of lines, it will be truncated. |
@Composable
fun RadioButton(
checked: Boolean,
onClick: () -> Unit,
modifier: GlanceModifier = GlanceModifier,
enabled: Boolean = true,
text: String = "",
style: TextStyle? = null,
colors: RadioButtonColors = RadioButtonDefaults.colors(),
maxLines: Int = Int.MAX_VALUE,
)
Parameters
| name | description |
|---|---|
checked | whether the radio button is checked |
onClick | the action to be run when the radio button is clicked |
modifier | the modifier to apply to the radio button |
enabled | if false, the radio button will not be clickable |
text | the text to display to the end of the radio button |
style | the style to apply to [text] |
colors | the color tint to apply to the radio button |
maxLines | An optional maximum number of lines for the text to span, wrapping if necessary. If the text exceeds the given number of lines, it will be truncated. |
@Composable
@ExperimentalGlanceApi
fun RadioButton(
checked: Boolean,
onClick: () -> Unit,
modifier: GlanceModifier = GlanceModifier,
enabled: Boolean = true,
text: String = "",
style: TextStyle? = null,
colors: RadioButtonColors = RadioButtonDefaults.colors(),
maxLines: Int = Int.MAX_VALUE,
key: String? = null,
)
Parameters
| name | description |
|---|---|
checked | whether the radio button is checked |
onClick | the action to be run when the radio button is clicked |
modifier | the modifier to apply to the radio button |
enabled | if false, the radio button will not be clickable |
text | the text to display to the end of the radio button |
style | the style to apply to [text] |
colors | the color tint to apply to the radio button |
maxLines | An optional maximum number of lines for the text to span, wrapping if necessary. If the text exceeds the given number of lines, it will be truncated. |
key | A stable and unique key that identifies the action for this radio button. This ensures that the correct action is triggered, especially in cases of items that change order. If not provided we use the key that is automatically generated by the Compose runtime, which is unique for every exact code location in the composition tree. |
