Drawer

A panel that slides in from the side of the page

Drawer elements go here...
Demo: The button opens a typical drawer

Overview

A drawer is a panel that slides in from the side of the page. A drawer is often used to provide navigation in situations where: a) screen real estate is constrained and b) the navigation UI is not critical to completing the user’s primary goal (and, hence, not critical to the application’s business goal).

By default, Drawer displays a ModalBackdrop behind the main overlay content to help the user understand the modal condition. Both the backdrop and the dialog itself can be styled.

Drawer is very similar to Dialog in construction, and provides the same level of keyboard support.

You can dock a drawer to any edge of the viewport by setting the fromEdge property, such as this drawer docked to the bottom via fromEdge="bottom".

The user may dismiss the drawer by pressing Esc, or by swiping to the side with touch or the trackpad. You may also provide a UI element inside the drawer — e.g., a close box — that dismisses the drawer.

The DrawerWithGrip variation provides a built-in grip handle the user can click on or swipe on to open and close the drawer:

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Sed molestie molestie enim porta dapibus. Phasellus dolor quam, egestas eu viverra at, porttitor in diam. Donec risus tellus, accumsan eget ipsum sed, vestibulum blandit ante. Nullam rhoncus leo nec lobortis convallis. Donec posuere tellus a nibh dignissim, rhoncus viverra neque rutrum. Suspendisse rutrum at massa vitae venenatis. Suspendisse ut risus pellentesque lacus dictum aliquet. Cras a arcu id odio molestie imperdiet.

Pellentesque vitae eros ac nulla aliquam eleifend. Nunc ornare sollicitudin arcu id suscipit. Donec sed nisl libero. Nulla facilisi. Proin ornare feugiat molestie. Mauris velit mi, volutpat sit amet posuere quis, tristique et urna. Donec sit amet tellus magna. Aenean feugiat suscipit neque, ut porttitor diam auctor in. Sed faucibus finibus ipsum et pharetra. In hac habitasse platea dictumst. Cras facilisis justo eu lectus luctus, et interdum velit aliquet.

Aliquam vitae nulla efficitur turpis viverra placerat. Mauris fermentum tellus vel elementum aliquet. Integer vitae arcu et mi tristique lacinia. Cras placerat ultrices velit, id interdum ipsum commodo efficitur. Maecenas maximus odio a nisi dapibus, non dapibus nisl venenatis. Morbi tristique interdum leo, non tincidunt sapien efficitur ac. Nunc hendrerit turpis eget enim rhoncus sagittis. Aenean ac euismod magna. Phasellus et posuere nisi.

Ut volutpat eget massa id viverra. Maecenas accumsan euismod lorem, ac tristique urna efficitur non. Cras ornare ultricies arcu eu dignissim. Curabitur varius ante eget arcu accumsan, ut lacinia lacus dignissim. Ut pellentesque nibh efficitur venenatis gravida. Phasellus varius lacus non ultricies imperdiet. Class aptent taciti sociosqu ad litora torquent per conubia nostra, per inceptos himenaeos.

Efficitur nisl vel metus vestibulum, quis rutrum sapien rutrum. Suspendisse non mi varius, tincidunt mauris non, dignissim odio. Proin aliquam eleifend vestibulum. Mauris porttitor neque vel ullamcorper suscipit. Class aptent taciti sociosqu ad litora torquent per conubia nostra, per inceptos himenaeos. Vivamus accumsan luctus commodo. Class aptent taciti sociosqu ad litora torquent per conubia nostra, per inceptos himenaeos. Pellentesque quis enim vel tortor molestie rhoncus ac eu eros.

Praesent semper turpis vel tortor lacinia accumsan. Cras facilisis varius leo, a pretium odio ultrices eget. Nunc felis leo, aliquam sit amet lobortis rutrum, lobortis porttitor dolor. Sed nisl lacus, placerat ac enim id, rhoncus molestie turpis. Aenean nibh justo, ultrices quis mollis id, semper a risus. Cras magna ipsum, sollicitudin ut pretium sed, ultricies at ante. Integer ultricies quis elit in efficitur. Nam ac felis sollicitudin, tincidunt lorem sit amet, convallis ligula.

