Class SfAccordion

Accordion is a vertically collapsible panel that displays one or more panels at a time.

Inheritance

System.Object

Syncfusion.Blazor.SfBaseComponent

SfAccordion

Namespace: Syncfusion.Blazor.Navigations

Assembly: Syncfusion.Blazor.dll

Syntax

public class SfAccordion : SfBaseComponent

Constructors

SfAccordion()

Declaration

public SfAccordion()

Properties

Animation

Declaration

public AccordionAnimationSettings Animation { get; set; }

Property Value

Type	Description
AccordionAnimationSettings

ChildContent

Child Content for Accordion.

Declaration

public RenderFragment ChildContent { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.RenderFragment

DataSource

Declaration

public IEnumerable<object> DataSource { get; set; }

Property Value

Type	Description
System.Collections.Generic.IEnumerable<System.Object>

EnablePersistence

Enable or disable persisting component's state between page reloads.

Declaration

public bool EnablePersistence { get; set; }

Property Value

Type	Description
System.Boolean

EnableRtl

Enable or disable rendering component in the right to left direction.

Declaration

public bool EnableRtl { get; set; }

Property Value

Type	Description
System.Boolean

ExpandedIndices

Specifies the index of items that is expanded on the initial load.

Declaration

public int[] ExpandedIndices { get; set; }

Property Value

Type	Description
System.Int32[]

ExpandedIndicesChanged

Gets or sets a callback of the bound value.

Declaration

public EventCallback<int[]> ExpandedIndicesChanged { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.EventCallback<System.Int32[]>

ExpandMode

Specifies the options to expand a single or multiple panels at a time. The possible values are:

• Single: Sets to expand only one Accordion item at a time.
• Multiple: Sets to expand more than one Accordion item at a time.

Declaration

public ExpandMode ExpandMode { get; set; }

Property Value

Type	Description
ExpandMode

HeaderTemplate

Declaration

public string HeaderTemplate { get; set; }

Property Value

Type	Description
System.String

Height

Specifies the height of the Accordion that can be represented in pixels/percentage.

Declaration

public string Height { get; set; }

Property Value

Type	Description
System.String

HtmlAttributes

Declaration

public Dictionary<string, object> HtmlAttributes { get; set; }

Property Value

Type	Description
System.Collections.Generic.Dictionary<System.String, System.Object>

ID

Sets ID attribute for the accordion element.

Declaration

public string ID { get; set; }

Property Value

Type	Description
System.String

Items

Declaration

public List<AccordionItem> Items { get; set; }

Property Value

Type	Description
System.Collections.Generic.List<AccordionItem>

ItemTemplate

Declaration

public string ItemTemplate { get; set; }

Property Value

Type	Description
System.String

LoadOnDemand

Enable or disable content of all the accordion are rendered on the initial load and maintained in the DOM.

Declaration

public bool LoadOnDemand { get; set; }

Property Value

Type	Description
System.Boolean

Locale

Declaration

public string Locale { get; set; }

Property Value

Type	Description
System.String

Width

Specifies the width of the Accordion that can be represented as pixels/percentage.

Declaration

public string Width { get; set; }

Property Value

Type	Description
System.String

Methods

AddItem(Object, Nullable<Int32>)

Adds new item to the Accordion with the specified index of the Accordion.

Declaration

public void AddItem(object item, Nullable<int> index = null)

Parameters

Type	Name	Description
System.Object	item	An object of item to be added to the Accordion.
System.Nullable<System.Int32>	index	Number value that determines where the item should be added. By default, item is added at the last index if the index is not specified.

BuildRenderTree(RenderTreeBuilder)

Declaration

protected override void BuildRenderTree(RenderTreeBuilder __builder)

Parameters

Type	Name	Description
Microsoft.AspNetCore.Components.Rendering.RenderTreeBuilder	__builder

EnableItem(Double, Boolean)

Enables or Disables the specified Accordion item.

Declaration

public Task EnableItem(double index, bool isEnable)

Parameters

Type	Name	Description
System.Double	index	Number value that determines which item should be enabled/disabled.
System.Boolean	isEnable	Boolean value that determines the action as enable (true) or disable (false). If the isEnable value is true, the item is enabled or else it is disabled.

Returns

Type	Description
System.Threading.Tasks.Task	System.Threading.Tasks.Task

ExpandItem(Boolean, Nullable<Double>)

Expands/Collapses the specified Accordion item.

Declaration

public Task ExpandItem(bool isExpand, Nullable<double> index = null)

Parameters

Type	Name	Description
System.Boolean	isExpand	Boolean value that determines the action as expand or collapse.
System.Nullable<System.Double>	index	Number value that determines which item should be expanded/collapsed.index is optional parameter. Without Specifying index, based on the isExpand value all Accordion item can be expanded or collapsed.

Returns

Type	Description
System.Threading.Tasks.Task	System.Threading.Tasks.Task

HideItem(Double, Nullable<Boolean>)

Shows or hides the specified item from Accordion.

Declaration

public Task HideItem(double index, Nullable<bool> isHidden = null)

Parameters

Type	Name	Description
System.Double	index	Number value that determines which item should be hidden/shown.
System.Nullable<System.Boolean>	isHidden	Boolean value that determines the action either hide (true) or show (false). Default value is false. If the isHidden value is false, the item is shown or else item it is hidden.

Returns

Type	Description
System.Threading.Tasks.Task	System.Threading.Tasks.Task

OnAfterRenderAsync(Boolean)

Declaration

protected override Task OnAfterRenderAsync(bool firstRender)

Parameters

Type	Name	Description
System.Boolean	firstRender

Returns

Type	Description
System.Threading.Tasks.Task

Overrides

Syncfusion.Blazor.SfBaseComponent.OnAfterRenderAsync(System.Boolean)

OnInitializedAsync()

Declaration

protected override Task OnInitializedAsync()

Returns

Type	Description
System.Threading.Tasks.Task

Overrides

Syncfusion.Blazor.SfBaseComponent.OnInitializedAsync()

OnParametersSetAsync()

Declaration

protected override Task OnParametersSetAsync()

Returns

Type	Description
System.Threading.Tasks.Task

Refresh()

Applies all the pending property changes and render the component again.

Declaration

public Task Refresh()

Returns

Type	Description
System.Threading.Tasks.Task	System.Threading.Tasks.Task

RemoveItem(Int32)

Dynamically removes item from Accordion.

Declaration

public Task RemoveItem(int index)

Parameters

Type	Name	Description
System.Int32	index	Number value that determines which item should be removed.

Returns

Type	Description
System.Threading.Tasks.Task	System.Threading.Tasks.Task

Select(Double)

Sets focus to the specified index item header in Accordion.

Declaration

public Task Select(double index)

Parameters

Type	Name	Description
System.Double	index	Number value that determines which item should be focused.

Returns

Type	Description
System.Threading.Tasks.Task	System.Threading.Tasks.Task

Select(Int32)

Sets focus to the specified index item header in Accordion.

Declaration

public Task Select(int index)

Parameters

Type	Name	Description
System.Int32	index	Number value that determines which item should be focused.

Returns

Type	Description
System.Threading.Tasks.Task	System.Threading.Tasks.Task