toggleable

Functions summary

`Modifier`	`Modifier.toggleable( value: Boolean, enabled: Boolean, role: Role?, interactionSource: MutableInteractionSource?, onValueChange: (Boolean) -> Unit )` Configure component to make it toggleable via input and accessibility events	Cmn
`Modifier`	`Modifier.toggleable( value: Boolean, interactionSource: MutableInteractionSource?, indication: Indication?, enabled: Boolean, role: Role?, onValueChange: (Boolean) -> Unit )` Configure component to make it toggleable via input and accessibility events.	Cmn

Functions

Modifier.toggleable

Cmn

Artifact: androidx.compose.foundation:foundation

View Source

Added in 1.9.0

fun Modifier.toggleable(
    value: Boolean,
    enabled: Boolean = true,
    role: Role? = null,
    interactionSource: MutableInteractionSource? = null,
    onValueChange: (Boolean) -> Unit
): Modifier

Configure component to make it toggleable via input and accessibility events

This overload will use the Indication from LocalIndication. Use the other overload to explicitly provide an Indication instance. Note that this overload only supports IndicationNodeFactory instances provided through LocalIndication - it is strongly recommended to migrate to IndicationNodeFactory, but you can use the other overload if you still need to support Indication instances that are not IndicationNodeFactory.

If interactionSource is null, an internal MutableInteractionSource will be lazily created only when needed. This reduces the performance cost of toggleable during composition, as creating the indication can be delayed until there is an incoming androidx.compose.foundation.interaction.Interaction. If you are only passing a remembered MutableInteractionSource and you are never using it outside of toggleable, it is recommended to instead provide null to enable lazy creation. If you need the Indication to be created eagerly, provide a remembered MutableInteractionSource.

import androidx.compose.foundation.selection.toggleable
import androidx.compose.material.Text
import androidx.compose.runtime.mutableStateOf
import androidx.compose.runtime.remember
import androidx.compose.ui.Modifier

var checked by remember { mutableStateOf(false) }
// content that you want to make toggleable
Text(
    modifier = Modifier.toggleable(value = checked, onValueChange = { checked = it }),
    text = checked.toString(),
)

Parameters
`value: Boolean`	whether Toggleable is on or off
`enabled: Boolean = true`	whether or not this `toggleable` will handle input events and appear enabled for semantics purposes
`role: Role? = null`	the type of user interface element. Accessibility services might use this to describe the element or do customizations
`interactionSource: MutableInteractionSource? = null`	`MutableInteractionSource` that will be used to dispatch `PressInteraction.Press` when this toggleable is pressed. If `null`, an internal `MutableInteractionSource` will be created if needed.
`onValueChange: (Boolean) -> Unit`	callback to be invoked when toggleable is clicked, therefore the change of the state in requested.

See also
`triStateToggleable`	if you require support for an indeterminate state.

Modifier.toggleable

Cmn

Artifact: androidx.compose.foundation:foundation

View Source

Added in 1.0.0

fun Modifier.toggleable(
    value: Boolean,
    interactionSource: MutableInteractionSource?,
    indication: Indication?,
    enabled: Boolean = true,
    role: Role? = null,
    onValueChange: (Boolean) -> Unit
): Modifier

Configure component to make it toggleable via input and accessibility events.

If interactionSource is null, and indication is an IndicationNodeFactory, an internal MutableInteractionSource will be lazily created along with the indication only when needed. This reduces the performance cost of toggleable during composition, as creating the indication can be delayed until there is an incoming androidx.compose.foundation.interaction.Interaction. If you are only passing a remembered MutableInteractionSource and you are never using it outside of toggleable, it is recommended to instead provide null to enable lazy creation. If you need indication to be created eagerly, provide a remembered MutableInteractionSource.

If indication is not an IndicationNodeFactory, and instead implements the deprecated Indication.rememberUpdatedInstance method, you should explicitly pass a remembered MutableInteractionSource as a parameter for interactionSource instead of null, as this cannot be lazily created inside toggleable.

import androidx.compose.foundation.selection.toggleable
import androidx.compose.material.Text
import androidx.compose.runtime.mutableStateOf
import androidx.compose.runtime.remember
import androidx.compose.ui.Modifier

var checked by remember { mutableStateOf(false) }
// content that you want to make toggleable
Text(
    modifier = Modifier.toggleable(value = checked, onValueChange = { checked = it }),
    text = checked.toString(),
)

Parameters
`value: Boolean`	whether Toggleable is on or off
`interactionSource: MutableInteractionSource?`	`MutableInteractionSource` that will be used to dispatch `PressInteraction.Press` when this toggleable is pressed. If `null`, an internal `MutableInteractionSource` will be created if needed.
`indication: Indication?`	indication to be shown when modified element is pressed. Be default, indication from `LocalIndication` will be used. Pass `null` to show no indication, or current value from `LocalIndication` to show theme default
`enabled: Boolean = true`	whether or not this `toggleable` will handle input events and appear enabled for semantics purposes
`role: Role? = null`	the type of user interface element. Accessibility services might use this to describe the element or do customizations
`onValueChange: (Boolean) -> Unit`	callback to be invoked when toggleable is clicked, therefore the change of the state in requested.

See also
`triStateToggleable`	if you require support for an indeterminate state.