Sidenav

Overview

Sidenav is a sidebar typically used for navigation and is based on the Angular Material sidenav component.

Examples

import mesop as me

SIDENAV_WIDTH = 200


@me.stateclass
class State:
  sidenav_open: bool


def on_click(e: me.ClickEvent):
  s = me.state(State)
  s.sidenav_open = not s.sidenav_open


def opened_changed(e: me.SidenavOpenedChangedEvent):
  s = me.state(State)
  s.sidenav_open = e.opened


def load(e: me.LoadEvent):
  me.set_theme_mode("system")


@me.page(
  on_load=load,
  security_policy=me.SecurityPolicy(
    allowed_iframe_parents=["https://google.github.io"]
  ),
  path="/sidenav",
)
def app():
  state = me.state(State)
  with me.sidenav(
    opened=state.sidenav_open,
    disable_close=False,
    on_opened_changed=opened_changed,
    style=me.Style(
      border_radius=0,
      width=SIDENAV_WIDTH,
      background=me.theme_var("surface-container-low"),
      padding=me.Padding.all(15),
    ),
  ):
    me.text("Inside sidenav")

  with me.box(
    style=me.Style(
      margin=me.Margin(left=SIDENAV_WIDTH if state.sidenav_open else 0),
      padding=me.Padding.all(15),
    ),
  ):
    with me.content_button(on_click=on_click):
      me.icon("menu")
    me.markdown("Main content")

API

sidenav

This function creates a sidenav.

PARAMETER	DESCRIPTION
opened	A flag to determine if the sidenav is open or closed. Defaults to True. TYPE: bool DEFAULT: True
disable_close	Whether the drawer can be closed with the escape key. TYPE: bool DEFAULT: True
position	The side that the drawer is attached to. TYPE: Literal['start', 'end'] DEFAULT: 'start'
on_opened_changed	Handles event emitted when the drawer open state is changed. TYPE: Callable[[SidenavOpenedChangedEvent], Any] | None DEFAULT: None
style	An optional Style object to apply custom styles. Defaults to None. TYPE: Style | None DEFAULT: None
key	The component key. TYPE: str | None DEFAULT: None