@rmwc/menu

Menus

Menus display a list of choices on a transient sheet of material.

• import from '@rmwc/menu';
• Import styles:
  • import '@material/menu/dist/mdc.menu.css';
  • import '@material/menu-surface/dist/mdc.menu-surface.css';
  • import '@material/list/dist/mdc.list.css';
• MDC Docs: https://material.io/develop/web/components/menus/

Menu with Items

You can compose a menu with the given components, and manually manage the open state.

import { Menu, MenuItem, MenuSurfaceAnchor } from '@rmwc/menu';
import { Button } from '@rmwc/button';

<MenuSurfaceAnchor>
  <Menu
    open={this.state.menuIsOpen}
    onSelect={evt => console.log(evt.detail.index)}
    onClose={evt => this.setState({menuIsOpen: false})}
  >
    <MenuItem>Cookies</MenuItem>
    <MenuItem>Pizza</MenuItem>
    <MenuItem>Icecream</MenuItem>
  </Menu>

  <Button
    raised
    onClick={evt => this.setState({'menuIsOpen': !this.state.menuIsOpen})}
  >
    Open Menu
  </Button>
</MenuSurfaceAnchor>

Generic Menu Surface

MenuSurface allows you to create a menu with any kind of content.

import { MenuSurface, MenuSurfaceAnchor } from '@rmwc/menu';
import { Button } from '@rmwc/button';

<MenuSurfaceAnchor>
  <MenuSurface
    open={this.state.genericMenuIsOpen}
    onClose={evt => this.setState({genericMenuIsOpen: false})}
  >
    <div style={{padding: '1rem', width: '8rem'}}>Make the content whatever you want.</div>
  </MenuSurface>

  <Button
    raised
    onClick={evt => this.setState({'genericMenuIsOpen': !this.state.genericMenuIsOpen})}
  >
    Open Generic Menu
  </Button>
</MenuSurfaceAnchor>

Simplified usage

RMWC provides a non-standard convenience SimpleMenu component that takes a handle as a prop, and manages the open state for you.

import { SimpleMenu, SimpleMenuSurface, MenuItem } from '@rmwc/menu';
import { Button } from '@rmwc/button';

<SimpleMenu
  handle={ <Button raised>Open Simple Menu</Button> }
>
  <MenuItem>Cookies</MenuItem>
  <MenuItem>Pizza</MenuItem>
  <MenuItem>Icecream</MenuItem>
</SimpleMenu>

<SimpleMenuSurface
  handle={ <Button raised>Open Simple Menu Surface</Button> }
>
  <div style={{padding: '1rem', width: '8rem'}}>Make the content whatever you want.</div>
</SimpleMenuSurface>

import { DocumentComponent } from '@rmwc/base/utils/DocumentComponent';
import * as docs from './docgen.json';

<DocumentComponent docs={docs} displayName="Menu" />
<DocumentComponent docs={docs} displayName="MenuItem" composes={['ListItem']}/>
<DocumentComponent docs={docs} displayName="MenuSurface" />
<DocumentComponent docs={docs} displayName="MenuSurfaceAnchor" />
<DocumentComponent docs={docs} displayName="SimpleMenu" />
<DocumentComponent docs={docs} displayName="SimpleMenuSurface" />

Changelog

2.0.2 (2018-09-12)

Documentation Changes

• Favicon: Adding favicon fixes #306 and adding missing switch styles fixes #307 (9a0ad1a3)

Bug Fixes

• TS: Massive type cleanup (f44276ed)