Drawer

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

<pc-drawer label="Drawer" class="drawer-overview">
  Lorem ipsum dolor sit amet, consectetur adipiscing elit.
  <pc-button appearance="text" slot="footer">Close</pc-button>
</pc-drawer>

<pc-button>Open drawer</pc-button>

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

  openButton.addEventListener("click", () => drawer.show());
  closeButton.addEventListener("click", () => drawer.hide());
</script>

Code

Demos

Slide in from start

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

<pc-drawer label="Drawer" placement="start" class="drawer-placement-start">
  This drawer slides in from the start.
  <pc-button appearance="text" slot="footer">Close</pc-button>
</pc-drawer>

<pc-button>Open drawer</pc-button>

<script>
  const drawer = document.querySelector(".drawer-placement-start");
  const openButton = drawer.nextElementSibling;
  const closeButton = drawer.querySelector('pc-button[slot="footer"]');

  openButton.addEventListener("click", () => drawer.show());
  closeButton.addEventListener("click", () => drawer.hide());
</script>

Code

Slide in from top

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

<pc-drawer label="Drawer" placement="top" class="drawer-placement-top">
  This drawer slides in from the top.
  <pc-button appearance="text" slot="footer">Close</pc-button>
</pc-drawer>

<pc-button>Open drawer</pc-button>

<script>
  const drawer = document.querySelector(".drawer-placement-top");
  const openButton = drawer.nextElementSibling;
  const closeButton = drawer.querySelector('pc-button[slot="footer"]');

  openButton.addEventListener("click", () => drawer.show());
  closeButton.addEventListener("click", () => drawer.hide());
</script>

Code

Slide in from bottom

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

<pc-drawer label="Drawer" placement="bottom" class="drawer-placement-bottom">
  This drawer slides in from the bottom.
  <pc-button appearance="text" slot="footer">Close</pc-button>
</pc-drawer>

<pc-button>Open drawer</pc-button>

<script>
  const drawer = document.querySelector(".drawer-placement-bottom");
  const openButton = drawer.nextElementSibling;
  const closeButton = drawer.querySelector('pc-button[slot="footer"]');

  openButton.addEventListener("click", () => drawer.show());
  closeButton.addEventListener("click", () => drawer.hide());
</script>

Code

Contained to an element

By default, drawers slide out of their containing block, which is usually the viewport. To make a drawer slide out of a parent element, add the contained attribute to the drawer and apply position: relative to its parent.

Unlike normal drawers, contained drawers are not modal. This means they do not show an overlay, they do not trap focus and they are not dismissible with the Esc key. This is intentional to allow users to interact with elements outside the drawer.

<div class="drawer-contained-container">
  The drawer will be contained to this box. This content won’t shift or be affected in any way when the drawer opens.

  <pc-drawer label="Drawer" class="drawer-contained" style="--size: 50%" contained>
      Lorem ipsum dolor sit amet, consectetur adipiscing elit.
      <pc-button appearance="text" slot="footer">Close</pc-button>
  </pc-drawer>
</div>

<pc-button>Toggle drawer</pc-button>

<script>
  const drawer = document.querySelector(".drawer-contained");
  const openButton = drawer.parentElement.nextElementSibling;
  const closeButton = drawer.querySelector('pc-button[slot="footer"]');

  openButton.addEventListener("click", () => (drawer.open = !drawer.open));
  closeButton.addEventListener("click", () => drawer.hide());
</script>

<style>
  .drawer-contained-container {
      position: relative;
      margin-bottom: var(--pc-spacing-l);
      padding: var(--pc-spacing-l);
      height: 300px;
      border: 2px solid var(--pc-panel-border-color);
      border-radius: var(--pc-border-radius-l);
      overflow: hidden;
  }
</style>

Code

Custom size

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.

<pc-drawer label="Drawer" class="drawer-custom-size">
  This drawer is always 50% of the viewport.
  <pc-button appearance="text" slot="footer">Close</pc-button>
</pc-drawer>

<pc-button>Open drawer</pc-button>

<script>
  const drawer = document.querySelector(".drawer-custom-size");
  const openButton = drawer.nextElementSibling;
  const closeButton = drawer.querySelector('pc-button[slot="footer"]');

  openButton.addEventListener("click", () => drawer.show());
  closeButton.addEventListener("click", () => drawer.hide());
