HxCollapse

Bootstrap 5 Collapse component.

Basic Usage

Some placeholder content for the collapse component. This panel is hidden by default but revealed when the user activates the relevant trigger.
<HxCollapseToggleButton Text="Toggle" CollapseTarget="#myCollapse" Color="ThemeColor.Primary" CssClass="mb-3" />
<HxCollapse Id="myCollapse">
	<HxCard>
		<BodyTemplate>
			Some placeholder content for the collapse component.
			This panel is hidden by default but revealed when the user activates the relevant trigger.
		</BodyTemplate>
	</HxCard>
</HxCollapse>

Horizontal

You can change the animation direction with CollapseDirection parameter.

This is some placeholder content for a horizontal collapse. It's hidden by default and shown when triggered.

Multiple targets

You can use the CollapseTarget selector to toggle multiple targets.

Some placeholder content for the first collapse component of this multi-collapse example. This panel is hidden by default but revealed when the user activates the relevant trigger.
Some placeholder content for the second collapse component of this multi-collapse example. This panel is hidden by default but revealed when the user activates the relevant trigger.

Programming

Some placeholder content for the collapse component. This panel is hidden by default but revealed when the user activates the relevant trigger.

API

Parameters

Name Type Description
Id string Element ID. To be referenced by HxCollapseToggleButton.CollapseTarget. (Autogenerated GUID if not set explicitly.)
CollapseDirection CollapseDirection Direction of the animation. Default is CollapseDirection.Vertical.
Parent string If parent is provided, then all collapsible elements under the specified parent will be closed when this collapsible item is shown. (Similar to traditional accordion behavior.)
CssClass string Additional CSS class.
ChildContent RenderFragment Content of the collapse.

Event Callbacks

Name Type Description
OnShown EventCallback<string> This event is fired when a collapse element has been made visible to the user (will wait for CSS transitions to complete).
OnHidden EventCallback<string> This event is fired when a collapse element has been hidden from the user (will wait for CSS transitions to complete).

Methods

Method Returns Description
ShowAsync() Task Expands the item.
HideAsync() Task Collapses the item.

HxCollapseToggleButton

Bootstrap Collapse toggle (in form of button) which triggers the HxCollapse to toggle. Derived from HxButton (incl. HxButton.Defaults inheritance).

API

Parameters

Name Type Description
CollapseTarget string Target selector of the toggle. Use #id to reference single HxCollapse or .class for multiple HxCollapses.
Text string Text of the button.
ChildContent RenderFragment Button content.
Icon IconBase Icon to render into the button.
Color ThemeColor? Bootstrap button style - theme color.
Default is taken from HxButton.Defaults (ThemeColor.None if not customized).
Size ButtonSize? Button size. Default is ButtonSize.Regular.
Outline bool? Bootstrap "outline" button style.
CssClass string Custom CSS class to render with the <button />.
When using Tooltip you might want to use TooltipWrapperCssClass instead of CssClass to get the desired result.
Enabled bool?
EditContext EditContext Associated EditContext.
FormId string Specifies the form the button belongs to.
Tooltip string Tooltip text.
If set, a span wrapper will be rendered around the <button />. For most scenarios you will then use TooltipWrapperCssClass instead of CssClass.
TooltipPlacement TooltipPlacement Tooltip placement.
TooltipCssClass string Custom CSS class to render with the tooltip.
TooltipWrapperCssClass string Custom CSS class to render with the tooltip span wrapper of the <button />.
If set, the span wrapper will be rendered no matter the Tooltip text is set or not.
OnClickStopPropagation bool Stop onClick-event propagation. Deafult is true.
OnClickPreventDefault bool Prevents the default action for the onclick event. Deafult is false.
Spinner bool? Set state of the embedded HxSpinner. Leave null if you want automated spinner when any of the OnClick handlers is running. You can set an explicit false constant to disable (override) the spinner automation.
SingleClickProtection bool Set false if you want to allow multiple OnClick handlers in parallel. Default is true.
AdditionalAttributes Dictionary<string, object> Additional attributes to be splatted onto an underlying <button> element.

Event Callbacks

Name Type Description
OnClick EventCallback<MouseEventArgs> Raised after the button is clicked.
OnValidClick EventCallback<MouseEventArgs> Raised after the button is clicked and EditContext validation succeeds.
OnInvalidClick EventCallback<MouseEventArgs> Raised after the button is clicked and EditContext validation fails.
An unhandled error has occurred. Reload 🗙