Drawer

<wa-drawer>

Since 2.0

stable

Drawers slide in from a container to expose additional options and information.

  Lorem ipsum dolor sit amet, consectetur adipiscing elit.
  Close
Open Drawer
                
              

<wa-drawer label="Drawer" id="drawer-overview">
  Lorem ipsum dolor sit amet, consectetur adipiscing elit.
  <wa-button slot="footer" variant="brand" data-drawer="close">Close</wa-button>
</wa-drawer>

<wa-button>Open Drawer</wa-button>

<script>
  const drawer = document.querySelector('#drawer-overview');
  const openButton = drawer.nextElementSibling;

  openButton.addEventListener('click', () => (drawer.open = true));
</script>

Examples Jump to heading

Drawer without Header Jump to heading

Headers are enabled by default. To render a drawer without a header, add the without-header attribute.

  Lorem ipsum dolor sit amet, consectetur adipiscing elit.
  Close
Open Drawer
                
              

<wa-drawer label="Drawer" without-header class="drawer-without-header">
  Lorem ipsum dolor sit amet, consectetur adipiscing elit.
  <wa-button slot="footer" variant="brand" data-drawer="close">Close</wa-button>
</wa-drawer>

<wa-button>Open Drawer</wa-button>

<script>
  const drawer = document.querySelector('.drawer-without-header');
  const openButton = drawer.nextElementSibling;

  openButton.addEventListener('click', () => (drawer.open = true));
</script>

Footers can be used to display titles and more. Use the footer slot to add a footer to the drawer.

  Lorem ipsum dolor sit amet, consectetur adipiscing elit.
  Close
Open Drawer
                
              

<wa-drawer label="Drawer" class="drawer-footer">
  Lorem ipsum dolor sit amet, consectetur adipiscing elit.
  <wa-button slot="footer" variant="brand" data-drawer="close">Close</wa-button>
</wa-drawer>

<wa-button>Open Drawer</wa-button>

<script>
  const drawer = document.querySelector('.drawer-footer');
  const openButton = drawer.nextElementSibling;

  openButton.addEventListener('click', () => (drawer.open = true));
</script>

Opening and Closing Drawers Declaratively Jump to heading

You can open and close drawers with JavaScript by toggling the open attribute, but you can also do it declaratively. Add the data-drawer="open id" to any button on the page, where id is the ID of the drawer you want to open.

  Lorem ipsum dolor sit amet, consectetur adipiscing elit.
  Close
Open Drawer
                
              

<wa-drawer label="Drawer" id="drawer-opening">
  Lorem ipsum dolor sit amet, consectetur adipiscing elit.
  <wa-button slot="footer" variant="brand" data-drawer="close">Close</wa-button>
</wa-drawer>

<wa-button data-drawer="open drawer-opening">Open Drawer</wa-button>

Similarly, you can add data-drawer="close" to a button inside of a drawer to tell it to close.

  Lorem ipsum dolor sit amet, consectetur adipiscing elit.
  Close
Open Drawer
                
              

<wa-drawer label="Drawer" id="drawer-dismiss">
  Lorem ipsum dolor sit amet, consectetur adipiscing elit.
  <wa-button slot="footer" variant="brand" data-drawer="close">Close</wa-button>
</wa-drawer>

<wa-button data-drawer="open drawer-dismiss">Open Drawer</wa-button>

Slide in From Start Jump to heading

By default, drawers slide in from the end. To make the drawer slide in from the start, set the placement attribute to start.

  This drawer slides in from the start.
  Close
Open Drawer
                
              

<wa-drawer label="Drawer" placement="start" class="drawer-placement-start">
  This drawer slides in from the start.
  <wa-button slot="footer" variant="brand" data-drawer="close">Close</wa-button>
</wa-drawer>

<wa-button>Open Drawer</wa-button>

<script>
  const drawer = document.querySelector('.drawer-placement-start');
  const openButton = drawer.nextElementSibling;

  openButton.addEventListener('click', () => (drawer.open = true));
</script>

Slide in From Top Jump to heading

To make the drawer slide in from the top, set the placement attribute to top.

  This drawer slides in from the top.
  Close
