Package Exports

@material/drawer
@material/drawer/dist/mdc.drawer
@material/drawer/dist/mdc.drawer.css
@material/drawer/dist/mdc.drawer.js
@material/drawer/dist/mdc.drawer.min.css
@material/drawer/index
@material/drawer/mdc-drawer.scss
@material/drawer/permanent/mdc-permanent-drawer.scss
@material/drawer/temporary
@material/drawer/temporary/constants
@material/drawer/temporary/foundation
@material/drawer/temporary/mdc-temporary-drawer.scss
@material/drawer/util

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@material/drawer) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

MDC Drawer

The MDC Drawer component is a spec-aligned drawer component adhering to the Material Design navigation drawer pattern. It implements permanent and temporary drawers. Permanent drawers are CSS-only and require no JavaScript, whereas temporary drawers require JavaScript to function, in order to respond to user interaction.

Installation

npm install --save @material/drawer

Permanent drawer usage

A permanent drawer is always open, sitting to the side of the content. It is appropriate for any display size larger than mobile.

TODO(sgomes): Give advice on how to hide permanent drawer in mobile.

<nav class="mdc-permanent-drawer mdc-typography">
  <div class="mdc-permanent-drawer__toolbar-spacer"></div>
  <div class="mdc-permanent-drawer__content">
    <nav id="icon-with-text-demo" class="mdc-list">
      <a class="mdc-list-item mdc-permanent-drawer--selected" href="#">
        <i class="material-icons mdc-list-item__start-detail" aria-hidden="true">inbox</i>Inbox
      </a>
      <a class="mdc-list-item" href="#">
        <i class="material-icons mdc-list-item__start-detail" aria-hidden="true">star</i>Star
      </a>
    </nav>
  </div>
</nav>
<div>
  Toolbar and page content go inside here.
</div>

In the example above, we've set the drawer above the toolbar, and are using a toolbar spacer to ensure that it is presented correctly, with the correct amount of space to match the toolbar height. Note that you can place content inside the toolbar spacer.

Permanent drawers can also be set below the toolbar:

<div>Toolbar goes here</div>

<div class="content">
  <nav class="mdc-permanent-drawer mdc-typography">
    <nav id="icon-with-text-demo" class="mdc-list">
      <a class="mdc-list-item mdc-permanent-drawer--selected" href="#">
        <i class="material-icons mdc-list-item__start-detail" aria-hidden="true">inbox</i>Inbox
      </a>
      <a class="mdc-list-item" href="#">
        <i class="material-icons mdc-list-item__start-detail" aria-hidden="true">star</i>Star
      </a>
    </nav>
  <main>
    Page content goes here.
  </main>
</div>

CSS classes:

Class	Description
`mdc-permanent-drawer`	Mandatory. Needs to be set on the root element of the component.
`mdc-permanent-drawer__content`	Mandatory. Needs to be set on the container node for the drawer content.
`mdc-permanent-drawer__toolbar-spacer`	Optional. Add to node to provide the matching amount of space for toolbar.

Temporary drawer usage

A temporary drawer is usually closed, sliding out at a higher elevation than the content when opened. It is appropriate for any display size.

<aside class="mdc-temporary-drawer mdc-typography">
  <nav class="mdc-temporary-drawer__drawer">
    <header class="mdc-temporary-drawer__header">
      <div class="mdc-temporary-drawer__header-content">
        Header here
      </div>
    </header>
    <nav id="icon-with-text-demo" class="mdc-temporary-drawer__content mdc-list">
      <a class="mdc-list-item mdc-temporary-drawer--selected" href="#">
        <i class="material-icons mdc-list-item__start-detail" aria-hidden="true">inbox</i>Inbox
      </a>
      <a class="mdc-list-item" href="#">
        <i class="material-icons mdc-list-item__start-detail" aria-hidden="true">star</i>Star
      </a>
    </nav>
  </nav>
</aside>

let drawer = new mdc.drawer.MDCTemporaryDrawer(document.querySelector('.mdc-temporary-drawer'));
document.querySelector('.menu').addEventListener('click', () => drawer.open = true);

Temporary drawers can use toolbar spacers, headers, or neither.

A toolbar spacer adds to the drawer the same amount of space that the toolbar takes up in your application. This is very useful for visual alignment and consistency. Note that you can place content inside the toolbar spacer.

<aside class="mdc-temporary-drawer mdc-typography">
  <nav class="mdc-temporary-drawer__drawer">

    <div class="mdc-temporary-drawer__toolbar-spacer"></div>

    <nav id="icon-with-text-demo" class="mdc-temporary-drawer__content mdc-list">
      <a class="mdc-list-item mdc-temporary-drawer--selected" href="#">
        <i class="material-icons mdc-list-item__start-detail" aria-hidden="true">inbox</i>Inbox
      </a>
      <a class="mdc-list-item" href="#">
        <i class="material-icons mdc-list-item__start-detail" aria-hidden="true">star</i>Star
      </a>
    </nav>
  </nav>
</aside>

A header, on the other hand, is a large rectangular area that maintains a 16:9 ratio. It's often used for user account selection. It uses an outer mdc-temporary-drawer__header for positioning, with an inner mdc-temporary-drawer__header-content for placing the actual content, which will be bottom-aligned.

