triStateToggleable

Functions summary

`Modifier`	`Modifier.triStateToggleable( state: ToggleableState, enabled: Boolean, role: Role?, interactionSource: MutableInteractionSource?, onClick: () -> Unit )` Configure component to make it toggleable via input and accessibility events with three states: On, Off and Indeterminate.	Cmn
`Modifier`	`Modifier.triStateToggleable( state: ToggleableState, interactionSource: MutableInteractionSource?, indication: Indication?, enabled: Boolean, role: Role?, onClick: () -> Unit )` Configure component to make it toggleable via input and accessibility events with three states: On, Off and Indeterminate.	Cmn

Functions

Modifier.triStateToggleable

Cmn

Artifact: androidx.compose.foundation:foundation

View Source

Added in 1.9.0

fun Modifier.triStateToggleable(
    state: ToggleableState,
    enabled: Boolean = true,
    role: Role? = null,
    interactionSource: MutableInteractionSource? = null,
    onClick: () -> Unit
): Modifier

Configure component to make it toggleable via input and accessibility events with three states: On, Off and Indeterminate.

TriStateToggleable should be used when there are dependent Toggleables associated to this component and those can have different values.

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 triStateToggleable 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 triStateToggleable, 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.foundation.selection.triStateToggleable
import androidx.compose.material.Text
import androidx.compose.runtime.mutableStateOf
import androidx.compose.runtime.remember
import androidx.compose.ui.Modifier
import androidx.compose.ui.state.ToggleableState

var checked by remember { mutableStateOf(ToggleableState.Indeterminate) }
// content that you want to make toggleable
Text(
    modifier =
        Modifier.triStateToggleable(
            state = checked,
            onClick = {
                checked =
                    if (checked == ToggleableState.On) ToggleableState.Off
                    else ToggleableState.On
            },
        ),
    text = checked.toString(),
)

Parameters
`state: ToggleableState`	current value for the component
`enabled: Boolean = true`	whether or not this `triStateToggleable` 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.
`onClick: () -> Unit`	will be called when user clicks the toggleable.

See also
`toggleable`	if you want to support only two states: on and off

Modifier.triStateToggleable

Cmn

Artifact: androidx.compose.foundation:foundation

View Source

Added in 1.0.0

fun Modifier.triStateToggleable(
    state: ToggleableState,
    interactionSource: MutableInteractionSource?,
    indication: Indication?,
    enabled: Boolean = true,
    role: Role? = null,
    onClick: () -> Unit
): Modifier

Configure component to make it toggleable via input and accessibility events with three states: On, Off and Indeterminate.

TriStateToggleable should be used when there are dependent Toggleables associated to this component and those can have different values.

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 triStateToggleable 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 triStateToggleable, 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 triStateToggleable.

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

var checked by remember { mutableStateOf(ToggleableState.Indeterminate) }
// content that you want to make toggleable
Text(
    modifier =
        Modifier.triStateToggleable(
            state = checked,
            onClick = {
                checked =
                    if (checked == ToggleableState.On) ToggleableState.Off
                    else ToggleableState.On
            },
        ),
    text = checked.toString(),
)

Parameters
`state: ToggleableState`	current value for the component
`interactionSource: MutableInteractionSource?`	`MutableInteractionSource` that will be used to dispatch `PressInteraction.Press` when this triStateToggleable 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 `triStateToggleable` 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
`onClick: () -> Unit`	will be called when user clicks the toggleable.

See also
`toggleable`	if you want to support only two states: on and off