Demo: A bottom drawer with a grip

Drawers are often customized to match the visual style of the application:

This page has a drawer with custom styling. Among other things, the rotation applied to the "+" button tracks the current position of the drawer during a touch or trackpad swipe.

Drawer elements go here...
Demo: A customized drawer with a grip

A common UI for opening a navigation drawer is a button with a three line "hamburger" icon. Elix provides this combination in HamburgerMenuButton.

Usage

import Drawer from 'elix/define/Drawer.js';
const drawer = new Drawer(); // or
const drawer = document.createElement('elix-drawer');

In HTML:

<script type="module" src="node_modules/elix/define/Drawer.js"></script>
<elix-drawer>
  <!-- Drawer contents go here -->
</elix-drawer>

See also

API

Ancestry: Drawer → OverlayReactiveElement → HTMLElement

Built with mixins AttributeMarshallingMixin, DialogModalityMixin, EffectMixin, FocusCaptureMixin, KeyboardMixin, LanguageDirectionMixin, OpenCloseMixin, OverlayMixin, ReactiveMixin, ShadowTemplateMixin, SlotContentMixin, TouchSwipeMixin, TrackpadSwipeMixin, and TransitionEffectMixin.

The element defines the following shadow parts:

  • backdrop: the backdrop behind the overlay, default type is ModalBackdrop
  • frame: the frame around the overlay, default type is OverlayFrame

Extended by class DrawerWithGrip.

This element is used as a shadow part in HamburgerMenuButton.

backdropPartType property

The class, tag, or template used for the backdrop part - the optional element shown behind the overlay.

This can help focus the user's attention on the overlay content. Additionally, a backdrop can be used to absorb clicks on background page elements. For example, Dialog uses ModalBackdrop as an overlay backdrop in such a way.

Type: (component class constructor)|HTMLTemplateElement|string

Default: Backdrop

Defined by Overlay

close(closeResult) method

Close the component (if not already closed).

Some components like AlertDialog want to indicate why or how they were closed. To support such scenarios, you can supply a value to the optional closeResult parameter. This closeResult will be made available in the whenClosed promise and the state.closeResult member.

Parameters:

  • closeResult: objectan indication of how or why the element closed

Defined by OpenCloseMixin

closed property

True if the element is currently closed.

Type: boolean

Defined by OpenCloseMixin

closed event

Raised when the component closes.

Defined by OpenCloseMixin

closeFinished property

True if the element has completely closed.

For components not using asynchronous open/close effects, this property returns the same value as the closed property. For elements that have a true value of state.openCloseEffects (e.g., elements using TransitionEffectMixin), this property returns true only if state.effect is "close" and state.effectPhase is "after".

Type: boolean

Defined by OpenCloseMixin

effect-phase-changed event

Raised when state.effect or state.effectPhase changes.

Note: In general, Elix components do not raise events in response to outside manipulation. (See internal.raiseChangeEvents.) However, for a component using TransitionEffectMixin, a single invocation of the startEffect method will cause the element to pass through multiple visual states. This makes it hard for external hosts of this component to know what visual state the component is in. Accordingly, the mixin raises the effect-phase-changed event whenever the effect or phase changes, even if internal.raiseChangeEvents is false.

Defined by TransitionEffectMixin

framePartType property

The class, tag, or template used to create the frame part – the overlay's primary content.

The frame element can be used to provide a border around the overlay content, and to provide visual effects such as a drop-shadow to help distinguish overlay content from background page elements.

Type: (component class constructor)|HTMLTemplateElement|string

Default: OverlayFrame

Defined by Overlay

fromEdge property

The edge from which the drawer will appear, in terms of the drawer's container.

The start and end values refer to text direction: in left-to-right languages such as English, these are equivalent to left and right, respectively.

