Toggle¶
Toggle is Cortena's switch/toggle adjustment component, based on an interactive design with physics-based spring response.
Concept¶
The component is a custom pill-shaped switch featuring:
- A sliding capsule thumb that scales up dynamically (spring animation) when pressed, clicked, or dragged.
- Smooth color transition of the track background between the inactive and active states.
- Double-gesture support: tap to switch states, or drag the thumb horizontally. During a drag, the state changes as the thumb crosses the middle of the track.
- Proper accessibility semantics (
Role.Switch). - Fully unclipped drop shadows around the thumb that scale and follow the animation path correctly.
Toggle has one size, the Medium tier of the size scale, and ignores LocalSizeToken. It is built on the DragTrack primitive.
API Reference¶
@Composable
fun Toggle(
checked: Boolean,
onCheckedChange: ((Boolean) -> Unit)?,
modifier: Modifier = Modifier,
enabled: Boolean = true,
activeColor: Color = Color.Unspecified,
inactiveColor: Color = Color.Unspecified,
thumbColor: Color = Color.Unspecified,
)
Parameters¶
| Name | Data Type | Description |
|---|---|---|
checked |
Boolean |
Whether the toggle is active (checked) or inactive (unchecked). |
onCheckedChange |
((Boolean) -> Unit)? |
Called when the user taps the toggle, and during a drag each time the thumb crosses the middle. |
modifier |
Modifier |
Standard Compose modifier. |
enabled |
Boolean |
Disables clicks, gestures, and dims the toggle visually with an alpha when false. |
activeColor |
Color |
Track background color when active (checked = true). Default: success. |
inactiveColor |
Color |
Track background color when inactive (checked = false). Default: outline variant. |
thumbColor |
Color |
Color of the sliding inner thumb capsule. Default: white. |
Example¶
var isEnabled by rememberSaveable { mutableStateOf(false) }
Toggle(
checked = isEnabled,
onCheckedChange = { isEnabled = it }
)
Custom Colors¶
var isPremium by rememberSaveable { mutableStateOf(true) }
Toggle(
checked = isPremium,
onCheckedChange = { isPremium = it },
activeColor = Color(LocalColors.current.accent),
inactiveColor = Color(LocalColors.current.surfaceVariant),
thumbColor = Color.White
)