Class
TelerikDrawer<TItem>

The class for the Telerik Drawer component.

Definition

Namespace:Telerik.Blazor.Components

Assembly:Telerik.Blazor.dll

Type Parameters:

TItem

Syntax:

cs-api-definition
public class TelerikDrawer<TItem> : BaseComponent, IComponent, IHandleEvent, IHandleAfterRender, IDisposable

Inheritance: objectComponentBaseBaseComponentTelerikDrawer<TItem>

Implements: IComponentIDisposableIHandleAfterRenderIHandleEvent

Inherited Members BaseComponent.ShouldRender()BaseComponent.OnInitializedAsync()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.OnAfterRender(bool)ComponentBase.InvokeAsync(Action)ComponentBase.InvokeAsync(Func<Task>)

Constructors

TelerikDrawer()

Declaration

cs-api-definition
public TelerikDrawer()

Properties

Data

A collection that contains the Drawer items.

Declaration

cs-api-definition
[Parameter]
public IEnumerable<TItem> Data { get; set; }

Property Value

IEnumerable<TItem>

DrawerContent

Defines the page content of the Drawer.

Declaration

cs-api-definition
[Parameter]
public RenderFragment DrawerContent { get; set; }

Property Value

RenderFragment

Expanded

Defines whether the Drawer is expanded or not. The default value is "false".

Declaration

cs-api-definition
[Parameter]
public bool Expanded { get; set; }

Property Value

bool

ExpandedChanged

Fires every time the component's state is changed - to expanded or to collapsed.

Declaration

cs-api-definition
[Parameter]
public EventCallback<bool> ExpandedChanged { get; set; }

Property Value

EventCallback<bool>

IconField

Defines the property name for the Icon in the data model type. The default value is "Icon".

Declaration

cs-api-definition
[Parameter]
public string IconField { get; set; }

Property Value

string

ItemTemplate

Defines the rendering of the data bound items in the Drawer, in case you want to use a rendering different than the default one.

Declaration

cs-api-definition
[Parameter]
public RenderFragment<TItem> ItemTemplate { get; set; }

Property Value

RenderFragment<TItem>

MiniMode

Defines whether the Drawer has MiniMode enabled when it is collapsed. The default value is "false".

Declaration

cs-api-definition
[Parameter]
public bool MiniMode { get; set; }

Property Value

bool

Mode

Specifies if the Drawer is in Push or Overlay mode.

Declaration

cs-api-definition
[Parameter]
public DrawerMode Mode { get; set; }

Property Value

DrawerMode

OnItemRender

Fires when a Drawer item is being rendered. Can be used to provide custom styling for the Drawer's items.

Declaration

cs-api-definition
[Parameter]
public Action<DrawerItemRenderEventArgs> OnItemRender { get; set; }

Property Value

Action<DrawerItemRenderEventArgs>

Position

Determines on which side of the DrawerContent the item list will render. The possible positions are Start and End.

Declaration

cs-api-definition
[Parameter]
public DrawerPosition Position { get; set; }

Property Value

DrawerPosition

SelectedItem

Defines the type of selected item in the drawer.

Declaration

cs-api-definition
[Parameter]
public TItem SelectedItem { get; set; }

Property Value

TItem

SelectedItemChanged

Fires every time the user clicks on a new item from the Drawer.

Declaration

cs-api-definition
[Parameter]
public EventCallback<TItem> SelectedItemChanged { get; set; }

Property Value

EventCallback<TItem>

SeparatorField

Defines the property name for the Separator in the data model type. The default value is "Separator".

Declaration

cs-api-definition
[Parameter]
public string SeparatorField { get; set; }

Property Value

string

Template

Defines the template of the whole drawer. Takes precedence over ItemTemplate.

Declaration

cs-api-definition
[Parameter]
public RenderFragment<IEnumerable<TItem>> Template { get; set; }

Property Value

RenderFragment<IEnumerable<TItem>>

TextField

Defines the property name for the Text in the data model type. The default value is "Text".

Declaration

cs-api-definition
[Parameter]
public string TextField { get; set; }

Property Value

string

UrlField

Defines the property name for the Url in the data model type. The default value is "Url".

Declaration

cs-api-definition
[Parameter]
public string UrlField { get; set; }

Property Value

string

Width

Defines the width of the expanded Drawer in any supported CSS unit. The default value is 240px.

Declaration

cs-api-definition
[Parameter]
public string Width { get; set; }

Property Value

string

Methods

BuildRenderTree(RenderTreeBuilder)

Declaration

cs-api-definition
protected override void BuildRenderTree(RenderTreeBuilder __builder)

Parameters

__builder

RenderTreeBuilder

Overrides ComponentBase.BuildRenderTree(RenderTreeBuilder)

CollapseAsync()

Collapses the drawer instance.

Declaration

cs-api-definition
public Task CollapseAsync()

Returns

Task

Dispose()

Declaration

cs-api-definition
public override void Dispose()

Overrides BaseComponent.Dispose()

ExpandAsync()

Expands the drawer instance.

Declaration

cs-api-definition
public Task ExpandAsync()

Returns

Task

OnAfterRenderAsync(bool)

Declaration

cs-api-definition
protected override Task OnAfterRenderAsync(bool firstRender)

Parameters

firstRender

bool

Returns

Task

Overrides BaseComponent.OnAfterRenderAsync(bool)

OnParametersSetAsync()

Declaration

cs-api-definition
protected override Task OnParametersSetAsync()

Returns

Task

Overrides ComponentBase.OnParametersSetAsync()

SetParametersAsync(ParameterView)

Declaration

cs-api-definition
public override Task SetParametersAsync(ParameterView parameters)

Parameters

parameters

ParameterView

Returns

Task

Overrides ComponentBase.SetParametersAsync(ParameterView)

ToggleAsync()

Toggle state of the drawer instance.

Declaration

cs-api-definition
public Task ToggleAsync()

Returns

Task