New-UDSwitch

Synopsis

Creates a new switch.

Syntax

New-UDSwitch [[-Id] <String>] [-Disabled] [[-OnChange] <Endpoint>] [[-Checked] <Boolean>] [[-ClassName] <String>] [[-Color] <String>] [[-Label] <String>] [[-LabelComponent] <Hashtable>] [[-CheckedLabel] <String>] [[-CheckedLabelComponent] <Hashtable>] [[-UncheckedLabel] <String>] [[-UncheckedLabelComponent] <Hashtable>] [[-Size] <String>] [[-LabelPlacement] <String>] [-CheckStyle] [[-Sx] <Hashtable>] [[-Style] <Hashtable>] [[-Aria] <ScriptBlock>] [<CommonParameters>]

Description

Creates a new switch. A switch behaves like a checkbox but looks a little different.

Parameters

-Id

The ID of the component. It defaults to a random GUID.

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

-Disabled

Whether this switch is disabled.

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

-OnChange

A script block that is called when this switch changes. The $EventData variable will contain the checked value ($true$false).

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

-Checked

Whether this switch is checked.

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

-ClassName

A CSS class to apply to the switch.

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

-Color

The theme color to apply to this switch.

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

-Label

The label to display next to the switch

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

-LabelComponent

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

-CheckedLabel

The label to display for when the switch is checked

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

-CheckedLabelComponent

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

-UncheckedLabel

The label to display for when the switch is unchecked

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

-UncheckedLabelComponent

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

-Size

The size of the switch. Valid values are: "small", "medium"

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

-LabelPlacement

The placement of the label. Valid values are: "top", "start", "right", "bottom"

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

-CheckStyle

Style switch with check and unchecked icons for the colorblind.

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

-Sx

A hashtable of theme-based styles to apply to the switch.

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

-Style

A hashtable of styles to apply to the switch.

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

-Aria

A script block of New-UDAriaAttribute calls that supplies ARIA or role attributes for the switch.

Required?                    false
Position?                    named
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.

Outputs

Examples

Example 1: Basic switch

New-UDSwitch -Id 'switch1' -Checked $true

Creates a basic switch.

Example 2: OnChange

New-UDSwitch -Id 'switch2' -Checked $true -OnChange {
    Show-UDToast -Message "Switch changed to $($EventData)"
}

Creates a switch with an OnChange script block.

Example 3: Disabled

New-UDSwitch -Id 'switch3' -Disabled

Creates a disabled switch.

Example 4: Label

New-UDSwitch -Id 'switch4' -Checked $true -Label 'On' -UncheckedLabel 'Off'

Creates a switch with a label.

Example 5: Label Placement

New-UDSwitch -Id 'switch5' -Checked $true -Label 'On' -UncheckedLabel 'Off' -LabelPlacement 'bottom'

Creates a switch with a label and a label placement.

Example 6: Check Style

New-UDSwitch -Id 'switch6' -Checked $true -Label 'On' -UncheckedLabel 'Off' -LabelPlacement 'bottom' -CheckStyle

Creates a switch with a label, a label placement, and a check style.