New-UDAppBar

Creates an AppBar.

Synopsis

Creates an AppBar.

Syntax

New-UDAppBar [[-Id] <String>] [[-Drawer] <Hashtable>] [[-Children] <ScriptBlock>] [[-Position] <String>] [-Footer] [-DisableThemeToggle] [[-ClassName] <String>] [[-Color] <String>] [<CommonParameters>]

Description

Creates an AppBar. This can be used to replace the built-in AppBar.

Parameters

-Id

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

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

-Drawer

A drawer that can be opened from this AppBar. Use New-UDDrawer to create a drawer to pass to this parameter.

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

-Children

Children of this AppBar. The children of an AppBar are commonly text and buttons.

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

-Position

The position of this AppBar. A fixed position will override the default AppBar.

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

    -Footer [<SwitchParameter>]
        Positions the app bar at the bottom of the page to create a footer

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

    -DisableThemeToggle [<SwitchParameter>]
        Removes the theme toggle switch from the app bar.

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

-ClassName

A CSS class to apply to the app bar.

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

-Color

The theme color to use for the app bar.

Required?                    false
Position?                    6
Default value                default
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-UDAppBar -Children { New-UDTypography -Text 'Hello' } -Position relative

Basic App Bar|Creates a new AppBar that is relative to other components.




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

PS >New-UDAppBar -Children { New-UDTypography -Text 'Hello' } -Position relative -Drawer (New-UDDrawer -Content { New-UDTypography -Text 'Drawer' })

App Bar with Drawer|Creates a new AppBar with a drawer.




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

PS >New-UDAppBar -Children { New-UDTypography -Text 'Hello' } -Position relative -DisableThemeToggle

App Bar with no theme toggle|Creates a new AppBar with no theme toggle switch.




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

PS >New-UDAppBar -Children { New-UDTypography -Text 'Hello' } -Position relative -Color secondary

App Bar with secondary color|Creates a new AppBar with a secondary color.

[Component("AppBar", "Creates an AppBar.")]