• What is KendoReact
  • Getting Started
  • Components
    • Animation
    • Barcodes
    • Buttons
    • Charts
    • Common Utilitiesupdated
    • Conversational UI
    • Data Gridupdated
    • Data Query
    • Data Tools
    • Date Inputsupdated
    • Date Math
    • Dialogs
    • Drawing
    • Dropdownsupdated
    • Editor
    • Excel Export
    • File Saver
    • Form
    • Gantt
    • Gauges
    • Indicators
    • Inputsupdated
    • Labels
    • Layoutupdated
      • Overview
      • Getting Started
      • ActionSheetnew
      • AppBar
      • Avatar
      • BottomNavigation
      • Breadcrumb
      • Card
      • Drawer
      • ExpansionPanel
      • GridLayout
      • Menu
      • Context Menunew
      • PanelBar
      • Splitter
      • StackLayout
      • TabStrip
      • Stepper
      • TileLayout
      • Globalization
      • API
    • ListBox
    • ListView
    • Map
    • Notification
    • PDF Processing
    • PDFViewernew
    • PivotGrid
    • Popup
    • Progress Bars
    • Ripple
    • Scheduler
    • ScrollView
    • Sortable
    • TaskBoard
    • Tooltips
    • TreeList
    • TreeView
    • Upload
  • Sample Applications
  • Styling & Themes
  • Common Features
  • Project Setup
  • Knowledge Base
  • Changelog
  • Updates
  • Troubleshooting
Components / Layout / API / DrawerProps / 

DrawerProps

The properties of the KendoReact Drawer component.

NameTypeDefaultDescription

animation?

boolean | DrawerAnimation

Specifies the animation settings of the Drawer. If boolean enables or disables the default animation. Use DrawerAnimation to set slide animation with customizable duration option. Accepts a number in milliseconds.

children?

any

Sets the Drawer items declaratively.

className?

string

Specifies a list of CSS classes that will be added to the Drawer element.

dir?

string

Represents the dir HTML attribute. This is used to switch from LTR to RTL.

expanded?

boolean

Specifies the state of the Drawer. Defaults to false (see example).

item?

React.ComponentType<DrawerItemProps>

Overrides the default component responsible for visualizing a single item (see example).

The default Component is: DrawerItem.

items?

DrawerItemProps[]

The collection of items that will be rendered in the Drawer (see example).

mini?

boolean

Enables the mini (compact) view of the Drawer which is displayed when the component is collapsed (see example)).

miniWidth?

number

Defines the width of the Drawer when the mini view is enabled and the component is collapsed. Defaults to 50.

mode?

"push" | "overlay"

Specifies the mode in which the Drawer will be displayed. The possible values are overlay and push. Defaults to overlay (see example).

position?

"end" | "start"

Specifies the position of the Drawer. The possible values are start and end (see example).

style?

React.CSSProperties

Sets additional CSS styles to the Drawer.

tabIndex?

number

Sets the tabIndex property of the Drawer.

width?

number

Defines the width of the Drawer when it is expanded. Defaults to 240.

Methods

onOverlayClick

The event handler that will be fired when the overlay is clicked. Used in overlay mode only.

Parameters

event

MouseEvent<HTMLDivElement>

onSelect

Fires when a Drawer item is selected.

Parameters

event

DrawerSelectEvent

In this article

Not finding the help you need?

Contact Support