</script>

<style>
  .drawer-custom-size {
      --size: 50vw;
  }
</style>

Code

Scrolling

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.

<pc-drawer label="Drawer" class="drawer-scrolling">
  <div
      style="
          height: 150vh;
          border: 2px dashed var(--pc-color-neutral-200);
          border-radius: var(--pc-border-radius-l);
          padding: 0 var(--pc-spacing-l);
      "
  >
      <p>Scroll down and give it a try! 👇</p>
  </div>

  <pc-button appearance="text" slot="footer">Close</pc-button>
</pc-drawer>

<pc-button>Open drawer</pc-button>

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

  openButton.addEventListener("click", () => drawer.show());
  closeButton.addEventListener("click", () => drawer.hide());
</script>

Code

Header actions

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

<pc-drawer label="Drawer" class="drawer-header-actions">
  <pc-icon-button
      class="new-window-button"
      library="default"
      icon-style="solid"
      name="arrow-up-right-from-square"
      slot="header-actions"
  ></pc-icon-button>
  Lorem ipsum dolor sit amet, consectetur adipiscing elit.
  <pc-button appearance="text" slot="footer">Close</pc-button>
</pc-drawer>

<pc-button>Open drawer</pc-button>

<script>
  const drawer = document.querySelector(".drawer-header-actions");
  const openButton = drawer.nextElementSibling;
  const closeButton = drawer.querySelector('pc-button[slot="footer"]');
  const newWindowButton = drawer.querySelector(".new-window-button");

  openButton.addEventListener("click", () => drawer.show());
  closeButton.addEventListener("click", () => drawer.hide());
  newWindowButton.addEventListener("click", () => window.open(location.href));
</script>

Code

Prevent drawer from closing

By default, drawers will close when the user clicks the close button, clicks the overlay or presses the Esc key. In most cases, the default behaviour is the best behaviour 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 pc-request-close event. When cancelled, 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 to request to close. This example prevents the drawer from closing when the overlay is clicked, but allows the close button or Esc to dismiss it.

<pc-drawer label="Drawer" class="drawer-deny-close">
  This drawer will not close when you click on the overlay.
  <pc-button appearance="text" slot="footer">Close</pc-button>
</pc-drawer>

<pc-button>Open drawer</pc-button>

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

  drawer.addEventListener("pc-request-close", (event) => {
      if (event.detail.source === "overlay") {
          event.preventDefault();
      }
  });

  openButton.addEventListener("click", () => drawer.show());
  closeButton.addEventListener("click", () => drawer.hide());
</script>

Code

Customise initial focus

By default, the drawer’s panel will gain focus when opened. This allows a subsequent tab press to focus on the first tabbable element in the drawer. If you want a different element to have focus, add the autofocus attribute to it as shown below.

<pc-drawer label="Drawer" class="drawer-focus">
  <pc-input
      placeholder="I will have focus when the drawer is opened"
      aria-placeholder="I will have focus when the drawer is opened"
      autofocus
  ></pc-input>

  <pc-button appearance="text" slot="footer">Close</pc-button>
</pc-drawer>

<pc-button>Open drawer</pc-button>

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

  openButton.addEventListener("click", () => drawer.show());
  closeButton.addEventListener("click", () => drawer.hide());
</script>

Code

You can further customise initial focus behaviour by cancelling the pc-initial-focus event and setting focus yourself inside the event handler.

Properties

Name	Description	Default
`modal`	Exposes the internal modal utility that controls focus trapping. To temporarily disable focus trapping and allow third‐party modals spawned from an active Placer Toolkit modal, call `modal.activateExternal()` when the third‐party modal opens. Upon closing, call `modal.deactivateExternal()` to restore Placer Toolkit’s focus trapping.	`new Modal(this)`
`open`	Indicates whether or not the drawer is open. You can toggle this attribute to show and hide the drawer, or you can use the `show()` and `hide()` methods and this attribute will reflect the drawer’s open state. `boolean`	`false`
`label`	The drawer’s label as displayed in the header. You should always include a relevant label even when using `no-header`, as it is required for proper accessibility. If you need to display HTML, use the `label` slot instead. `string`	`""`
`placement`	The direction from which the drawer will open. `"top" \| "end" \| "bottom" \| "start"`	`"end"`
`contained`	By default, the drawer slides out of its containing block (usually the viewport). To make the drawer slide out of its parent element, set this attribute and add `position: relative` to the parent. `boolean`	`false`
`noHeader` `no-header`	This removes the header. This will also remove the default close button, so please ensure you provide an easy, accessible way for users to dismiss the drawer. `boolean`	`false`
`updateComplete`	A read‐only promise that resolves when the component has finished updating.	-

