Skip to content

Toggle Group

Multiple toggle buttons in a group.

Installation

bash
flutter_studio add togglegroup
bash
flutter pub add flutter_studio

Usage

dart
CustomToggleGroup(
  options: ['Left', 'Center', 'Right'],
  selectedIndex: selectedAlignment,
  onChanged: (index) {
    setState(() {
      selectedAlignment = index;
    });
  },
)

Multiple Selection

dart
CustomToggleGroup(
  options: ['Bold', 'Italic', 'Underline'],
  multiSelect: true,
  selectedIndices: [0, 2], // Bold and Underline selected
  onMultiChanged: (indices) {
    setState(() {
      selectedIndices = indices;
    });
  },
)

API Reference

Properties

PropertyTypeDefaultDescription
optionsList<String>requiredToggle options
selectedIndexint?nullSelected option index
multiSelectboolfalseAllow multiple selections