HtmlForgeX

API Reference

Command

New-HtmlXStep

Namespace HtmlForgeX.PowerShell
Outputs
HtmlForgeX.TablerSteps

Adds a step to the current steps indicator.

Remarks

Use inside New-HtmlXSteps { }.

Examples

Imported script example

New-HtmlXStep -Text "Prepare" -State Completed
        

New-HtmlXStep -Text "Deploy" -State Active
        

Common Parameters

This command supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable.

For more information, see about_CommonParameters.

Syntax

New-HtmlXStep [-Active] [-Name <string>] [-State <Pending|Active|Completed>] [-Text <string>] [-Url <string>] [<CommonParameters>]
#

Parameters

Active SwitchParameter optionalposition: namedpipeline: false
Marks the step as active when no explicit state is provided.
Name string optionalposition: namedpipeline: false
Optional step name (used for accessibility or custom layouts).
State TablerStepState optionalposition: namedpipeline: falsevalues: 3
Step state (Pending, Active, Completed). Possible values: Pending, Active, Completed
Possible values: Pending, Active, Completed
Text string optionalposition: namedpipeline: false
Step text displayed in the UI.
Url string optionalposition: namedpipeline: false
Optional URL for clickable steps.

Outputs

HtmlForgeX.TablerSteps