SidebarComponent

SidebarComponent represents the Essential JS 2 React Sidebar Component.

<SidebarComponent></SidebarComponent>

Properties

Enable or disable persisting component’s state between page reloads. If enabled, following list of states will be persisted.

Defaults to false

Specifies the Sidebar in RTL mode that displays the content in the right-to-left direction.

Defaults to false

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.

Defaults to false

Specifies the media query string for resolution, which when met opens the Sidebar.

  let defaultSidebar: Sidebar = new Sidebar({
      mediaQuery:'(min-width: 600px)'
  });

For more details about mediaQuery refer to Auto Close documentation.

Defaults to null

Specifies the position of the Sidebar (Left/Right) corresponding to the main content.

For more details about SidebarPosition refer to position documentation.

Defaults to ‘Left’

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.

Defaults to false

Allows to place the sidebar inside the target element.

For more details about target refer to Custom Context documentation.

Defaults to null

Specifies the expanding types of the Sidebar.

Auto - Sidebar with Over type in mobile resolution and Push type in other higher resolutions.

For more details about SidebarType refer to SidebarType documentation.

Defaults to ‘Auto’

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.

Defaults to ‘auto’

Specifies the z-index of the Sidebar. It is applicable only when sidebar act as overlay type.

Defaults to 1000

Methods

destroy

Removes the control from the DOM and detaches all its related event handlers. Also it removes the attributes and classes.

Returns void

Hide the Sidebar component, if it is in an open state.