HtmlForgeX

API Reference

Command

New-HtmlXSteps

Namespace HtmlForgeX.PowerShell
Outputs
HtmlForgeX.TablerSteps

Creates a Tabler steps indicator.

Remarks

Part of the HtmlForgeX.PowerShell DSL.

Examples

Authored help example

Example 1: Create a horizontal steps indicator.


New-HtmlXSteps -Color Primary -StepCounting {
    New-HtmlXStep -Text "Prepare" -State Completed
    New-HtmlXStep -Text "Deploy" -State Active
    New-HtmlXStep -Text "Verify"
}
        

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-HtmlXSteps [-Content <ScriptBlock>] [-Color <Blue>] [-Margin <M0>] [-Orientation <Horizontal|Vertical>] [-StepCounting] [<CommonParameters>]
#

Parameters

Content ScriptBlock optionalposition: 0pipeline: false
Scriptblock that emits step items.
Color TablerColor optionalposition: namedpipeline: falsevalues: 62
Sets steps color. Possible values: Blue, Azure, Indigo, Purple, Pink, Red, Orange, Yellow, Lime, Green, Teal, Cyan, White, Black, BlueLight, AzureLight, IndigoLight, PurpleLight, PinkLight, RedLight, OrangeLight, YellowLight, LimeLight, GreenLight, TealLight, CyanLight, Gray50, Gray100, Gray200, Gray300, Gray400, Gray500, Gray600, Gray700, Gray800, Gray900, Facebook, Twitter, Linkedin, Google, Youtube, Vimeo, Dribbble, Github, Instagram, Pinterest, Vk, Rss, Flickr, Bitbucket, Tabler, Default, Primary, Secondary, Success, Failed, Info, Warning, Danger, Light, Dark, Transparent
Possible values: Blue, Azure, Indigo, Purple, Pink, Red, Orange, Yellow, Lime, Green, Teal, Cyan, White, Black, BlueLight, AzureLight, IndigoLight, PurpleLight, PinkLight, RedLight, OrangeLight, YellowLight, LimeLight, GreenLight, TealLight, CyanLight, Gray50, Gray100, Gray200, Gray300, Gray400, Gray500, Gray600, Gray700, Gray800, Gray900, Facebook, Twitter, Linkedin, Google, Youtube, Vimeo, Dribbble, Github, Instagram, Pinterest, Vk, Rss, Flickr, Bitbucket, Tabler, Default, Primary, Secondary, Success, Failed, Info, Warning, Danger, Light, Dark, Transparent
Margin TablerMarginStyle optionalposition: namedpipeline: falsevalues: 42
Applies margin style around the steps component. Possible values: M0, M1, M2, M3, M4, M5, MT0, MT1, MT2, MT3, MT4, MT5, MB0, MB1, MB2, MB3, MB4, MB5, MS0, MS1, MS2, MS3, MS4, MS5, ME0, ME1, ME2, ME3, ME4, ME5, MX0, MX1, MX2, MX3, MX4, MX5, MY0, MY1, MY2, MY3, MY4, MY5
Possible values: M0, M1, M2, M3, M4, M5, MT0, MT1, MT2, MT3, MT4, MT5, MB0, MB1, MB2, MB3, MB4, MB5, MS0, MS1, MS2, MS3, MS4, MS5, ME0, ME1, ME2, ME3, ME4, ME5, MX0, MX1, MX2, MX3, MX4, MX5, MY0, MY1, MY2, MY3, MY4, MY5
Orientation StepsOrientation optionalposition: namedpipeline: falsevalues: 2
Sets steps orientation. Possible values: Horizontal, Vertical
Possible values: Horizontal, Vertical
StepCounting SwitchParameter optionalposition: namedpipeline: false
Enables numeric step counters.

Outputs

HtmlForgeX.TablerSteps