drawerToggle

drawerToggle is a control for collapsible drawerLayout on the left side of the page. This drawer contains the application’s main menu.

  • XML element: drawerToggle

  • Java class: DrawerToggle

Basics

drawerToggle is typically placed on the main application view. Together with navigationBar and drawerLayout they create a common pattern for navigating the application.

In the default application template, drawerToggle is located in the upper left corner of the navigation bar.

drawer toggle basic

It allows users to access main menu from anywhere in the application or collapse it to provide more space for the current view.

Attributes

id - alignSelf - ariaLabel - autofocus - classNames - colspan - height - maxHeight - maxWidth - minHeight - minWidth - tabIndex - themeNames - visible - width

themeNames

Adds a theme to the component. Possible values are:

  • normal

  • success

  • error

  • contrast

  • primary

  • small

  • pill

Handlers

AttachEvent - BlurEvent - ClickEvent - DetachEvent - FocusEvent

To generate a handler stub in Jmix Studio, use the Handlers tab of the Jmix UI inspector panel or the Generate Handler action available in the top panel of the view class and through the Code → Generate menu (Alt+Insert / Cmd+N).

ClickEvent

com.vaadin.flow.component.ClickEvent is sent when the user clicks the component.