New-UDIconButton

Synopsis

Creates a button with an icon.

Syntax

New-UDIconButton [[-Id] <String>] [[-Icon] <Object>] [[-OnClick] <Endpoint>] [-Disabled] [[-Href] <String>] [[-Style] <Hashtable>] [[-ClassName] <String>] [[-Size] <String>] [[-Variant] <String>] [-ShowLoading] [[-LoadingComponent] <ScriptBlock>] [[-Aria] <ScriptBlock>] [<CommonParameters>]

Description

Creates a button with an icon.

Parameters

-Id

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

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

-Icon

The icon to display within the button.

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

-OnClick

A script block to execute when the button is clicked.

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

-Disabled

Whether the button is disabled.

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

-Href

A link to navigate to when the button is clicked.

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

-Style

The CSS sytle to apply to the icon.

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

-ClassName

A CSS class to apply to the icon.

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

-Size

The size of the icon button. Valid values are: "small", "medium", "large"

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

-Variant

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

-ShowLoading

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

-LoadingComponent

Required?                    false
Position?                    9
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 this icon button. Provide an accessible label for icon-only controls, such as -Aria { New-UDAriaAttribute -Label -Value 'Open settings' }.

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 Icon Button

New-UDIconButton -Icon (New-UDIcon -Icon user -Size sm)  -Id 'iconButton1'

Creates a basic icon button.

Example 2: Icon Button with OnClick

New-UDIconButton -Icon (New-UDIcon -Icon user -Size sm) -OnClick {
   Show-UDToast -Message 'Icon Button Clicked'
} -Id 'iconButton2'

Creates an icon button with an OnClick script block.

Example 3: Icon Button with Href

New-UDIconButton -Icon (New-UDIcon -Icon user -Size sm) -Href 'https://www.google.com' -Id 'iconButton3'

Creates an icon button that navigates to a URL.

Example 4: Disabled Icon Button

New-UDIconButton -Icon (New-UDIcon -Icon user -Size sm) -Disabled -Id 'iconButton4'

Creates a disabled icon button.

Example 5: Icon Button with Loading

New-UDIconButton -Icon (New-UDIcon -Icon user -Size sm) -Id 'iconButton5' -OnClick {
   Show-UDToast -Message 'Icon Button Clicked'
   Start-Sleep -Seconds 5
} -ShowLoading

Creates an icon button with a loading spinner.