ClassTelerikDrawer<TItem>
The class for the Telerik Drawer component.
Definition
Namespace:Telerik.Blazor.Components
Assembly:Telerik.Blazor.dll
Type Parameters:
TItem
Syntax:
public class TelerikDrawer<TItem> : BaseComponent, IComponent, IHandleEvent, IHandleAfterRender, IDisposable
Inheritance: objectComponentBaseBaseComponentTelerikDrawer<TItem>
Implements:
Inherited Members
Constructors
TelerikDrawer()
Declaration
public TelerikDrawer()
Properties
Data
A collection that contains the Drawer items.
Declaration
[Parameter]
public IEnumerable<TItem> Data { get; set; }
Property Value
IEnumerable<TItem>
DrawerContent
Defines the page content of the Drawer.
Declaration
[Parameter]
public RenderFragment DrawerContent { get; set; }
Property Value
Expanded
Defines whether the Drawer is expanded or not. The default value is "false".
ExpandedChanged
Fires every time the component's state is changed - to expanded or to collapsed.
Declaration
[Parameter]
public EventCallback<bool> ExpandedChanged { get; set; }
Property Value
IconField
Defines the property name for the Icon in the data model type. The default value is "Icon".
Declaration
[Parameter]
public string IconField { get; set; }
Property Value
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
[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".
Mode
Declaration
[Parameter]
public DrawerMode Mode { get; set; }
Property Value
OnItemRender
Fires when a Drawer item is being rendered. Can be used to provide custom styling for the Drawer's items.
Declaration
[Parameter]
public Action<DrawerItemRenderEventArgs> OnItemRender { get; set; }
Property Value
Position
Determines on which side of the DrawerContent the item list will render. The possible positions are Start and End.
Declaration
[Parameter]
public DrawerPosition Position { get; set; }
Property Value
SelectedItem
Defines the type of selected item in the drawer.
Declaration
[Parameter]
public TItem SelectedItem { get; set; }
Property Value
TItem
SelectedItemChanged
Fires every time the user clicks on a new item from the Drawer.
Declaration
[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
[Parameter]
public string SeparatorField { get; set; }
Property Value
Template
Defines the template of the whole drawer. Takes precedence over ItemTemplate.
Declaration
[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
[Parameter]
public string TextField { get; set; }
Property Value
UrlField
Defines the property name for the Url in the data model type. The default value is "Url".
Declaration
[Parameter]
public string UrlField { get; set; }
Property Value
Width
Defines the width of the expanded Drawer in any supported CSS unit.
The default value is 240px
.
Methods
BuildRenderTree(RenderTreeBuilder)
Declaration
protected override void BuildRenderTree(RenderTreeBuilder __builder)
Parameters
__builder
Overrides
CollapseAsync()
Collapses the drawer instance.
Dispose()
Declaration
public override void Dispose()
Overrides
ExpandAsync()
Expands the drawer instance.
SetParametersAsync(ParameterView)
Declaration
public override Task SetParametersAsync(ParameterView parameters)
Parameters
parameters
Returns
Overrides
ToggleAsync()
Toggle state of the drawer instance.