Skip to content

SusBtnToggle

SusBtnToggle

Exclusive (or multi) mode switch — a row of buttons backed by Items + Model.

Package

SusKit · Atoms (commercial)

Open in Playground

SusKit · Atoms

Props

NameTypeDefault
ModelProp<string>""v-model
MultipleProp<bool>falsev-model
MandatoryProp<bool>truev-model
DividedProp<bool>truev-model
DisabledProp<bool>falsev-model
ColorProp<string>"primary"v-model
VariantProp<string>"outlined"v-model
SizeProp<string>"small"v-model

Slots

No slots.

Events

NameFieldPayload
ChangeOnChangestring

Style hooks

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

  • sus-btn-toggle
  • sus-btn-toggle__btn
  • sus-btn-toggle__btn--first
  • sus-btn-toggle__btn--last
  • sus-btn-toggle__row
  • sus-btn-toggle--disabled
  • sus-btn-toggle--divided
  • sus-btn-toggle--multiple
  • sus-button--active
  • sus-button--color-danger
  • sus-button--color-info
  • sus-button--color-secondary
  • sus-button--color-success
  • sus-button--color-warning

Usage

csharp
var toggle = new SusBtnToggle();
toggle.Items.Value = new List<SusBtnToggle.BtnToggleItem>
{
    new() { Label = "List", Value = "list", Icon = "list" },
    new() { Label = "Grid", Value = "grid", Icon = "grid" },
    new() { Label = "Map", Value = "map", Icon = "map" },
};
toggle.Model.Value = "list";
toggle.Mandatory.Value = true;
toggle.Divided.Value = true;
toggle.Variant.Value = "outlined";
toggle.Size.Value = "small";
toggle.OnChange += value => { /* … */ };
PropRole
ItemsList<BtnToggleItem>Label, Value, Icon, Disabled
ModelSelected value (single mode)
Multiple / SelectionMulti-select mode + selected values
MandatoryKeep at least one selected
DividedVisual separators between buttons

Variant

elevated · flat · tonal · outlined · text · plain