Open Drawer
                
              

<wa-drawer label="Drawer" placement="top" class="drawer-placement-top">
  This drawer slides in from the top.
  <wa-button slot="footer" variant="brand" data-drawer="close">Close</wa-button>
</wa-drawer>

<wa-button>Open Drawer</wa-button>

<script>
  const drawer = document.querySelector('.drawer-placement-top');
  const openButton = drawer.nextElementSibling;

  openButton.addEventListener('click', () => (drawer.open = true));
</script>

Slide in From Bottom Jump to heading

To make the drawer slide in from the bottom, set the placement attribute to bottom.

  This drawer slides in from the bottom.
  Close
Open Drawer
                
              

<wa-drawer label="Drawer" placement="bottom" class="drawer-placement-bottom">
  This drawer slides in from the bottom.
  <wa-button slot="footer" variant="brand" data-drawer="close">Close</wa-button>
</wa-drawer>

<wa-button>Open Drawer</wa-button>

<script>
  const drawer = document.querySelector('.drawer-placement-bottom');
  const openButton = drawer.nextElementSibling;

  openButton.addEventListener('click', () => (drawer.open = true));
</script>

Custom Size Jump to heading

Use the --size custom property to set the drawer's size. This will be applied to the drawer's width or height depending on its placement.

  This drawer is always 50% of the viewport.
  Close
Open Drawer
                
              

<wa-drawer label="Drawer" class="drawer-custom-size" style="--size: 50vw;">
  This drawer is always 50% of the viewport.
  <wa-button slot="footer" variant="brand" data-drawer="close">Close</wa-button>
</wa-drawer>

<wa-button>Open Drawer</wa-button>

<script>
  const drawer = document.querySelector('.drawer-custom-size');
  const openButton = drawer.nextElementSibling;

  openButton.addEventListener('click', () => (drawer.open = true));
</script>

Scrolling Jump to heading

By design, a drawer's height will never exceed 100% of its container. As such, drawers will not scroll with the page to ensure the header and footer are always accessible to the user.

Scroll down and give it a try! 👇

Open Drawer

<wa-drawer label="Drawer" class="drawer-scrolling">
  <div style="height: 150vh; border: dashed 2px var(--wa-color-surface-border); padding: 0 1rem;">
    <p>Scroll down and give it a try! 👇</p>
  </div>
  <wa-button slot="footer" variant="brand" data-drawer="close">Close</wa-button>
</wa-drawer>

<wa-button>Open Drawer</wa-button>

<script>
  const drawer = document.querySelector('.drawer-scrolling');
  const openButton = drawer.nextElementSibling;

  openButton.addEventListener('click', () => (drawer.open = true));
</script>

Header Actions Jump to heading

The header shows a functional close button by default. You can use the header-actions slot to add additional buttons if needed.

  
  Lorem ipsum dolor sit amet, consectetur adipiscing elit.
  Close
Open Drawer

<wa-drawer label="Drawer" class="drawer-header-actions">
  <wa-button class="new-window" slot="header-actions" appearance="plain">
    <wa-icon name="arrow-up-right-from-square" variant="solid" label="Open in new window"></wa-icon>
  </wa-button>
  Lorem ipsum dolor sit amet, consectetur adipiscing elit.
  <wa-button slot="footer" variant="brand" data-drawer="close">Close</wa-button>
</wa-drawer>

<wa-button>Open Drawer</wa-button>

<script>
  const drawer = document.querySelector('.drawer-header-actions');
  const openButton = drawer.nextElementSibling;
  const newWindowButton = drawer.querySelector('.new-window');

  openButton.addEventListener('click', () => (drawer.open = true));
  newWindowButton.addEventListener('click', () => window.open(location.href));
</script>

Light Dismissal Jump to heading

If you want the drawer to close when the user clicks on the overlay, add the light-dismiss attribute.

  This drawer will close when you click on the overlay.
  Close
Open Drawer
                
              

<wa-drawer label="Drawer" light-dismiss class="drawer-light-dismiss">
  This drawer will close when you click on the overlay.
  <wa-button slot="footer" variant="brand" data-drawer="close">Close</wa-button>
