New-UDMenu

Menus display a list of choices on temporary surfaces.

Synopsis

Menus display a list of choices on temporary surfaces.

Syntax

New-UDMenu [[-Id] <String>] [[-Text] <String>] [[-OnChange] <Endpoint>] [-Children] <ScriptBlock> [[-ClassName] <ParameterAttribute>] [[-Variant] <String>] [[-Icon] <Hashtable>] [[-Size] <String>] [[-Sx] <Hashtable>] [[-Style] <Hashtable>] [<CommonParameters>]

Description

Creates a pop up menu.

Parameters

-Id

The ID of this component.

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

-Text

The text to display in the button that opens this menu.

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

-OnChange

An event handler to call when the user selects an item from the menu. $EventData will include the selected item.

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

-Children

The items to display in the menu.

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

-ClassName

The class name of the menu.

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

-Variant

The button variant for the menu.

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

-Icon

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

-Size

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

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

-Sx

The sx prop allows you to add custom styles to the component.

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

-Style

The style prop allows you to add custom styles to the component.

Required?                    false
Position?                    10
Default value
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-UDMenu -Text 'Click Me'  -Children {
PS >    New-UDMenuItem -Text 'Test'
PS >    New-UDMenuItem -Text 'Test2'
PS >    New-UDMenuItem -Text 'Test3'
PS > } -Id 'menu1'

Basic menu|Creates a simple menu.




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

PS >New-UDMenu -Text 'Click Me' -OnChange {
PS >    Show-UDToast -Message $EventData
PS > } -Children {
PS >    New-UDMenuItem -Text 'Test'
PS >    New-UDMenuItem -Text 'Test2'
PS >    New-UDMenuItem -Text 'Test3'
PS > } -Id 'menu2'

Menu with event handler|Creates a menu with an event handler.




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

PS >New-UDMenu -Text 'Click Me' -Children {
PS >       New-UDMenuItem -Text 'Test'
PS >       New-UDMenuItem -Text 'Test2'
PS >       New-UDMenuItem -Text 'Test3'
PS > } -Variant text -Id 'menu3'

Text variant|Creates a menu with a text variant.




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

PS >New-UDMenu -Text 'Click Me' -Children {
PS >       New-UDMenuItem -Text 'Test'
PS >       New-UDMenuItem -Text 'Test2'
PS >       New-UDMenuItem -Text 'Test3'
PS > } -Size small -Id 'menu4'

Small menu|Creates a small menu.




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

PS >New-UDMenu -Text 'Click Me' -Children {
PS >       New-UDMenuItem -Text 'Test' -Value 1
PS >       New-UDMenuItem -Text 'Test2' -Value 2
PS >       New-UDMenuItem -Text 'Test3' -Value 3
PS > }  -Id 'menu5'

Menu with values|Creates a menu with values.


[Component("Menu", "Bars", "Creates a new card.")]