HtmlForgeX

API Reference

Class

TablerScrollSpySettings

Namespace HtmlForgeX
Assembly HtmlForgeX

Settings sub‑builder for TablerScrollSpy.

Inheritance

  • Object
  • TablerScrollSpySettings

Methods

public TablerScrollSpySettings AutoStackSections(Boolean enable = true) #
Returns: TablerScrollSpySettings

Automatically stacks sections when space is limited.

Parameters

enable System.Boolean = true optionalposition: 0
True to enable stacking.
public TablerScrollSpy End() #
Returns: TablerScrollSpy

Returns control to the root scroll spy builder.

public TablerScrollSpySettings IntraSectionGap(TablerSpacing spacing) #
Returns: TablerScrollSpySettings

Sets spacing within individual sections.

Parameters

spacing HtmlForgeX.TablerSpacing requiredposition: 0
Spacing value.
public TablerScrollSpySettings LeftWidth(TablerColumnNumber width) #
Returns: TablerScrollSpySettings

Sets width of the left navigation column.

Parameters

width HtmlForgeX.TablerColumnNumber requiredposition: 0
Column width.
public TablerScrollSpySettings Mode(ScrollSpyMode mode) #
Returns: TablerScrollSpySettings

Chooses between scroll or position modes.

Parameters

mode HtmlForgeX.TablerScrollSpy.ScrollSpyMode requiredposition: 0
Scroll spy mode.
public TablerScrollSpySettings Offset(Int32 px) #
Returns: TablerScrollSpySettings

Sets offset in pixels before activating sections.

Parameters

px System.Int32 requiredposition: 0
Offset in pixels.
public TablerScrollSpySettings ScrollHeight(String cssHeight) #
Returns: TablerScrollSpySettings

Sets the scrollable container height.

Parameters

cssHeight System.String requiredposition: 0
CSS height value.
public TablerScrollSpySettings SectionGap(TablerSpacing spacing) #
Returns: TablerScrollSpySettings

Sets spacing between sections.

Parameters

spacing HtmlForgeX.TablerSpacing requiredposition: 0
Spacing value.
public TablerScrollSpySettings StickyNav(Boolean sticky = true) #
Returns: TablerScrollSpySettings

Makes the navigation bar stick to the top.

Parameters

sticky System.Boolean = true optionalposition: 0
True to enable sticky nav.
public TablerScrollSpySettings UsePills(Boolean pills = true) #
Returns: TablerScrollSpySettings

Uses pill style navigation links.

Parameters

pills System.Boolean = true optionalposition: 0
True to use pills.
public TablerScrollSpySettings WrapContentInCard(Boolean enabled = true, Boolean large = true) #
Returns: TablerScrollSpySettings

Wraps content in a card layout.

Parameters

enabled System.Boolean = true optionalposition: 0
True to wrap content.
large System.Boolean = true optionalposition: 1
True for large cards.