Class Sidebar
Inherited Members
Namespace: Syncfusion.EJ2.Navigations
Assembly: Syncfusion.EJ2.dll
Syntax
public class Sidebar : EJTagHelper
Constructors
Sidebar()
Declaration
public Sidebar()
Properties
Animate
Enable or disable the animation transitions on expanding or collapsing the Sidebar.
Declaration
public bool Animate { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
Change
Triggers when the state(expand/collapse) of the component is changed.
Declaration
public string Change { get; set; }
Property Value
Type | Description |
---|---|
System.String |
ClassName
Declaration
protected override string ClassName { get; }
Property Value
Type | Description |
---|---|
System.String |
Overrides
Close
Triggers when component is closed.
Declaration
public string Close { get; set; }
Property Value
Type | Description |
---|---|
System.String |
CloseOnDocumentClick
Specifies whether the Sidebar need to be closed or not when document area is clicked.
Declaration
public bool CloseOnDocumentClick { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
ContentTemplate
To get or set value for ContentTemplate.
Declaration
public MvcTemplate<object> ContentTemplate { get; set; }
Property Value
Type | Description |
---|---|
MvcTemplate<System.Object> |
Created
Triggers when component is created.
Declaration
public string Created { get; set; }
Property Value
Type | Description |
---|---|
System.String |
Destroyed
Triggers when component gets destroyed.
Declaration
public string Destroyed { get; set; }
Property Value
Type | Description |
---|---|
System.String |
DockSize
Specifies the size of the Sidebar in dock state.
For more details about dockSize refer to
Dock
documentation.
Declaration
public string DockSize { get; set; }
Property Value
Type | Description |
---|---|
System.String |
EnableDock
Specifies the docking state of the component.
For more details about enableDock refer to
Dock
documentation.
Declaration
public bool EnableDock { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
EnableGestures
Enables the expand or collapse while swiping in touch devices.
Declaration
public bool EnableGestures { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
EnablePersistence
Enable or disable persisting component's state between page reloads. If enabled, following list of states will be persisted.
- Position
- Type
Declaration
public bool EnablePersistence { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
EnableRtl
Specifies the Sidebar in RTL mode that displays the content in the right-to-left direction.
Declaration
public bool EnableRtl { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
HtmlAttributes
Allows additional HTML attributes such as title, name, etc., and accepts n number of attributes in a key-value pair format.
Declaration
public object HtmlAttributes { get; set; }
Property Value
Type | Description |
---|---|
System.Object |
IsFor
Declaration
protected override bool IsFor { get; }
Property Value
Type | Description |
---|---|
System.Boolean |
Overrides
IsOpen
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.
Declaration
public bool IsOpen { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
MediaQuery
Specifies the media query string for resolution, which when met opens the Sidebar.
For more details about mediaQuery refer to
Auto Close
documentation.
Declaration
public string MediaQuery { get; set; }
Property Value
Type | Description |
---|---|
System.String |
NameSpace
Declaration
protected override string NameSpace { get; }
Property Value
Type | Description |
---|---|
System.String |
Overrides
Open
Triggers when component is opened.
Declaration
public string Open { get; set; }
Property Value
Type | Description |
---|---|
System.String |
Position
Specifies the position of the Sidebar (Left/Right) corresponding to the main content.
For more details about SidebarPosition refer to
position
documentation.
Declaration
public SidebarPosition Position { get; set; }
Property Value
Type | Description |
---|---|
SidebarPosition |
ShowBackdrop
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
documentation.
Declaration
public bool ShowBackdrop { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
TagName
Declaration
protected override string TagName { get; }
Property Value
Type | Description |
---|---|
System.String |
Overrides
Target
Allows to place the sidebar inside the target element.
For more details about target refer to
Custom Context
documentation.
Declaration
public string Target { get; set; }
Property Value
Type | Description |
---|---|
System.String |
Type
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
documentation.
Declaration
public SidebarType Type { get; set; }
Property Value
Type | Description |
---|---|
SidebarType |
Width
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.
Declaration
public string Width { get; set; }
Property Value
Type | Description |
---|---|
System.String |
ZIndex
Specifies the z-index of the Sidebar. It is applicable only when sidebar act as overlay type.
Declaration
public double ZIndex { get; set; }
Property Value
Type | Description |
---|---|
System.Double |