Sidenav

Overview

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

Examples

import mesop as me


@me.stateclass
class State:
  sidenav_open: bool


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


SIDENAV_WIDTH = 200


@me.page(
  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, style=me.Style(width=SIDENAV_WIDTH)
  ):
    me.text("Inside sidenav")

  with me.box(
    style=me.Style(
      margin=me.Margin(left=SIDENAV_WIDTH if state.sidenav_open else 0),
    ),
  ):
    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
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