Skip to content

SusCheckbox

SusCheckbox

Boolean control with label — checked, indeterminate, error text.

Package

SusKit · Atoms (commercial)

Open in Playground

SusKit · Atoms

Props

NameTypeDefault
ModelProp<bool>falsev-model
LabelProp<string>""v-model
ColorProp<string>"primary"v-model
DisabledProp<bool>falsev-model
ReadonlyProp<bool>falsev-model
IndeterminateProp<bool>falsev-model
DensityProp<string>"default"v-model
ErrorProp<string>""v-model
HideDetailsProp<string>"auto"v-model

Slots

No slots.

Events

NameFieldPayload
ChangeOnChangebool

Style hooks

USS class contract — override appearance without touching C#. States toggle via these classes:

  • keyboard-focus
  • sus-checkbox
  • sus-checkbox__details
  • sus-checkbox__icon
  • sus-checkbox__input
  • sus-checkbox__label
  • sus-checkbox--checked
  • sus-checkbox--danger
  • sus-checkbox--density-comfortable
  • sus-checkbox--density-compact
  • sus-checkbox--density-default
  • sus-checkbox--dirty
  • sus-checkbox--disabled
  • sus-checkbox--error
  • sus-checkbox--indeterminate
  • sus-checkbox--primary
  • sus-checkbox--readonly
  • sus-checkbox--secondary
  • sus-checkbox--success
  • sus-checkbox--warning

Usage

xml
<template>
  <sus:SusCheckbox Label="Accept terms"
                   :Model="Accepted.Value"
                   Color="primary"
                   @change="OnAccepted" />
</template>

<script>
public Prop<bool> Accepted = new(false);
void OnAccepted(bool value) { /* … */ }
</script>
csharp
var check = new SusCheckbox();
check.Label.Value = "Remember me";
check.Model.Value = false;
check.Color.Value = "primary";
check.OnChange += value => { /* … */ };
// Partial state: check.Indeterminate.Value = true;

Notes

  • Indeterminate shows the mixed state (e.g. “some children selected”).
  • Error + HideDetails follow the same form-field pattern as text inputs.