For the complete documentation index, see llms.txt. This page is also available as Markdown.

New-UDStep

Synopsis

Creates a new step for a stepper.

Syntax

New-UDStep [[-Id] <String>] [-OnLoad] <Endpoint> [[-Label] <String>] [-Optional] [-DisablePrevious] [[-Icon] <Object>] [-RemoveIconStyle] [[-IconStyle] <Hashtable>] [[-DarkIconStyle] <Hashtable>] [<CommonParameters>]

Description

Creates a new step for a stepper. Add to the Children (alias Steps) parameter for New-UDStepper.

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

-OnLoad

The script block that is executed when the step is loaded. The script block will receive the $Body parameter which contains JSON for the current state of the stepper. If you are using form controls, their data will be availalble in the $Body.Context property.

-Label

A label for this step.

-Optional

Whether this step is optional.

-DisablePrevious

Disables the back button on the step

-Icon

The icon to put with the step

-RemoveIconStyle

Removes circle style around icon

-IconStyle

-DarkIconStyle

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

Creates a stepper that reports the stepper context with each step.

Last updated

Was this helpful?