HtmlForgeX

API Reference

Class

TablerAccordion

Edit on GitHub
Namespace HtmlForgeX
Assembly HtmlForgeX
Source Containers/Tabler/TablerAccordion.cs:16
Base Element

Accordion container composed of expandable TablerAccordionItem elements.

Inheritance

Usage

This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.

Returned or exposed by

Accepted by parameters

Constructors

Methods

AddItem 4 overloads
public TablerAccordion AddItem(TablerAccordionItem item) #
Containers/Tabler/TablerAccordion.cs:49
Returns: TablerAccordion

Adds a fully configured accordion item to the container.

Parameters

item HtmlForgeX.TablerAccordionItem requiredposition: 0
The item to add.

Returns

The current TablerAccordion instance.

public TablerAccordionItem AddItem(String title) #
Containers/Tabler/TablerAccordion.cs:61
Returns: TablerAccordionItem

Creates a new accordion item with the specified title.

Parameters

title System.String requiredposition: 0
The accordion item title.

Returns

The created TablerAccordionItem for further configuration.

public TablerAccordionItem AddItem(String title, Element content) #
Containers/Tabler/TablerAccordion.cs:90
Returns: TablerAccordionItem

Adds a new item and allows further configuration via an action.

Parameters

title System.String requiredposition: 0
The accordion item title.
item System.Action{HtmlForgeX.TablerAccordionItem} requiredposition: 1
Callback used to configure the new item.

Returns

The configured TablerAccordionItem.

AddItem(System.String title, HtmlForgeX.Element content) #

Adds a new item using the specified title and content element.

Parameters

title System.String required
The accordion item title.
content HtmlForgeX.Element required
Content to display when the item is expanded.

Returns

The created TablerAccordionItem.

public TablerAccordion AlwaysOpen(Boolean alwaysOpen = true) #
Containers/Tabler/TablerAccordion.cs:132
Returns: TablerAccordion

Allows multiple accordion items to be open simultaneously

Parameters

alwaysOpen System.Boolean = true optionalposition: 0
public TablerAccordion Behavior(AccordionBehavior behavior, String persistKey = null) #
Containers/Tabler/TablerAccordion.cs:142
Returns: TablerAccordion

Sets advanced accordion behavior using flags.

Parameters

behavior HtmlForgeX.AccordionBehavior requiredposition: 0
Behavior flags to apply.
persistKey System.String = null optionalposition: 1
Optional persistence key (overrides the generated id when set).
public TablerAccordion Color(TablerColor color) #
Containers/Tabler/TablerAccordion.cs:124
Returns: TablerAccordion

Sets the accordion color theme

Parameters

color HtmlForgeX.TablerColor requiredposition: 0
public TablerAccordion Debug(Boolean enabled = true) #
Containers/Tabler/TablerAccordion.cs:286
Returns: TablerAccordion

Enable inline debug for this accordion (adds data-hfx-debug and turns on console logging & header chips).

Parameters

enabled System.Boolean = true optionalposition: 0
public TablerAccordion EnableCopyTitleButtons(Boolean enable = true, String tooltip = null) #
Containers/Tabler/TablerAccordion.cs:246
Returns: TablerAccordion
EditorBrowsable(2)

Enable small copy icons next to titles for all items in this accordion.

Parameters

enable System.Boolean = true optionalposition: 0
tooltip System.String = null optionalposition: 1
public TablerAccordion FullWidthLines(Boolean enabled = true) #
Containers/Tabler/TablerAccordion.cs:269
Returns: TablerAccordion

Controls whether the accordion section dividers visually span the full card width (edge-to-edge). When enabled, the accordion container applies negative horizontal margins to offset typical card-body padding.

Parameters

enabled System.Boolean = true optionalposition: 0
public TablerAccordion ItemHeaderSize(Int32 step) #
Containers/Tabler/TablerAccordion.cs:258
Returns: TablerAccordion

Sets a default font-size step (Bootstrap fs-1..fs-6) for all item headers unless overridden per-item via Int32).

Parameters

step System.Int32 requiredposition: 0
public TablerAccordion Localization(Action<AccordionLocalization> configure) #
Containers/Tabler/TablerAccordion.cs:222
Returns: TablerAccordion
EditorBrowsable(2)

Localizes built-in accordion chrome such as search hints, no-results text, and copy-title tooltips.

Parameters

configure System.Action{HtmlForgeX.AccordionLocalization} requiredposition: 0
public TablerAccordion MeasuredAutoHeight(Boolean enable = true, Boolean showMetrics = true) #
Containers/Tabler/TablerAccordion.cs:198
Returns: TablerAccordion
EditorBrowsable(2)

