Syncfusion.EJ2
Properties  Methods 


Sidebar Class Members

The following tables list the members exposed by Sidebar.

Public Constructors
 NameDescription
Public Constructor  
Top
Public Properties
 NameDescription
Public Property Enable or disable the animation transitions on expanding or collapsing the Sidebar.  
Public Property Triggers when the state(expand/collapse) of the component is changed.  
Public Property Triggers when component is closed.  
Public Property Specifies whether the Sidebar need to be closed or not when document area is clicked.  
Public Property To get or set value for ContentTemplate.  
Public Property Triggers when component is created.  
Public Property Triggers when component gets destroyed.  
Public Property Specifies the size of the Sidebar in dock state. > For more details about dockSize refer to [`Dock`](https://ej2.syncfusion.com/documentation/sidebar/docking-sidebar/) documentation.  
Public Property Specifies the docking state of the component. > For more details about enableDock refer to [`Dock`](https://ej2.syncfusion.com/documentation/sidebar/docking-sidebar/) documentation.  
Public Property Enables the expand or collapse while swiping in touch devices.  
Public Property Enable or disable persisting component's state between page reloads. If enabled, following list of states will be persisted. 1. Position 2. Type  
Public Property Specifies the Sidebar in RTL mode that displays the content in the right-to-left direction.  
Public Property Allows additional HTML attributes such as title, name, etc., and accepts n number of attributes in a key-value pair format.  
Public Property (Inherited from Syncfusion.EJ2.EJTagHelper)
Public Property Gets or sets the Sidebar component is open or close. > When the Sidebar type is set to `Auto`, the component will be expanded in the desktop and collapsed in the mobile mode regardless of the isOpen property.  
Public Property Specifies the media query string for resolution, which when met opens the Sidebar. > For more details about mediaQuery refer to [`Auto Close`](https://ej2.syncfusion.com/documentation/sidebar/auto-close/) documentation.  
Public Property Triggers when component is opened.  
Public Property Specifies the position of the Sidebar (Left/Right) corresponding to the main content. > For more details about SidebarPosition refer to [`position`](https://ej2.syncfusion.com/documentation/sidebar/getting-started/#position) documentation.  
Public Property Specifies the whether to apply overlay options to main content when the Sidebar is in an open state. > For more details about showBackdrop refer to [`Backdrop`](https://ej2.syncfusion.com/documentation/sidebar/getting-started/#enable-backdrop) documentation.  
Public Property Allows to place the sidebar inside the target element. > For more details about target refer to [`Custom Context`](https://ej2.syncfusion.com/documentation/sidebar/custom-context/) documentation.  
Public Property Specifies the expanding types of the Sidebar. `Over` - The sidebar floats over the main content area. `Push` - The sidebar pushes the main content area to appear side-by-side, and shrinks the main content within the screen width. `Slide` - The sidebar translates the x and y positions of main content area based on the sidebar width. The main content area will not be adjusted within the screen width. `Auto` - Sidebar with `Over` type in mobile resolution and `Push` type in other higher resolutions. > For more details about SidebarType refer to [`SidebarType`](./variations.html#types) documentation.  
Public Property Specifies the width of the Sidebar. By default, the width of the Sidebar sets based on the size of its content. Width can also be set in pixel values.  
Public Property Specifies the z-index of the Sidebar. It is applicable only when sidebar act as overlay type.  
Top
Protected Properties
 NameDescription
Protected PropertyOverridden.   
Protected Property (Inherited from Syncfusion.EJ2.EJTagHelper)
Protected Property (Inherited from Syncfusion.EJ2.EJTagHelper)
Protected Property (Inherited from Syncfusion.EJ2.EJTagHelper)
Protected PropertyOverridden.   
Protected PropertyOverridden.   
Protected Property (Inherited from Syncfusion.EJ2.EJTagHelper)
Protected PropertyOverridden.   
Top
Public Methods
Protected Methods
 NameDescription
Protected Method (Inherited from Syncfusion.EJ2.EJTagHelper)
Protected Method (Inherited from Syncfusion.EJ2.EJTagHelper)
Top
Extension Methods
 NameDescription
Public Extension MethodOverloaded.  Iterates the index.
Top
See Also