HtmlForgeX

API Reference

Class

AccordionSettings

Namespace HtmlForgeX
Assembly HtmlForgeX

Settings sub‑builder for TablerAccordion to keep the root API small. Returned by TablerAccordion.Settings(...) and chains back to the root via End.

Inheritance

  • Object
  • AccordionSettings

Usage

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

Accepted by parameters

Methods

public AccordionSettings Behavior(AccordionBehavior behavior, String persistKey = null) #
Returns: AccordionSettings

Sets accordion behavior and optional persistence key.

Parameters

behavior HtmlForgeX.AccordionBehavior requiredposition: 0
Behavior flags.
persistKey System.String = null optionalposition: 1
Optional storage key.
public AccordionSettings CopyTitleButtons(Boolean enable = true, String tooltip = null) #
Returns: AccordionSettings

Show a small copy icon next to each accordion item title. Clicking it copies the title without toggling.

Parameters

enable System.Boolean = true optionalposition: 0
Enable/disable for all items in this accordion.
tooltip System.String = null optionalposition: 1
Optional tooltip text. When omitted, the accordion localization fallback is used.
public TablerAccordion End() #
Returns: TablerAccordion

Returns the root accordion to continue chaining.

public AccordionSettings Localization(Action<AccordionLocalization> configure) #
Returns: AccordionSettings

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 AccordionSettings MeasuredAutoHeight(Boolean enable = true, Boolean showMetrics = true) #
Returns: AccordionSettings

Uses Pretext to predict text-first panel heights and optionally display line/height metrics in item headers. Best for narrative panels.

Parameters

enable System.Boolean = true optionalposition: 0
showMetrics System.Boolean = true optionalposition: 1
public AccordionSettings PersistState(String key = null) #
Returns: AccordionSettings

Persists expanded state across page loads (with storage fallback for file:// reports).

Parameters

key System.String = null optionalposition: 0
Optional storage key (auto key derived from titles when omitted).
public AccordionSettings Searchable(Boolean enable = true) #
Returns: AccordionSettings

Enable/disable a search box above the accordion to filter sections by header text and badges.

Parameters

enable System.Boolean = true optionalposition: 0
public AccordionSettings SearchDebounce(Int32 milliseconds) #
Returns: AccordionSettings

Set debounce in milliseconds for the search input (default 150).

Parameters

milliseconds System.Int32 requiredposition: 0
public AccordionSettings SearchHelp(Boolean enable = true) #
Returns: AccordionSettings

Show a small help hint under the search box with operator examples.

Parameters

enable System.Boolean = true optionalposition: 0
public AccordionSettings SearchPlaceholder(String placeholder) #
Returns: AccordionSettings

Customize placeholder text displayed in the search box (requires Searchable enabled).

Parameters

placeholder System.String requiredposition: 0
public AccordionSettings SearchShowOperatorsInPlaceholder(Boolean show = true) #
Returns: AccordionSettings

Show operator hints in the placeholder (AND/OR/"phrase"/-NOT). Default off.

Parameters

show System.Boolean = true optionalposition: 0
public AccordionSettings SectionStyle(Boolean enable = true) #
Returns: AccordionSettings

Convenience helper to switch to the Section style.

Parameters

enable System.Boolean = true optionalposition: 0
public AccordionSettings SingleOpenClosable(Boolean enable = true) #
Returns: AccordionSettings

Allows only one item open at a time and closable by clicking again.

Parameters

enable System.Boolean = true optionalposition: 0
True to enable single open/closable mode.
public AccordionSettings Style(TablerAccordionStyle style) #
Returns: AccordionSettings

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

Parameters

style HtmlForgeX.TablerAccordionStyle requiredposition: 0