> For the complete documentation index, see [llms.txt](https://docs.devolutions.net/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.devolutions.net/powershell-universal/powershell-commands/new-udtogglebuttongroup.md).

# New-UDToggleButtonGroup

New-UDToggleButtonGroup groups multiple New-UDToggleButton controls in PowerShell Universal so users can select one or more related options.

### Synopsis

A Toggle Button can be used to group related options.

### Syntax

```powershell
New-UDToggleButtonGroup [[-Id] <String>] [[-Color] <String>] [-Disabled] [-Exclusive] [-FullWidth] [[-OnChange] <Endpoint>] [[-Size] <String>] [[-Orientation] <String>] [[-Sx] <Hashtable>] [[-Value] <String[]>] [-Children] <ScriptBlock> [<CommonParameters>]
```

### Description

A Toggle Button can be used to group related options.

### Parameters

#### -Id

The ID of the component. If not specified, a random GUID will be assigned.

```
Required?                    false
Position?                    1
Default value                [Guid]::NewGuid().ToString()
Accept pipeline input?       false
Aliases
Accept wildcard characters?  false
```

#### -Color

The color of the component. Valid values are 'standard', 'primary', 'secondary', 'error', 'info', 'success', 'warning'.

```
Required?                    false
Position?                    2
Default value                standard
Accept pipeline input?       false
Aliases
Accept wildcard characters?  false
```

#### -Disabled

If specified, the component will be disabled.

```
Required?                    false
Position?                    named
Default value                False
Accept pipeline input?       false
Aliases
Accept wildcard characters?  false
```

#### -Exclusive

If specified, the component will only allow a single selection.

```
Required?                    false
Position?                    named
Default value                False
Accept pipeline input?       false
Aliases
Accept wildcard characters?  false
```

#### -FullWidth

If specified, the component will take up the full width of its container.

```
Required?                    false
Position?                    named
Default value                False
Accept pipeline input?       false
Aliases
Accept wildcard characters?  false
```

#### -OnChange

The endpoint to call when the value of the component changes.

```
Required?                    false
Position?                    3
Default value
Accept pipeline input?       false
Aliases
Accept wildcard characters?  false
```

#### -Size

The size of the component. Valid values are 'small', 'medium', 'large'.

```
Required?                    false
Position?                    4
Default value                medium
Accept pipeline input?       false
Aliases
Accept wildcard characters?  false
```

#### -Orientation

The orientation of the component. Valid values are 'horizontal', 'vertical'.

```
Required?                    false
Position?                    5
Default value                horizontal
Accept pipeline input?       false
Aliases
Accept wildcard characters?  false
```

#### -Sx

The style of the component.

```
Required?                    false
Position?                    6
Default value
Accept pipeline input?       false
Aliases
Accept wildcard characters?  false
```

#### -Value \<String\[]>

The value of the component.

```
Required?                    false
Position?                    7
Default value
Accept pipeline input?       false
Aliases
Accept wildcard characters?  false
```

#### -Children

The content of the component. Use New-UDToggleButton to create toggle buttons.

```
Required?                    true
Position?                    8
Default value
Accept pipeline input?       false
Aliases
Accept wildcard characters?  false
```

#### Common parameters

This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable, OutBuffer, PipelineVariable, and OutVariable. For more information, see [about\_CommonParameters](https://go.microsoft.com/fwlink/?LinkID=113216).

### Outputs

### Examples

#### Example 1: Exclusive selection

```powershell
New-UDToggleButtonGroup -Content {
    New-UDToggleButton -Content {
        New-UDIcon -Icon 'User'
    }
    New-UDToggleButton -Content {
        New-UDIcon -Icon 'User'
    }
    New-UDToggleButton -Content {
        New-UDIcon -Icon 'User'
    } -Id 'test'
} -Exclusive
```

With exclusive selection, selecting one option deselects any other.

#### Example 2: Multiple selection

```powershell
New-UDToggleButtonGroup -Content {
    New-UDToggleButton -Content {
        New-UDIcon -Icon 'User'
    }
    New-UDToggleButton -Content {
        New-UDIcon -Icon 'User'
    }
    New-UDToggleButton -Content {
        New-UDIcon -Icon 'User'
    } -Id 'test'
}
```

With multiple selection, selecting one option does not deselect any other.

#### Example 3: Size

```powershell
New-UDToggleButtonGroup -Content {
    New-UDToggleButton -Content {
        New-UDIcon -Icon 'User'
    }
    New-UDToggleButton -Content {
        New-UDIcon -Icon 'User'
    }
    New-UDToggleButton -Content {
        New-UDIcon -Icon 'User'
    } -Id 'test'
} -Size 'small'
```

The small size is equivalent to the dense toggle button styling.

#### Example 4: Orientation

```powershell
New-UDToggleButtonGroup -Content {
    New-UDToggleButton -Content {
        New-UDIcon -Icon 'User'
    }
    New-UDToggleButton -Content {
        New-UDIcon -Icon 'User'
    }
    New-UDToggleButton -Content {
        New-UDIcon -Icon 'User'
    } -Id 'test'
} -Orientation 'vertical'
```

The vertical orientation can be used to display a column of toggle buttons.

#### Example 5: OnChange

```powershell
New-UDToggleButtonGroup -Content {
    New-UDToggleButton -Content {
        New-UDIcon -Icon 'User'
    }
    New-UDToggleButton -Content {
        New-UDIcon -Icon 'User'
    }
    New-UDToggleButton -Content {
        New-UDIcon -Icon 'User'
    } -Id 'test'
} -OnChange {
    Show-UDToast -Message "You selected $EventData"
}
```

The OnChange endpoint is called when the value of the component changes. The event data is the value of the component.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.devolutions.net/powershell-universal/powershell-commands/new-udtogglebuttongroup.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.