<aside class="mdc-temporary-drawer mdc-typography">
  <nav class="mdc-temporary-drawer__drawer">

    <header class="mdc-temporary-drawer__header">
      <div class="mdc-temporary-drawer__header-content">
        Header content goes here
      </div>
    </header>

    <nav id="icon-with-text-demo" class="mdc-temporary-drawer__content mdc-list">
      <a class="mdc-list-item mdc-temporary-drawer--selected" href="#">
        <i class="material-icons mdc-list-item__start-detail" aria-hidden="true">inbox</i>Inbox
      </a>
      <a class="mdc-list-item" href="#">
        <i class="material-icons mdc-list-item__start-detail" aria-hidden="true">star</i>Star
      </a>
    </nav>
  </nav>
</aside>

CSS classes:

Class	Description
`mdc-temporary-drawer`	Mandatory. Needs to be set on the root element of the component.
`mdc-temporary-drawer__drawer`	Mandatory. Needs to be set on the container node for the drawer content.
`mdc-temporary-drawer__content`	Optional. Should be set on the list of items inside the drawer.
`mdc-temporary-drawer__toolbar-spacer`	Optional. Add to node to provide the matching amount of space for toolbar.
`mdc-temporary-drawer__header`	Optional. Add to container node to create a 16:9 drawer header.
`mdc-temporary-drawer__header-content`	Optional. Add to content node inside `mdc-temporary-drawer__header`.

Using the JS Component

MDC Temporary Drawer ships with a Component / Foundation combo which allows for frameworks to richly integrate the correct drawer behaviors into idiomatic components.

Including in code

ES2015

import {MDCTemporaryDrawer, MDCTemporaryDrawerFoundation} from 'mdc-drawer';

CommonJS

const mdcDrawer = require('mdc-drawer');
const MDCTemporaryDrawer = mdcDrawer.MDCTemporaryDrawer;
const MDCTemporaryDrawerFoundation = mdcDrawer.MDCTemporaryDrawerFoundation;

AMD

require(['path/to/mdc-drawer'], mdcDrawer => {
  const MDCTemporaryDrawer = mdcDrawer.MDCTemporaryDrawer;
  const MDCTemporaryDrawerFoundation = mdcDrawer.MDCTemporaryDrawerFoundation;
});

Global

const MDCTemporaryDrawer = mdc.drawer.MDCTemporaryDrawer;
const MDCTemporaryDrawerFoundation = mdc.drawer.MDCTemporaryDrawerFoundation;

Automatic Instantiation

If you do not care about retaining the component instance for the temporary drawer, simply call attachTo() and pass it a DOM element.

mdc.drawer.MDCTemporaryDrawer.attachTo(document.querySelector('.mdc-temporary-drawer'));

Manual Instantiation

Temporary drawers can easily be initialized using their default constructors as well, similar to attachTo.

import {MDCTemporaryDrawer} from 'mdc-drawer';

const drawer = new MDCTemporaryDrawer(document.querySelector('.mdc-temporary-drawer'));

Using the Foundation Class

MDC Temporary Drawer ships with an MDCTemporaryDrawerFoundation class that external frameworks and libraries can use to integrate the component. As with all foundation classes, an adapter object must be provided. The adapter for temporary drawers must provide the following functions, with correct signatures:

Method Signature	Description
`addClass(className: string) => void`	Adds a class to the root element.
`removeClass(className: string) => void`	Removes a class from the root element.
`hasClass(className: string) => boolean`	Returns boolean indicating whether element has a given class.
`hasNecessaryDom() => boolean`	Returns boolean indicating whether the necessary DOM is present (namely, the `mdc-temporary-drawer__drawer` drawer container).
`registerInteractionHandler(evt: string, handler: EventListener) => void`	Adds an event listener to the root element, for the specified event name.
`deregisterInteractionHandler(evt: string, handler: EventListener) => void`	Removes an event listener from the root element, for the specified event name.
`registerDrawerInteractionHandler(evt: string, handler: EventListener) => void`	Adds an event listener to the drawer container sub-element, for the specified event name.
`deregisterDrawerInteractionHandler(evt: string, handler: EventListener) => void`	Removes an event listener from drawer container sub-element, for the specified event name.
`registerTransitionEndHandler(handler: EventListener) => void`	Registers an event handler to be called when a `transitionend` event is triggered on the drawer container sub-element element.
`deregisterTransitionEndHandler(handler: EventListener) => void`	Deregisters an event handler from a `transitionend` event listener. This will only be called with handlers that have previously been passed to `registerTransitionEndHandler` calls.
`registerDocumentKeydownHandler(handler: EventListener) => void`	Registers an event handler on the `document` object for a `keydown` event.
`deregisterDocumentKeydownHandler(handler: EventListener) => void`	Deregisters an event handler on the `document` object for a `keydown` event.
`getDrawerWidth() => number`	Returns the current drawer width, in pixels.
`setTranslateX(value: number) => void`	Sets the current position for the drawer, in pixels from the border.
`updateCssVariable(value: string) => void`	Sets a CSS custom property, for controlling the current background opacity when manually dragging the drawer.
`getFocusableElements() => NodeList`	Returns the node list of focusable elements inside the drawer.
`saveElementTabState(el: Element) => void`	Saves the current tab index for the element in a data property.
`restoreElementTabState(el: Element) => void`	Restores the saved tab index (if any) for an element.
`makeElementUntabbable(el: Element) => void`	Makes an element untabbable.
`isRtl() => boolean`	Returns boolean indicating whether the current environment is RTL.
`isDrawer(el: Element) => boolean`	Returns boolean indicating whether the provided element is the drawer container sub-element.

@material/drawer