New-UDTooltip

Synopsis

A tooltip component.

Syntax

New-UDTooltip [[-Id] <String>] [[-Placement] <String>] -TooltipContent <ScriptBlock> -Content <ScriptBlock> [[-Sx] <Hashtable>] [-Arrow] [-FollowCursor] [[-Type] <String>] [[-EnterDelay] <Int32>] [[-LeaveDelay] <Int32>] [[-Open] <Boolean>] [[-OnOpen] <Endpoint>] [[-OnClose] <Endpoint>] [-Persistent] [<CommonParameters>]

New-UDTooltip [[-Id] <String>] [[-Placement] <String>] -Text <String> -Content <ScriptBlock> [[-Sx] <Hashtable>] [-Arrow] [-FollowCursor] [[-Type] <String>] [[-EnterDelay] <Int32>] [[-LeaveDelay] <Int32>] [[-Open] <Boolean>] [[-OnOpen] <Endpoint>] [[-OnClose] <Endpoint>] [-Persistent] [<CommonParameters>]

New-UDTooltip [[-Id] <String>] [[-Placement] <String>] -RenderTooltipContent <Endpoint> -Content <ScriptBlock> [[-Sx] <Hashtable>] [-Arrow] [-FollowCursor] [[-Type] <String>] [[-EnterDelay] <Int32>] [[-LeaveDelay] <Int32>] [[-Open] <Boolean>] [[-OnOpen] <Endpoint>] [[-OnClose] <Endpoint>] [-Persistent] [<CommonParameters>]

Description

A tooltip component. Tooltips can be placed over an other component to display a popup when the user hovers over the nested component.

Parameters

-Id

The ID of this component.

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

-Placement

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

-TooltipContent

Content to display within the tooltip.

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

-Content

Content that activates the tooltip when hovered.

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

-Sx

Theme-based styling hashtable.

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

-Arrow

Whether to display an arrow on the tooltip.

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

-FollowCursor

Whether the tooltip should follow the cursor.

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

-Type

The type of tooltip.

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

-EnterDelay

The delay before the tooltip appears in milliseconds.

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

-LeaveDelay

The delay before the tooltip disappears in milliseconds.

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

-Open

Whether the tooltip is open.

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

-OnOpen

An endpoint to call when the tooltip is opened.

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

-OnClose

An endpoint to call when the tooltip is closed.

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

-Persistent

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

-Text

Plain text to display inside the tooltip. When specified, it is rendered as a typography component. Use instead of -TooltipContent or -RenderTooltipContent.

Required?                    true (TextContent parameter set)
Position?                    named
Default value
Accept pipeline input?       false
Aliases
Accept wildcard characters?  false

-RenderTooltipContent

An endpoint that renders tooltip content dynamically. Use instead of -TooltipContent or -Text.

Required?                    true (DynamicContent parameter set)
Position?                    named
Default value
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 Tooltip

New-UDTooltip -TooltipContent {
   New-UDTypography -Text "Hello World"
} -Content {
   New-UDButton -Text "Hover over me"
} -Id "tooltip1"

A basic tooltip component that displays a header when hovered over.

Example 2: Placement

New-UDTooltip -TooltipContent {
   New-UDTypography -Text "Hello World"
} -Content {
   New-UDButton -Text "Hover over me"
} -Id "tooltip3" -Place "right"

A tooltip component that displays a header when hovered over with a right placement.

Example 3: Persistent Tooltip

New-UDTooltip -TooltipContent {
    New-UDTypography -Text "Hello World"
} -Content {
    New-UDButton -Text "Hover over me"
} -Id "tooltip3" -Type "info" -Persistent

A tooltip component that displays an alert when hovered over with a persistent tooltip. Click outside the tooltip to close it.