New-UDToggleButton

Synopsis

A Toggle Button can be used to group related options.

Syntax

New-UDToggleButton [[-Id] <String>] [[-Color] <String>] [-Disabled] [-FullWidth] [-DisableFocusRipple] [-DisableRipple] [[-Size] <String>] [[-Sx] <Hashtable>] [[-Children] <ScriptBlock>] [[-Aria] <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

-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

-DisableFocusRipple

If specified, the component will not show a focus ripple.

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

-DisableRipple

If specified, the component will not show a ripple.

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

-Size

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

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

-Sx

The style of the component.

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

-Children

The content of the component.

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

-Aria

A script block of New-UDAriaAttribute calls. The resulting ARIA or role attributes are applied to the toggle button.

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.