New-UDIcon

FontAwesome 6 icons.

Synopsis

FontAwesome 6 icons.

Syntax

New-UDIcon [-Id <String>] [-Icon <String>] [-FixedWidth] [-Inverse] [-Rotation <Int32>] [-ClassName <String>] [-Transform <String>] [-Flip <String>] [-Pull <String>] [-ListItem] [-Spin] [-Border] [-Beat] [-Fade] [-Bounce] [-BeatFade] [-Shake] [-Size <String>] [-Style <Hashtable>] [-Title <String>] [-Color <DashboardColor>] [-Solid] [<CommonParameters>]

    New-UDIcon [-Id <String>] [-Children <ScriptBlock>] [-ClassName <String>] [-Style <Hashtable>] [<CommonParameters>]

Description

Creates a new icon.

Parameters

-Id

The ID of this component.

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

-Icon

The Icon to display. This is a FontAwesome 6 icon name.

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

-Children

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

    -FixedWidth [<SwitchParameter>]
        Whether to use a fixed with.

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

    -Inverse [<SwitchParameter>]
        Whether to invert the colors of the icon.

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

-Rotation

The amount of degrees to rotate the icon.

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

-ClassName

Custom CSS class names to apply to the icon.

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

-Transform

A CSS transform to apply to the icon.

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

-Flip

Whether to flip the icon.

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

-Pull

Whether to flip the icon.

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

    -ListItem [<SwitchParameter>]

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

    -Spin [<SwitchParameter>]
        Whether the icon should spin.

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

    -Border [<SwitchParameter>]
        Defines the border for this icon.

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

    -Beat [<SwitchParameter>]

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

    -Fade [<SwitchParameter>]

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

    -Bounce [<SwitchParameter>]

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

    -BeatFade [<SwitchParameter>]

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

    -Shake [<SwitchParameter>]

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

-Size

The size of the icon. Valid values are: "xs", "sm", "lg", "1x", "2x", "3x", "4x", "5x", "6x", "7x", "8x", "9x", "10x"

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

-Style

A CSS style to apply to the icon.

Required?                    false
Position?                    named
Default value                @{}
Accept pipeline input?       false
Aliases
Accept wildcard characters?  false

-Title

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

-Color

The color of this icon.

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

    -Solid [<SwitchParameter>]
        Uses the solid icon style.

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

    <CommonParameters>
        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

-------------------------- EXAMPLE 1 --------------------------

PS >New-UDIcon -Icon User -Id 'icon1'

Basic Icon|Displays a user icon.




-------------------------- EXAMPLE 2 --------------------------

PS >New-UDStack -Direction 'row' -Content {
PS >    New-UDIcon -Icon 'AddressBook' -Size 'sm' -Id 'icon2'
PS >    New-UDIcon -Icon 'AddressBook' -Size 'lg' -Id 'icon3'
PS >    New-UDIcon -Icon 'AddressBook' -Size '5x' -Id 'icon4'
PS >    New-UDIcon -Icon 'AddressBook' -Size '10x' -Id 'icon5'
PS > }

Icon Size|Displays icons in different sizes.




-------------------------- EXAMPLE 3 --------------------------

PS >New-UDIcon -Icon 'AddressBook' -Size '5x' -Rotation 90 -Id 'icon6'

Rotated Icon|Rotates an icon 90 degrees.




-------------------------- EXAMPLE 4 --------------------------

PS >New-UDIcon -Icon 'AddressBook' -Size '5x' -Border -Id 'icon7'

Border Icon|Adds a border to an icon.




-------------------------- EXAMPLE 5 --------------------------

PS >New-UDIcon -Icon 'AddressBook' -Size '5x' -Color 'red' -Id 'icon8'

Color|Adds a color to an icon




-------------------------- EXAMPLE 6 --------------------------

PS >New-UDIcon -Icon 'AddressBook' -Flip 'horizontal' -Size '5x' -Id 'icon9'

Flip|Flips an icon horizontally.




-------------------------- EXAMPLE 7 --------------------------

PS >New-UDIcon -Icon 'Spinner' -Spin -Size '5x' -Id 'icon10'

Spin|Spins an icon.




-------------------------- EXAMPLE 8 --------------------------

PS >New-UDIcon -Icon 'Spinner' -Pulse -Size '5x' -Id 'icon11'

Pulse|Pulses an icon.




-------------------------- EXAMPLE 9 --------------------------

PS >New-UDHelmet -Tag 'link' -Attributes @{
PS >         href = 'https://css.gg/css'
PS >         rel = 'stylesheet'
PS >     }
PS >
PS >     New-UDIcon -Children {
PS >         New-UDHtml '<i class="gg-adidas"></i>'
PS >     }

Custom Icon Set|Uses the css.gg icon set.