← Back to Components
Toggle Group
Segmented single or multiple toggle input for view switchers and toolbars.
Interactive Playground
R Code
API Reference
block_toggle_group()
Segmented toggle group for single or multiple pressed choices (view switchers, toolbars).
| Argument | Type | Default | Description |
|---|---|---|---|
| input_id | character | required | Input id; reports a string (single) or character vector (multiple). |
| choices | list | character | required | Choice labels and values. |
| selected | character | NULL | Initial pressed value(s); NULL starts released. |
| type | 'single' | 'multiple' | 'single' | Selection mode; create-only. |
| variant | 'default' | 'outline' | 'default' | Borderless or outlined segments. |
| size | 'default' | 'sm' | 'lg' | 'default' | Item height and padding. |
| icons | named list | NULL | Choice value to vendored icon name or shiny.tag mapping. |
| icon_only | logical | FALSE | Hide labels visually; labels become aria-label. Requires icons. |
| disabled | logical | character | FALSE | Disable the group, or listed choice values per item. |
| style | character | list | NULL | Inline CSS styles applied to the group wrapper. |
| class | character | NULL | Additional class merged onto the group wrapper. |
update_block_toggle_group()
Replaces pressed values, choices, icons, disabled state, variant, or size from the server.
| Argument | Type | Default | Description |
|---|---|---|---|
| session | ShinySession | required | Standard active R/Shiny session. |
| input_id | character | required | Target toggle group input ID. |
| selected | character | NULL | New pressed value(s); NULL releases everything. |
| choices | list | character | NULL | Replacement choices. |
| icons | named list | NULL | Icons for the replacement choices; requires choices. |
| disabled | logical | character | NULL | Group flag or per-item choice values. |
| variant | 'default' | 'outline' | NULL | New visual variant. |
| size | 'default' | 'sm' | 'lg' | NULL | New item size. |