Uses Pretext to predict text-first panel heights and optionally surface line/height metrics in the header. Best suited to narrative or copy-heavy accordion bodies rather than tables, forms, or other mixed widgets.

Parameters

enable System.Boolean = true optionalposition: 0
showMetrics System.Boolean = true optionalposition: 1
public TablerAccordion PersistState(String key = null) #
Containers/Tabler/TablerAccordion.cs:171
Returns: TablerAccordion
EditorBrowsable(2)

Persist open/closed state across reloads. Uses the HtmlForgeX storage helper to fall back to sessionStorage/history when localStorage is unavailable (e.g., file:// reports). If key is not provided, an auto key derived from titles is used.

Parameters

key System.String = null optionalposition: 0
RegisterLibraries() #

Registers libraries required by the accordion component.

public TablerAccordion Searchable(Boolean enable = true) #
Containers/Tabler/TablerAccordion.cs:181
Returns: TablerAccordion
EditorBrowsable(2)

Adds a small search box above this accordion and enables client-side filtering by header text (including inline badges and trailing header content).

Parameters

enable System.Boolean = true optionalposition: 0
public TablerAccordion SearchDebounce(Int32 milliseconds) #
Containers/Tabler/TablerAccordion.cs:234
Returns: TablerAccordion

Sets debounce in milliseconds for the search input (default 150ms). Applies data-hfx-acc-debounce attribute.

Parameters

milliseconds System.Int32 requiredposition: 0
public TablerAccordion SearchHelp(Boolean enable = true) #
Containers/Tabler/TablerAccordion.cs:215
Returns: TablerAccordion

Show a compact help hint below the search box with examples of AND / OR / NOT / phrases.

Parameters

enable System.Boolean = true optionalposition: 0
public TablerAccordion SearchHelpIcon(Boolean show = true) #
Containers/Tabler/TablerAccordion.cs:239
Returns: TablerAccordion

Shows a small tooltip icon next to the search box that explains the query syntax. Enabled by default.

Parameters

show System.Boolean = true optionalposition: 0
public TablerAccordion SearchPlaceholder(String placeholder) #
Containers/Tabler/TablerAccordion.cs:208
Returns: TablerAccordion
EditorBrowsable(2)

Sets a custom placeholder text for the accordion search box (when Boolean) is enabled).

Parameters

placeholder System.String requiredposition: 0
public TablerAccordion SearchShowOperatorsInPlaceholder(Boolean show = true) #
Containers/Tabler/TablerAccordion.cs:229
Returns: TablerAccordion

Controls whether the placeholder shows operator hints (AND/OR/"phrase"/-NOT). Default is off to keep it short.

Parameters

show System.Boolean = true optionalposition: 0
public TablerAccordion SectionStyle(Boolean enable = true) #
Containers/Tabler/TablerAccordion.cs:117
Returns: TablerAccordion

Convenience helper to switch to the Section style.

Parameters

enable System.Boolean = true optionalposition: 0
public TablerAccordion Settings(Action<AccordionSettings> configure) #
Containers/Tabler/TablerAccordion.cs:277
Returns: TablerAccordion

Groups less-common options under a single fluent entry point to keep IntelliSense lean.

Parameters

configure System.Action{HtmlForgeX.AccordionSettings} requiredposition: 0
public TablerAccordion SingleOpenClosable(Boolean enable = true) #
Containers/Tabler/TablerAccordion.cs:161
Returns: TablerAccordion
EditorBrowsable(2)

Keeps at most one item open at a time but allows closing the last open item (implemented without using Bootstrap's data-bs-parent to permit closing the last). When enabled, sibling items close automatically on open.

Parameters

enable System.Boolean = true optionalposition: 0
public TablerAccordion Style(TablerAccordionStyle style) #
Containers/Tabler/TablerAccordion.cs:109
Returns: TablerAccordion

Sets the accordion visual style (e.g. Section).

Parameters

style HtmlForgeX.TablerAccordionStyle requiredposition: 0
public override String ToString() #
Containers/Tabler/TablerAccordion.cs:312
Returns: String

Initializes or configures ToString.

public TablerAccordion Type(TablerAccordionType accordionType) #
Containers/Tabler/TablerAccordion.cs:101
Returns: TablerAccordion

Sets the accordion type (Default, Flush, Tabs, Inverted, Plus)

Parameters

accordionType HtmlForgeX.TablerAccordionType requiredposition: 0

Properties

public List<TablerAccordionItem> Items { get; set; } #
Containers/Tabler/TablerAccordion.cs:16

Gets the accordion items that will be rendered.