Back to all docs
API Reference / Telerik.Blazor.Components / TelerikChipList<TItem>
New to Telerik UI for Blazor? Start a free 30-day trial

TelerikChipList<TItem>

Class

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

Definition

Namespace:Telerik.Blazor.Components

Assembly:Telerik.Blazor.dll

Type Parameters:

TItem

Syntax:
C#
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.InvokeVoidAsyncWithoutAwait(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.DispatchExceptionAsync(Exception)ComponentBase.SetParametersAsync(ParameterView)...

Constructors

TelerikChipList()

C#
public TelerikChipList()

Properties

AriaLabel

[Accessibility] Specifies aria-label attribute of the ChipList.

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

AriaLabelledBy

[Accessibility] Specifies aria-labelledby attribute of the ChipList.

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

Data

Defines the collection used to render the individual Chip components.

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

DisabledField

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

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

FillMode

Specifies the fill mode of the chip components.

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

FillModeField

Specifies which field of the model should be used for the fill mode of the Chip. Default field name is "FillMode".

C#
[Parameter]
public string FillModeField { get; set; }

Gap

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

C#
[Parameter]
public ChipListGap? Gap { get; set; }

IconField

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

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

IconVariantField

Specifies which model field provides the SVG variant for each icon identified by IconField. The default field name is "IconVariant". Null, empty, or unsupported item values use the icon's default SVG content, and font or custom CSS icons are unaffected.

C#
[Parameter]
public string IconVariantField { get; set; }

ItemTemplate

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

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

OnRemove

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

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

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.

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

RemovableField

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

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

RemoveIcon

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

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

RemoveIconVariant

Specifies the SVG variant for RemoveIcon. When the value is null, empty, or unsupported, the remove icon's default SVG content is rendered. Font and custom CSS icons are unaffected.

C#
[Parameter]
public string RemoveIconVariant { get; set; }

Rounded

Specifies the roundness of the chip components.

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

SelectedItems

Defines the collection for the selected items of the ChipList.

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

SelectedItemsChanged

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

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

SelectionMode

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

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

Size

Specifies the size of the chip components.

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

TextField

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

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

ThemeColorField

Specifies which field of the model should be used for the theme color of the Chip. Default field name is "ThemeColor".

C#
[Parameter]
public string ThemeColorField { get; set; }

Methods

BuildRenderTree(RenderTreeBuilder)

C#
protected override void BuildRenderTree(RenderTreeBuilder __builder)
Parameters:__builderRenderTreeBuilder

Overrides: ComponentBase.BuildRenderTree(RenderTreeBuilder)

OnAfterRenderAsync(bool)

C#
protected override Task OnAfterRenderAsync(bool firstRender)
Parameters:firstRenderboolReturns:

Task

Overrides: BaseComponent.OnAfterRenderAsync(bool)

In this article
DefinitionConstructorsTelerikChipList()PropertiesAriaLabelAriaLabelledByDataDisabledFieldFillModeFillModeFieldGapIconFieldIconVariantFieldItemTemplateOnRemoveRemovableRemovableFieldRemoveIconRemoveIconVariantRoundedSelectedItemsSelectedItemsChangedSelectionModeSizeTextFieldThemeColorFieldMethodsBuildRenderTree(RenderTreeBuilder)OnAfterRenderAsync(bool)
Not finding the help you need?
Contact Support