api/dev.s7a.strata.component/CheckboxState

CheckboxState

class CheckboxState(initialChecked: Boolean = false)(source)

Caller-owned owner-thread selected state for one Checkbox.

Distinct writes synchronously invalidate every attached retained observer. The state owns its boolean value but does not own attached component nodes.

Parameters

initialChecked

initial selected value.

Constructors

CheckboxState

constructor(initialChecked: Boolean = false)

Properties

checked

var checked: Boolean

Current selected value.

Functions

observe

fun observe(callback: (Boolean) -> Unit): ComponentStateSubscription

Installs one privileged retained observer.

toggle

fun toggle(): Boolean

Toggles and returns the next selected value.