New-UDDivider

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

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

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

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

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 Divider

New-UDDivider -Id 'divider1'

Creates a basic divider.

Example 2: Variants

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

Creates a divider with the inset and middle variants.

Example 3: Vertical Divider

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

Creates a vertical divider.

Example 4: Light Divider

New-UDDivider -Id 'divider5' -Light

Creates a light divider.

Example 5: Divider with Text

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

Creates a divider with text.

Example 6: Algin Text

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

Creates a divider with text aligned to the left.