Composables
Docs Login
Vela

Option Toggle

Jetpack Compose Component

Download
package com.composables.vela.components

import androidx.compose.animation.animateColorAsState
import androidx.compose.animation.core.tween
import androidx.compose.foundation.background
import androidx.compose.foundation.interaction.MutableInteractionSource
import androidx.compose.foundation.layout.fillMaxWidth
import androidx.compose.foundation.layout.padding
import androidx.compose.foundation.layout.size
import androidx.compose.runtime.Composable
import androidx.compose.runtime.getValue
import androidx.compose.runtime.remember
import androidx.compose.ui.Modifier
import androidx.compose.ui.draw.clip
import androidx.compose.ui.graphics.vector.ImageVector
import androidx.compose.ui.unit.dp
import com.composables.compose.ripple.rememberRippleIndication
import com.composables.vela.theme.LocalContentColor
import com.composables.vela.theme.Space
import com.composables.vela.theme.Theme
import com.composeunstyled.Thumb
import com.composeunstyled.Track
import com.composeunstyled.UnstyledSwitch

@Composable
fun OptionToggle(
    title: String,
    checked: Boolean,
    onCheckedChange: (Boolean) -> Unit,
    modifier: Modifier = Modifier,
    description: String? = null,
    icon: ImageVector? = null,
) {
    val track by
        animateColorAsState(
            if (checked) Theme.colors.primary else Theme.colors.border,
            tween(180),
            label = "Track",
        )
    val thumb by
        animateColorAsState(
            if (checked) Theme.colors.onPrimary else Theme.colors.onBackgroundMuted,
            tween(180),
            label = "Thumb",
        )
    UnstyledSwitch(
        checked = checked,
        onCheckedChange = onCheckedChange,
        modifier = modifier.fillMaxWidth(),
        interactionSource = remember { MutableInteractionSource() },
        indication = rememberRippleIndication(color = LocalContentColor.current),
        accessibilityLabel = title,
    ) {
        OptionLayout(
            title,
            description,
            icon,
            badge = null,
            modifier = Modifier.padding(horizontal = Space * 4, vertical = Space * 3),
        ) {
            Track(
                Modifier.size(width = 44.dp, height = 26.dp)
                    .clip(Theme.shapes.fullyRounded)
                    .background(track)
            ) {
                Thumb(
                    animationSpec = tween(180),
                    modifier =
                        Modifier.padding(4.dp)
                            .size(18.dp)
                            .clip(Theme.shapes.fullyRounded)
                            .background(thumb),
                )
            }
        }
    }
}

More components from Vela

by Alex Styl

Search screens and components

Screen flows

Screens

UI Elements

One Android lesson, every Wednesday

Building Android apps?

What Alex learned building Android apps for 14 years, so you don't have to. Reads in under a minute.

Join 3,500+ Android developers. Unsubscribe any time.

You're subscribed

The next lesson lands in on Wednesday.