Type: 'end'|'left'|'right'|'start'

Default: 'start'

[internal.contentSlot] property

Defined by SlotContentMixin

[internal.defaultState] property

The default state for the component. This can be extended by mixins and classes to provide additional default state.

Type: State

Defined by ReactiveMixin

[internal.effectEndTarget] property

Return the elements that use CSS transitions to provide visual effects.

By default, this assumes the host element itself will have a CSS transition applied to it, and so returns an array containing the element. If you will be applying CSS transitions to other elements, override this property and return an array containing the implicated elements.

See internal.effectEndTarget for details.

Type: HTMLElement

Defined by TransitionEffectMixin

[internal.ids] property

A convenient shortcut for looking up an element by ID in the component's Shadow DOM subtree.

Example: if component's template contains a shadow element <button id="foo">, you can use the reference this[internal.ids].foo to obtain the corresponding button in the component instance's shadow tree. The ids property is simply a shorthand for getElementById, so this[internal.ids].foo is the same as this.shadowRoot.getElementById('foo').

Type: object

Defined by ShadowTemplateMixin

[internal.keydown]() method

See the symbols documentation for details.

Defined by KeyboardMixin

[internal.render](changed) method

Render the indicated changes in state to the DOM.

The default implementation of this method does nothing. Override this method in your component to update your component's host element and any shadow elements to reflect the component's new state. See the rendering example.

Be sure to call super in your method implementation so that your component's base classes and mixins have a chance to perform their own render work.

Parameters:

  • changed: objectdictionary of flags indicating which state members have changed since the last render

Defined by ReactiveMixin

[internal.renderChanges]() method

Render any pending component changes to the DOM.

This method does nothing if the state has not changed since the last render call.

ReactiveMixin will invoke this method following a setState call; you should not need to invoke this method yourself.

This method invokes all internal render methods, then invokes componentDidMount (for first render) or componentDidUpdate (for subsequent renders).

Defined by ReactiveMixin

[internal.setState](changes) method

Update the component's state by merging the specified changes on top of the existing state. If the component is connected to the document, and the new state has changed, this returns a promise to asynchronously render the component. Otherwise, this returns a resolved promise.

Parameters:

  • changes: objectthe changes to apply to the element's state

Returns: Promise - resolves when the new state has been rendered

Defined by ReactiveMixin

[internal.startEffect](effect) method

Parameters:

  • effect: string

Defined by TransitionEffectMixin

[internal.state] property

The component's current state.

The returned state object is immutable. To update it, invoke internal.setState.

It's extremely useful to be able to inspect component state while debugging. If you append ?elixdebug=true to a page's URL, then ReactiveMixin will conditionally expose a public state property that returns the component's state. You can then access the state in your browser's debug console.

Type: State

Defined by ReactiveMixin

[internal.swipeTarget] property

Type: HTMLElement

Defined by TouchSwipeMixin

open() method

Open the element (if not already opened).

Defined by OpenCloseMixin

opened property

True if the element is currently opened.

Type: boolean

Defined by OpenCloseMixin

opened event

Raised when the component opens.

Defined by OpenCloseMixin

opened-changed event

Raised when the opened/closed state of the component changes.

Defined by OpenCloseMixin

toggle(opened) method

Toggle the open/close state of the element.

Parameters:

  • opened: booleantrue if the element should be opened, false if closed.

Defined by OpenCloseMixin

whenClosed() method

This method can be used as an alternative to listening to the "opened-changed" event, particularly in situations where you want to only handle the next time the component is closed.

Returns: Promise A promise that resolves when the element has completely closed, including the completion of any asynchronous opening effect.

Defined by OpenCloseMixin

wrap(original) method

Destructively wrap a node with elements necessary to capture focus.

Call this method in a components internal.template property. Invoke this method as this[FocusCaptureMixin.wrap](element).

Parameters:

  • original: Nodethe element within which focus should wrap

Defined by FocusCaptureMixin