Back to all docs

Class
TelerikChipList<TItem>

The Telerik ChipList component allows users to view and select from a set of predefined values represented as Chip elements.

Definition

Namespace:Telerik.Blazor.Components

Assembly:Telerik.Blazor.dll

Type Parameters:

TItem

Syntax:

public class TelerikChipList<TItem> : BaseComponent, IComponent, IHandleEvent, IHandleAfterRender, IDisposable

Inheritance: objectComponentBaseBaseComponentTelerikChipList<TItem>

Implements: IComponentIDisposableIHandleAfterRenderIHandleEvent

Inherited Members BaseComponent.ShouldRender()BaseComponent.OnInitializedAsync()BaseComponent.Dispose()BaseComponent.InitLocalizer()BaseComponent.ThrowIfParameterIsNull(object, string)BaseComponent.HaveOptionsChanged(IDictionary<string, object>, IDictionary<string, object>)BaseComponent.GetClassString(params string[])BaseComponent.InvokeAsync<T>(string, params object[])BaseComponent.InvokeAsync<T>(string, CancellationToken, params object[])BaseComponent.InvokeVoidAsync(string, params object[])BaseComponent.InvokeComponentMethodAsync<T>(string, params object[])BaseComponent.InvokeComponentMethodAsync<T>(string, CancellationToken, params object[])BaseComponent.InvokeVoidComponentMethodAsync(string, params object[])BaseComponent.InvokeComponentVoidMethodAsync(string, object)BaseComponent.InvokeDisposeAsync()BaseComponent.StateHasChanged()BaseComponent.RootComponentBaseComponent.ClassComponentBase.OnInitialized()ComponentBase.OnParametersSet()ComponentBase.OnParametersSetAsync()ComponentBase.OnAfterRender(bool)ComponentBase.InvokeAsync(Action)ComponentBase.InvokeAsync(Func<Task>)ComponentBase.DisExceptionAsync(Exception)ComponentBase.SetParametersAsync(ParameterView)

Constructors

TelerikChipList()

Declaration

public TelerikChipList()

Properties

AriaLabel

Specifies aria-label attribute of the ChipList.

Declaration

[Parameter]
public string AriaLabel { get; set; }

Property Value

string

AriaLabelledBy

Specifies aria-labelledby attribute of the ChipList.

Declaration

[Parameter]
public string AriaLabelledBy { get; set; }

Property Value

string

Data

Defines the collection used to render the individual Chip components.

Declaration

[Parameter]
public IEnumerable<TItem> Data { get; set; }

Property Value

IEnumerable<TItem>

DisabledField

Specifies which field of the model determines if the chip is disabled or not. Default field name is "Disabled".

Declaration

[Parameter]
public string DisabledField { get; set; }

Property Value

string

FillMode

Specifies the fill mode of the chip components. Default value is Solid.

Declaration

[Parameter]
public string FillMode { get; set; }

Property Value

string

Gap

Specifies the gap (padding) between the chip components. Default value is Medium.

Declaration

[Parameter]
public ChipListGap Gap { get; set; }

Property Value

ChipListGap

IconField

Specifies which field of the model should be used for the icon of the Chip. Default field name is "Icon".

Declaration

[Parameter]
public string IconField { get; set; }

Property Value

string

ItemTemplate

Specifies a custom template to be used for rendering individual items. Children: allows arbitrary content for each item.

Declaration

[Parameter]
public RenderFragment<TItem> ItemTemplate { get; set; }

Property Value

RenderFragment<TItem>

OnRemove

The event that is triggered when a chip's removed.

Declaration

[Parameter]
public EventCallback<ChipListRemoveEventArgs> OnRemove { get; set; }

Property Value

EventCallback<ChipListRemoveEventArgs>

Removable

Specifies whether the chip components will be removable. Default value is false. Applied to all child Chip components. RemovableField overrides this option and allows for conditionally removable Chips.

Declaration

[Parameter]
public bool Removable { get; set; }

Property Value

bool

RemovableField

Specifies which field of the model determines if the chip is removable or not. Default field name is "Removable".

Declaration

[Parameter]
public string RemovableField { get; set; }

Property Value

string

RemoveIcon

Specifies an icon rendered as the remove symbol of the chip. You can use either a predefined Telerik Icon or a custom one.

Declaration

[Parameter]
public object RemoveIcon { get; set; }

Property Value

object

Rounded

Specifies the roundness of the chip components. Default value is Medium.

Declaration

[Parameter]
public string Rounded { get; set; }

Property Value

string

SelectedItems

Defines the collection for the selected items of the ChipList.

Declaration

[Parameter]
public IEnumerable<TItem> SelectedItems { get; set; }

Property Value

IEnumerable<TItem>

SelectedItemsChanged

The event that is triggered when the selected items are changed.

Declaration

[Parameter]
public EventCallback<IEnumerable<TItem>> SelectedItemsChanged { get; set; }

Property Value

EventCallback<IEnumerable<TItem>>

SelectionMode

Defines the selection mode of the ChipList. Default value is Single.

Declaration

[Parameter]
public ChipListSelectionMode SelectionMode { get; set; }

Property Value

ChipListSelectionMode

Size

Specifies the size of the chip components. Default value is Medium.

Declaration

[Parameter]
public string Size { get; set; }

Property Value

string

TextField

Specifies which field of the model is used for the content of the chip. Default field name is "Text".

Declaration

[Parameter]
public string TextField { get; set; }

Property Value

string

Methods

BuildRenderTree(RenderTreeBuilder)

Declaration

protected override void BuildRenderTree(RenderTreeBuilder __builder)

Parameters

__builder

RenderTreeBuilder

Overrides ComponentBase.BuildRenderTree(RenderTreeBuilder)

OnAfterRenderAsync(bool)

Declaration

protected override Task OnAfterRenderAsync(bool firstRender)

Parameters

firstRender

bool

Returns

Task

Overrides BaseComponent.OnAfterRenderAsync(bool)

DefinitionConstructorsTelerikChipList()PropertiesAriaLabelAriaLabelledByDataDisabledFieldFillModeGapIconFieldItemTemplateOnRemoveRemovableRemovableFieldRemoveIconRoundedSelectedItemsSelectedItemsChangedSelectionModeSizeTextFieldMethodsBuildRenderTree(RenderTreeBuilder)OnAfterRenderAsync(bool)
Not finding the help you need?
Contact Support