Learn more about attributes and properties.

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 `<pc-icon-button>`.
`footer`	The drawer’s footer, usually one or more buttons representing various options.

Learn more about using slots.

Methods

Name	Description	Arguments
`show()`	Shows the drawer.	-
`hide()`	Hides the drawer.	-

Learn more about methods.

Events

Name	Description	Event detail
`pc-show`	Emitted when the drawer opens.	-
`pc-after-show`	Emitted after the drawer opens and all animations are complete.	-
`pc-hide`	Emitted when the drawer closes.	-
`pc-after-hide`	Emitted after the drawer closes and all animations are complete.	-
`pc-initial-focus`	Emitted when the drawer opens and is ready to receive focus. Calling `event.preventDefault()` will prevent focusing and allow you to set it on a different element, such as an input.	-
`pc-request-close`	Emitted when the user attempts to close the drawer by clicking the close button, clicking the overlay or pressing `Esc`. Calling `event.preventDefault()` will keep the drawer open. Avoid using this unless closing the drawer will result in destructive behavior such as data loss.	`{ source: "close-button" \| "keyboard" \| "overlay" }`

Learn more about events.

Custom properties

Name	Description	Default
`--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.	-
`--header-spacing`	The amount of padding to use for the header.	-
`--body-spacing`	The amount of padding to use for the body.	-
`--footer-spacing`	The amount of padding to use for the footer.	-

Learn more about customising custom properties.

Parts

Name	Description
`base`	The component’s base wrapper.
`overlay`	The overlay that covers the screen behind the drawer.
`panel`	The drawer’s panel (where the drawer and its content are rendered).
`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 `<pc-icon-button>`.
`title`	The drawer’s title.
`close-button`	The close button, an `<pc-icon-button>`.
`close-button__base`	The close button’s exported `base` part.
`body`	The drawer’s body.
`footer`	The drawer’s footer.

Learn more about customising CSS parts.

Animations

Name	Description
`drawer.showTop`	The animation to use when showing a drawer with `top` placement.
`drawer.showEnd`	The animation to use when showing a drawer with `end` placement.
`drawer.showBottom`	The animation to use when showing a drawer with `bottom` placement.
`drawer.showStart`	The animation to use when showing a drawer with `start` placement.
`drawer.hideTop`	The animation to use when hiding a drawer with `top` placement.
`drawer.hideEnd`	The animation to use when hiding a drawer with `end` placement.
`drawer.hideBottom`	The animation to use when hiding a drawer with `bottom` placement.
`drawer.hideStart`	The animation to use when hiding a drawer with `start` placement.
`drawer.denyClose`	The animation to use when a request to close the drawer is denied.
`drawer.overlay.show`	The animation to use when showing the drawer’s overlay.
`drawer.overlay.hide`	The animation to use when hiding the drawer’s overlay.

Learn more about customising animations.

Importing

If you’re using the autoloader or the standard loader, you can ignore this section. If you’re cherry picking, you can use any of the following snippets to import this component.

Script

Import

Bundler

To import this component from the CDN with a script tag, copy this snippet and paste it in your HTML.

<script type="module" src="https://cdn.jsdelivr.net/npm/placer-toolkit@0.5.1/dist/components/drawer/drawer.js"></script>

To import this component from the CDN using a JavaScript import, copy this snippet and paste it in your JavaScript:

import "https://cdn.jsdelivr.net/npm/placer-toolkit@0.5.1/dist/components/drawer/drawer.js";

To import this component with a bundler using a JavaScript import, copy this snippet and paste it in your JavaScript:

import "placer-toolkit/dist/components/drawer/drawer.js";

Dependencies

This component automatically imports these components:

Icon Button