</wa-drawer>

<wa-button>Open Drawer</wa-button>

<script>
  const drawer = document.querySelector('.drawer-light-dismiss');
  const openButton = drawer.nextElementSibling;

  openButton.addEventListener('click', () => (drawer.open = true));
</script>

Preventing the Drawer from Closing Jump to heading

By default, drawers will close when the user clicks the close button, clicks the overlay, or presses the Escape key. In most cases, the default behavior is the best behavior in terms of UX. However, there are situations where this may be undesirable, such as when data loss will occur.

To keep the drawer open in such cases, you can cancel the wa-hide event. When canceled, the drawer will remain open and pulse briefly to draw the user's attention to it.

You can use event.detail.source to determine what triggered the request to close. This example prevents the drawer from closing when the overlay is clicked, but allows the close button or Escape to dismiss it.

  This drawer will only close when you click the button below.
  Close
Open Drawer
                
              

<wa-drawer label="Drawer" class="drawer-deny-close">
  This drawer will only close when you click the button below.
  <wa-button slot="footer" variant="brand" data-drawer="close">Close</wa-button>
</wa-drawer>

<wa-button>Open Drawer</wa-button>

<script>
  const drawer = document.querySelector('.drawer-deny-close');
  const openButton = drawer.nextElementSibling;
  const closeButton = drawer.querySelector('wa-button[slot="footer"]');

  openButton.addEventListener('click', () => (drawer.open = true));

  // Prevent the drawer from closing unless the close button is clicked
  drawer.addEventListener('wa-hide', event => {
    if (event.detail.source !== closeButton) {
      event.preventDefault();
    }
  });
</script>

Setting Initial Focus Jump to heading

To give focus to a specific element when the drawer opens, use the autofocus attribute.

  
  Close
Open Drawer

<wa-drawer label="Drawer" class="drawer-focus">
  <wa-input autofocus placeholder="I will have focus when the drawer is opened"></wa-input>
  <wa-button slot="footer" variant="brand" data-drawer="close">Close</wa-button>
</wa-drawer>

<wa-button>Open Drawer</wa-button>

<script>
  const drawer = document.querySelector('.drawer-focus');
  const input = drawer.querySelector('wa-input');
  const openButton = drawer.nextElementSibling;

  openButton.addEventListener('click', () => (drawer.open = true));
</script>

Slots Jump to heading

Learn more about using slots.

Name	Description
(default)	The drawer's main content.
`label`	The drawer's label. Alternatively, you can use the `label` attribute.
`header-actions`	Optional actions to add to the header. Works best with `<wa-button>`.
`footer`	The drawer's footer, usually one or more buttons representing various options.

Attributes & Properties Jump to heading

Learn more about attributes and properties.

Name	Description	Reflects
`open` `open`	Indicates whether or not the drawer is open. Toggle this attribute to show and hide the drawer. Type `boolean` Default `false`
`label` `label`	The drawer's label as displayed in the header. You should always include a relevant label, as it is required for proper accessibility. If you need to display HTML, use the `label` slot instead. Type `string` Default `''`
`placement` `placement`	The direction from which the drawer will open. Type `'top' \| 'end' \| 'bottom' \| 'start'` Default `'end'`
`withoutHeader` `without-header`	Disables the header. This will also remove the default close button. Type `boolean` Default `false`
`lightDismiss` `light-dismiss`	When enabled, the drawer will be closed when the user clicks outside of it. Type `boolean` Default `true`
`modal`	Exposes the internal modal utility that controls focus trapping. To temporarily disable focus trapping and allow third-party modals spawned from an active Shoelace modal, call `modal.activateExternal()` when the third-party modal opens. Upon closing, call `modal.deactivateExternal()` to restore Shoelace's focus trapping.

Events Jump to heading

Learn more about events.

Name	Description
`wa-show`	Emitted when the drawer opens.
`wa-after-show`	Emitted after the drawer opens and all animations are complete.
`wa-hide`	Emitted when the drawer is requesting to close. Calling `event.preventDefault()` will prevent the drawer from closing. You can inspect `event.detail.source` to see which element caused the drawer to close. If the source is the drawer element itself, the user has pressed `Escape` or the drawer has been closed programmatically. Avoid using this unless closing the drawer will result in destructive behavior such as data loss.
`wa-after-hide`	Emitted after the drawer closes and all animations are complete.

