HtmlForgeX

API Reference

Command

New-HtmlXScrollSpy

Namespace HtmlForgeX.PowerShell
Outputs
HtmlForgeX.TablerScrollSpy

Creates a Tabler ScrollSpy container.

Remarks

Part of the HtmlForgeX.PowerShell DSL.

Examples

Imported script example

New-HtmlXScrollSpy -StickyNav $true {

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-HtmlXScrollSpy [-Content <ScriptBlock>] [-AutoStackSections <bool>] [-IntraSectionGap <ExtraSmall>] [-LargeCard <bool>] [-LeftWidth <Auto>] [-Mode <ContainerScroll|CardBodyScroll|PageScroll>] [-Offset <int>] [-SectionGap <ExtraSmall>] [-StickyNav <bool>] [-UsePills <bool>] [-WrapInCard <bool>] [<CommonParameters>]
#

Parameters

Content ScriptBlock optionalposition: 0pipeline: false
Scriptblock that adds scrollspy sections.
AutoStackSections bool optionalposition: namedpipeline: false
Enable automatic vertical stacking within sections.
IntraSectionGap TablerSpacing optionalposition: namedpipeline: falsevalues: 6
Gap between heading and content inside each section. Possible values: None, ExtraSmall, Small, Medium, Large, ExtraLarge, Auto
Possible values: ExtraSmall, Small, Medium, Large, ExtraLarge, Auto
LargeCard bool optionalposition: namedpipeline: false
Use large card styling when wrapped.
LeftWidth TablerColumnNumber optionalposition: namedpipeline: falsevalues: 113
Left navigation column width. Possible values: Auto, None, Zero, One, Two, Three, Four, Five, Six, Seven, Eight, Nine, Ten, Eleven, Twelve, MediumAuto, MediumSix, SmallSix, LargeSix, ExtraLargeSix, SmallOne, SmallTwo, SmallThree, SmallFour, SmallFive, SmallSeven, SmallEight, SmallNine, SmallTen, SmallEleven, SmallTwelve, SmallAuto, MediumOne, MediumTwo, MediumThree, MediumFour, MediumFive, MediumSeven, MediumEight, MediumNine, MediumTen, MediumEleven, MediumTwelve, LargeOne, LargeTwo, LargeThree, LargeFour, LargeFive, LargeSeven, LargeEight, LargeNine, LargeTen, LargeEleven, LargeTwelve, LargeAuto, ExtraLargeOne, ExtraLargeTwo, ExtraLargeThree, ExtraLargeFour, ExtraLargeFive, ExtraLargeSeven, ExtraLargeEight, ExtraLargeNine, ExtraLargeTen, ExtraLargeEleven, ExtraLargeTwelve, ExtraLargeAuto, SmallSixMediumFour, SmallSixMediumThree, SmallSixMediumTwo, SmallSixMediumOne, SmallFourMediumSix, SmallFourMediumThree, SmallFourMediumTwo, SmallThreeMediumSix, SmallThreeMediumFour, SmallThreeMediumTwo, SmallTwoMediumSix, SmallTwoMediumFour, SmallTwoMediumThree, SmallSixLargeThree, SmallSixLargeTwo, SmallSixLargeOne, SmallSixLargeFour, SmallFourLargeSix, SmallFourLargeThree, SmallFourLargeTwo, SmallThreeLargeSix, SmallThreeLargeFour, SmallThreeLargeTwo, MediumSixLargeThree, MediumSixLargeFour, MediumSixLargeTwo, MediumSixLargeOne, MediumFourLargeSix, MediumFourLargeThree, MediumFourLargeTwo, MediumThreeLargeSix, MediumThreeLargeFour, MediumThreeLargeTwo, SmallSixMediumSixLargeThree, SmallSixMediumSixLargeFour, SmallSixMediumFourLargeThree, SmallSixMediumFourLargeTwo, SmallSixMediumThreeLargeTwo, SmallFourMediumSixLargeThree, SmallFourMediumFourLargeThree, SmallFourMediumThreeLargeTwo, SmallThreeMediumSixLargeFour, SmallThreeMediumFourLargeThree, SmallThreeMediumThreeLargeTwo, SmallSixMediumSixLargeThreeExtraLargeTwo, SmallSixMediumFourLargeThreeExtraLargeTwo, SmallFourMediumFourLargeThreeExtraLargeTwo
Possible values: Auto, Zero, One, Two, Three, Four, Five, Six, Seven, Eight, Nine, Ten, Eleven, Twelve, MediumAuto, MediumSix, SmallSix, LargeSix, ExtraLargeSix, SmallOne, SmallTwo, SmallThree, SmallFour, SmallFive, SmallSeven, SmallEight, SmallNine, SmallTen, SmallEleven, SmallTwelve, SmallAuto, MediumOne, MediumTwo, MediumThree, MediumFour, MediumFive, MediumSeven, MediumEight, MediumNine, MediumTen, MediumEleven, MediumTwelve, LargeOne, LargeTwo, LargeThree, LargeFour, LargeFive, LargeSeven, LargeEight, LargeNine, LargeTen, LargeEleven, LargeTwelve, LargeAuto, ExtraLargeOne, ExtraLargeTwo, ExtraLargeThree, ExtraLargeFour, ExtraLargeFive, ExtraLargeSeven, ExtraLargeEight, ExtraLargeNine, ExtraLargeTen, ExtraLargeEleven, ExtraLargeTwelve, ExtraLargeAuto, SmallSixMediumFour, SmallSixMediumThree, SmallSixMediumTwo, SmallSixMediumOne, SmallFourMediumSix, SmallFourMediumThree, SmallFourMediumTwo, SmallThreeMediumSix, SmallThreeMediumFour, SmallThreeMediumTwo, SmallTwoMediumSix, SmallTwoMediumFour, SmallTwoMediumThree, SmallSixLargeThree, SmallSixLargeTwo, SmallSixLargeOne, SmallSixLargeFour, SmallFourLargeSix, SmallFourLargeThree, SmallFourLargeTwo, SmallThreeLargeSix, SmallThreeLargeFour, SmallThreeLargeTwo, MediumSixLargeThree, MediumSixLargeFour, MediumSixLargeTwo, MediumSixLargeOne, MediumFourLargeSix, MediumFourLargeThree, MediumFourLargeTwo, MediumThreeLargeSix, MediumThreeLargeFour, MediumThreeLargeTwo, SmallSixMediumSixLargeThree, SmallSixMediumSixLargeFour, SmallSixMediumFourLargeThree, SmallSixMediumFourLargeTwo, SmallSixMediumThreeLargeTwo, SmallFourMediumSixLargeThree, SmallFourMediumFourLargeThree, SmallFourMediumThreeLargeTwo, SmallThreeMediumSixLargeFour, SmallThreeMediumFourLargeThree, SmallThreeMediumThreeLargeTwo, SmallSixMediumSixLargeThreeExtraLargeTwo, SmallSixMediumFourLargeThreeExtraLargeTwo, SmallFourMediumFourLargeThreeExtraLargeTwo
Mode ScrollSpyMode optionalposition: namedpipeline: falsevalues: 3
ScrollSpy mode. Possible values: ContainerScroll, CardBodyScroll, PageScroll
Possible values: ContainerScroll, CardBodyScroll, PageScroll
Offset int optionalposition: namedpipeline: false
Bootstrap scroll offset in pixels.
SectionGap TablerSpacing optionalposition: namedpipeline: falsevalues: 6
Gap between top-level items in the right pane. Possible values: None, ExtraSmall, Small, Medium, Large, ExtraLarge, Auto
Possible values: ExtraSmall, Small, Medium, Large, ExtraLarge, Auto
StickyNav bool optionalposition: namedpipeline: false
Sticky navigation toggle.
UsePills bool optionalposition: namedpipeline: false
Use pills styling for the nav.
WrapInCard bool optionalposition: namedpipeline: false
Wrap content in a card.

Outputs

HtmlForgeX.TablerScrollSpy