Logo FS-Skia-UI

CheckBox Module

Builders for the `CheckBox` control — a labelled boolean toggle with a tick box.

Functions and values

Function or value Description

checked' arg1

Full Usage: checked' arg1

Parameters:
    arg0 : bool

Returns: Attr<'msg>
Type parameters: 'msg

Set the checked state of a `CheckBox` (`Attr.checked'`; `true` ticks the box). This is a controlled value — drive it from model state and reconcile via `onChanged`.

arg0 : bool
Returns: Attr<'msg>

create arg1

Full Usage: create arg1

Parameters:
    arg0 : Attr<'msg> list

Returns: Control<'msg>
Type parameters: 'msg

Build a `CheckBox` from its attributes; pair with `CheckBox.checked'` and `onChanged`. The typed `Props` front door (`FS.Skia.UI.Controls.Typed`) is the recommended authoring path.

arg0 : Attr<'msg> list
Returns: Control<'msg>

onChanged arg1

Full Usage: onChanged arg1

Parameters:
    arg0 : bool -> 'msg

Returns: Attr<'msg>
Type parameters: 'msg

Emit a `'msg` carrying the new `bool` when a `CheckBox` is toggled (`Attr.onChanged`).

arg0 : bool -> 'msg
Returns: Attr<'msg>

text arg1

Full Usage: text arg1

Parameters:
    arg0 : string

Returns: Attr<'msg>
Type parameters: 'msg

Set the label beside a `CheckBox` (`Attr` carrying the descriptive caption text).

arg0 : string
Returns: Attr<'msg>

Type something to start searching.