skip navigation
  • Product Bundles

    DevCraft

    All Telerik .NET tools and Kendo UI JavaScript components in one package. Now enhanced with:

    • NEW: Design Kits for Figma
    • Online Training
    • Document Processing Library
    • Embedded Reporting for web and desktop
    Web
    Kendo UI UI for jQuery UI for Angular UI for React UI for Vue UI for Blazor UI for ASP.NET Core UI for ASP.NET MVC UI for ASP.NET AJAX UI for Silverlight UI for PHP UI for JSP
    Mobile
    UI for .NET MAUI UI for Xamarin
    Document Management
    Telerik Document Processing
    Desktop
    UI for .NET MAUI UI for WinUI UI for WinForms UI for WPF UI for UWP
    Reporting & Mocking
    Telerik Reporting Telerik Report Server Telerik JustMock
    Automated Testing
    Test Studio Test Studio Dev Edition
    CMS
    Sitefinity
    UI/UX Tools
    ThemeBuilder Design System Kit
    Debugging
    Fiddler Fiddler Everywhere Fiddler Classic Fiddler Jam FiddlerCap FiddlerCore
    Extended Reality
    UI for Unity XR
    Free Tools
    JustAssembly JustDecompile VB.NET to C# Converter Testing Framework
    View all products
  • Overview
  • Demos
  • Blazor Hybrid
    • What's New
    • Roadmap
    • Release History
  • Docs & Support
  • Pricing
  • Search
  • Shopping cart
    • Account Overview
    • Your Licenses
    • Downloads
    • Support Center
    • Forum Profile
    • Payment Methods
    • Edit Profile
    • Log out
  • Login
  • Contact Us
  • Try now

Class TelerikDrawer<TItem>

The class for the Telerik Drawer component.

Inheritance
System.Object
BaseComponent
TelerikDrawer<TItem>
Inherited Members
BaseComponent.ShouldRender()
BaseComponent.OnInitializedAsync()
BaseComponent.InitLocalizer()
BaseComponent.ThrowIfParameterIsNull(Object, String)
BaseComponent.HaveOptionsChanged(IDictionary<String, Object>, IDictionary<String, Object>)
BaseComponent.GetClassString(String[])
BaseComponent.InvokeAsync<T>(String, Object[])
BaseComponent.InvokeAsync<T>(String, CancellationToken, Object[])
BaseComponent.InvokeVoidAsync(String, Object[])
BaseComponent.InvokeComponentMethodAsync<T>(String, Object[])
BaseComponent.InvokeComponentMethodAsync<T>(String, CancellationToken, Object[])
BaseComponent.InvokeVoidComponentMethodAsync(String, Object[])
BaseComponent.InvokeDisposeAsync()
BaseComponent.StateHasChanged()
BaseComponent.RootComponent
BaseComponent.Class
Namespace: Telerik.Blazor.Components
Assembly: Telerik.Blazor.dll

Syntax

public class TelerikDrawer<TItem> : BaseComponent, IDisposable, IItemBinding, IDrawerContainer<TItem>
Type Parameters
TItem

Constructors

TelerikDrawer()

Declaration
public TelerikDrawer()

Properties

Data

A collection that contains the Drawer items.

Declaration
public IEnumerable<TItem> Data { get; set; }
Property Value
System.Collections.Generic.IEnumerable<TItem>

DrawerContent

Defines the page content of the Drawer.

Declaration
public RenderFragment DrawerContent { get; set; }
Property Value
Microsoft.AspNetCore.Components.RenderFragment

Expanded

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

Declaration
public bool Expanded { get; set; }
Property Value
System.Boolean

ExpandedChanged

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

Declaration
public EventCallback<bool> ExpandedChanged { get; set; }
Property Value
Microsoft.AspNetCore.Components.EventCallback<System.Boolean>

IconField

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

Declaration
public string IconField { get; set; }
Property Value
System.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
public RenderFragment<TItem> ItemTemplate { get; set; }
Property Value
Microsoft.AspNetCore.Components.RenderFragment<TItem>

MiniMode

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

Declaration
public bool MiniMode { get; set; }
Property Value
System.Boolean

Mode

Specifies if the Drawer is in Push or Overlay mode.

Declaration
public DrawerMode Mode { get; set; }
Property Value
DrawerMode

Position

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

Declaration
public DrawerPosition Position { get; set; }
Property Value
DrawerPosition

SelectedItem

Defines the type of selected item in the drawer.

Declaration
public TItem SelectedItem { get; set; }
Property Value
TItem

SelectedItemChanged

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

Declaration
public EventCallback<TItem> SelectedItemChanged { get; set; }
Property Value
Microsoft.AspNetCore.Components.EventCallback<TItem>

SeparatorField

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

Declaration
public string SeparatorField { get; set; }
Property Value
System.String

Template

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

Declaration
public RenderFragment<IEnumerable<TItem>> Template { get; set; }
Property Value
Microsoft.AspNetCore.Components.RenderFragment<System.Collections.Generic.IEnumerable<TItem>>

TextField

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

Declaration
public string TextField { get; set; }
Property Value
System.String

UrlField

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

Declaration
public string UrlField { get; set; }
Property Value
System.String

Width

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

Declaration
public string Width { get; set; }
Property Value
System.String

Methods

BuildRenderTree(RenderTreeBuilder)

Declaration
protected override void BuildRenderTree(RenderTreeBuilder __builder)
Parameters
Microsoft.AspNetCore.Components.Rendering.RenderTreeBuilder __builder

CollapseAsync()

Collapses the drawer instance.

Declaration
public Task CollapseAsync()
Returns
System.Threading.Tasks.Task

Dispose()

Declaration
public override void Dispose()
Overrides
BaseComponent.Dispose()

ExpandAsync()

Expands the drawer instance.

Declaration
public Task ExpandAsync()
Returns
System.Threading.Tasks.Task

OnAfterRenderAsync(Boolean)

Declaration
protected override Task OnAfterRenderAsync(bool firstRender)
Parameters
System.Boolean firstRender

Returns
System.Threading.Tasks.Task

Overrides
BaseComponent.OnAfterRenderAsync(Boolean)

OnParametersSetAsync()

Declaration
protected override Task OnParametersSetAsync()
Returns
System.Threading.Tasks.Task

SetParametersAsync(ParameterView)

Declaration
public override Task SetParametersAsync(ParameterView parameters)
Parameters
Microsoft.AspNetCore.Components.ParameterView parameters

Returns
System.Threading.Tasks.Task

ToggleAsync()

Toggle state of the drawer instance.

Declaration
public Task ToggleAsync()
Returns
System.Threading.Tasks.Task

Was this article helpful?

Tell us how we can improve this article

Skip
Getting Started
  • Client-side Blazor
  • Server-side Blazor
  • Demos
Community
  • Forums
  • Blogs
  • Feedback Portal
Support Resources
  • Demos
  • Knowledge Base
  • Samples Repo
  • Localizations Repo
Sample Applications
  • Dashboard
  • PWA - Stocks
  • PWA - Blazing Coffee Roasters

Copyright © 2019 Progress Software Corporation and/or its subsidiaries or affiliates.
All Rights Reserved.

Progress, Telerik, and certain product names used herein are trademarks or registered trademarks of Progress Software Corporation and/or one of its subsidiaries or affiliates in the U.S. and/or other countries. See Trademarks for appropriate markings.