utils/dev.kindling.utils.method/KToggle

KToggle

class KToggle(defaultValue: Boolean = false)(source)

A boolean toggle with optional forced-set support.

Port of the useToggle React hook.

val toggle = Toggle(defaultValue = false)
toggle.toggle()       // → true
toggle.toggle()       // → false
toggle.set(true)      // → true
toggle.set(false)     // → false

toggle.state.collect { enabled -> applyTheme(enabled) }

Parameters

defaultValue

Initial state. Default: false.

Constructors

KToggle

constructor(defaultValue: Boolean = false)

Properties

state

val state: StateFlow<Boolean>

The current toggle value as a StateFlow.

value

val value: Boolean

The current toggle value.

Functions

set

fun set(newValue: Boolean)

Forces the value to newValue.

toggle

fun toggle()

Flips the current value.

toString

open override fun toString(): String