CSS custom properties Jump to heading

Learn more about CSS custom properties.

Name	Description
`--spacing`	The amount of space around and between the drawer's content.
`--size`	The preferred size of the drawer. This will be applied to the drawer's width or height depending on its `placement`. Note that the drawer will shrink to accommodate smaller screens.
`--show-duration`	The animation duration when showing the drawer. Default `200ms`
`--hide-duration`	The animation duration when hiding the drawer. Default `200ms`

CSS parts Jump to heading

Learn more about CSS parts.

Name	Description
`header`	The drawer's header. This element wraps the title and header actions.
`header-actions`	Optional actions to add to the header. Works best with `<wa-button>`.
`title`	The drawer's title.
`close-button`	The close button, a `<wa-button>`.
`close-button__base`	The close button's exported `base` part.
`body`	The drawer's body.
`footer`	The drawer's footer.

Dependencies Jump to heading

This component automatically imports the following elements. Sub-dependencies, if any exist, will also be included in this list.

Importing Jump to heading

The autoloader is the recommended way to import components. If you prefer to do it manually, use one of the following code snippets.

CDN

npm

React

To manually import this component from the CDN, use the following code.

import 'https://early.webawesome.com/webawesome@3.0.0-beta.2/dist/components/drawer/drawer.js';

To manually import this component from NPM, use the following code.

import '@awesome.me/webawesome/dist/components/drawer/drawer.js';

To manually import this component from React, use the following code.

import '@awesome.me/webawesome/dist/react/drawer';

Need a hand?

Report a bug

Ask for help

Getting Started

Resources

Components

Style Utilities

Layout

Patterns

Theming

Design Tokens

Drawer

Examples Jump to heading

Drawer without Header Jump to heading

Drawer with Footer Jump to heading

Opening and Closing Drawers Declaratively Jump to heading

Slide in From Start Jump to heading

Slide in From Top Jump to heading

Slide in From Bottom Jump to heading

Custom Size Jump to heading

Scrolling Jump to heading

Header Actions Jump to heading

Light Dismissal Jump to heading

Preventing the Drawer from Closing Jump to heading

Setting Initial Focus Jump to heading

Slots Jump to heading

Attributes & Properties Jump to heading

Events Jump to heading

CSS custom properties Jump to heading

CSS parts Jump to heading

Dependencies Jump to heading

Importing Jump to heading

Getting Started

Resources

Components

Style Utilities

Layout

Patterns

Theming

Design Tokens

Drawer

Examples Jump to heading #

Drawer without Header Jump to heading #

Drawer with Footer Jump to heading #

Opening and Closing Drawers Declaratively Jump to heading #

Slide in From Start Jump to heading #

Slide in From Top Jump to heading #

Slide in From Bottom Jump to heading #

Custom Size Jump to heading #

Scrolling Jump to heading #

Header Actions Jump to heading #

Light Dismissal Jump to heading #

Preventing the Drawer from Closing Jump to heading #

Setting Initial Focus Jump to heading #

Slots Jump to heading #

Attributes & Properties Jump to heading #

Events Jump to heading #

CSS custom properties Jump to heading #

CSS parts Jump to heading #

Dependencies Jump to heading #

Importing Jump to heading #

Examples Jump to heading

Drawer without Header Jump to heading

Drawer with Footer Jump to heading

Opening and Closing Drawers Declaratively Jump to heading

Slide in From Start Jump to heading

Slide in From Top Jump to heading

Slide in From Bottom Jump to heading

Custom Size Jump to heading

Scrolling Jump to heading

Header Actions Jump to heading

Light Dismissal Jump to heading

Preventing the Drawer from Closing Jump to heading

Setting Initial Focus Jump to heading

Slots Jump to heading

Attributes & Properties Jump to heading

Events Jump to heading

CSS custom properties Jump to heading

CSS parts Jump to heading

Dependencies Jump to heading

Importing Jump to heading