New-UDDivider

A divider is a thin line that groups content in lists and layouts.

Synopsis

A divider is a thin line that groups content in lists and layouts.

Syntax

New-UDDivider [[-Id] <String>] [-Absolute] [[-Children] <ScriptBlock>] [-FlexItem] [-Light] [[-Orientation] <String>] [[-Sx] <Hashtable>] [[-TextAlign] <String>] [[-Variant] <String>] [<CommonParameters>]

Description

A divider is a thin line that groups content in lists and layouts.

Parameters

-Id

ID of this component.

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

    -Absolute [<SwitchParameter>]
        Absolutely position the element.

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

-Children

The content of the component.

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

    -FlexItem [<SwitchParameter>]
        If true, a vertical divider will have the correct height when used in flex container. (By default, a vertical divider will have a calculated height of 0px if it is the child of a flex container.)

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

    -Light [<SwitchParameter>]
        If true, the divider will have a lighter color.

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

-Orientation

The component orientation.

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

-Sx

Custom styling

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

-TextAlign

The text alignment.

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

-Variant

The variant to use.

Required?                    false
Position?                    6
Default value                fullWidth
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-UDDivider -Id 'divider1'

Basic Divider|Creates a basic divider.




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

PS >New-UDDivider -Id 'divider2' -Variant 'inset'
PS > New-UDDivider -Id 'divider3' -Variant 'middle'

Variants|Creates a divider with the inset and middle variants.




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

PS >New-UDDivider -Id 'divider4' -Orientation 'vertical'

Vertical Divider|Creates a vertical divider.




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

PS >New-UDDivider -Id 'divider5' -Light

Light Divider|Creates a light divider.




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

PS >New-UDDivider -Id 'divider6' -Children {
PS >    New-UDTypography -Text 'Examples'
PS > }

Divider with Text|Creates a divider with text.




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

PS >New-UDDivider -Id 'divider6' -Children {
PS >    New-UDTypography -Text 'Examples'
PS > } -TextAlign left

Algin Text|Creates a divider with text aligned to the left.