Components

Drawer

Slides in from the sides, top or bottom of the screen.

Usage

Change the opening side with the side prop.

Add a title to the header with the header slot. A close button is automatically included in the header.

The backdrop is blurred by default. Use backdrop="transparent"to remove the blur effect.

Page scrolling is locked by default when the drawer is open. Use thescrollLock= prop to allow scrolling while the drawer is open.

backdrop="transparent"

Astro

---
import { Button, Drawer, DrawerHeader, DrawerFooter } from "@opui/astro"
---

<div class="drawer-examples">
  <Button class="top" commandfor="drawer-block-start" command="show-modal"
    >Block Start</Button
  >
  <Button class="left" commandfor="drawer-inline-start" command="show-modal"
    >Inline Start</Button
  >
  <Button class="right" commandfor="drawer-inline-end" command="show-modal"
    >Inline End</Button
  >
  <Button class="bottom" commandfor="drawer-block-end" command="show-modal"
    >Block End</Button
  >
</div>

<Drawer id="drawer-inline-start" side="inline-start" closedby="any">
  <DrawerHeader slot="header" heading="Inline Start" />
  <Fragment slot="content">
    <p>
      Lorem ipsum dolor sit amet, consectetur adipiscing elit. Sed do eiusmod
      tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim
      veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea
      commodo consequat.
    </p>
    <p>
      Duis aute irure dolor in reprehenderit in voluptate velit esse cillum
      dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non
      proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
    </p>
    <p>
      Sed ut perspiciatis unde omnis iste natus error sit voluptatem accusantium
      doloremque laudantium, totam rem aperiam, eaque ipsa quae ab illo
      inventore veritatis et quasi architecto beatae vitae dicta sunt explicabo.
    </p>
    <p>
      Nemo enim ipsam voluptatem quia voluptas sit aspernatur aut odit aut
      fugit, sed quia consequuntur magni dolores eos qui ratione voluptatem
      sequi nesciunt. Neque porro quisquam est, qui dolorem ipsum quia dolor sit
      amet, consectetur, adipisci velit, sed quia non numquam eius modi tempora
      incidunt ut labore et dolore magnam aliquam quaerat voluptatem.
    </p>
    <p>
      Ut enim ad minima veniam, quis nostrum exercitationem ullam corporis
      suscipit laboriosam, nisi ut aliquid ex ea commodi consequatur? Quis autem
      vel eum iure reprehenderit qui in ea voluptate velit esse quam nihil
      molestiae consequatur, vel illum qui dolorem eum fugiat quo voluptas nulla
      pariatur?
    </p>
  </Fragment>
  <DrawerFooter slot="footer">
    <Button size="small" commandfor="drawer-inline-start" command="close"
      >Close</Button
    >
  </DrawerFooter>
</Drawer>

<Drawer id="drawer-inline-end" side="inline-end" closedby="any">
  <DrawerHeader slot="header" heading="Inline End" />
  <Fragment slot="content">
    <p>
      Lorem ipsum dolor sit amet, consectetur adipiscing elit. Sed do eiusmod
      tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim
      veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea
      commodo consequat.
    </p>
    <p>
      Duis aute irure dolor in reprehenderit in voluptate velit esse cillum
      dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non
      proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
    </p>
    <p>
      Sed ut perspiciatis unde omnis iste natus error sit voluptatem accusantium
      doloremque laudantium, totam rem aperiam, eaque ipsa quae ab illo
      inventore veritatis et quasi architecto beatae vitae dicta sunt explicabo.
    </p>
    <p>
      Nemo enim ipsam voluptatem quia voluptas sit aspernatur aut odit aut
      fugit, sed quia consequuntur magni dolores eos qui ratione voluptatem
      sequi nesciunt. Neque porro quisquam est, qui dolorem ipsum quia dolor sit
      amet, consectetur, adipisci velit, sed quia non numquam eius modi tempora
      incidunt ut labore et dolore magnam aliquam quaerat voluptatem.
    </p>
    <p>
      Ut enim ad minima veniam, quis nostrum exercitationem ullam corporis
      suscipit laboriosam, nisi ut aliquid ex ea commodi consequatur? Quis autem
      vel eum iure reprehenderit qui in ea voluptate velit esse quam nihil
      molestiae consequatur, vel illum qui dolorem eum fugiat quo voluptas nulla
      pariatur?
    </p>
  </Fragment>
  <DrawerFooter slot="footer">
    <Button size="small" commandfor="drawer-inline-end" command="close"
      >Close</Button
    >
  </DrawerFooter>
</Drawer>

<Drawer id="drawer-block-start" side="block-start" closedby="any">
  <DrawerHeader slot="header" heading="Block Start" />
  <Fragment slot="content">
    <p>
      Lorem ipsum dolor sit amet, consectetur adipiscing elit. Sed do eiusmod
      tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim
      veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea
      commodo consequat.
    </p>
    <p>
      Duis aute irure dolor in reprehenderit in voluptate velit esse cillum
      dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non
      proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
    </p>
    <p>
      Sed ut perspiciatis unde omnis iste natus error sit voluptatem accusantium
      doloremque laudantium, totam rem aperiam, eaque ipsa quae ab illo
      inventore veritatis et quasi architecto beatae vitae dicta sunt explicabo.
    </p>
  </Fragment>
  <DrawerFooter slot="footer">
    <Button size="small" commandfor="drawer-block-start" command="close"
      >Close</Button
    >
  </DrawerFooter>
</Drawer>

<Drawer id="drawer-block-end" side="block-end" closedby="any">
  <DrawerHeader slot="header" heading="Block End" />
  <Fragment slot="content">
    <p>
      Lorem ipsum dolor sit amet, consectetur adipiscing elit. Sed do eiusmod
      tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim
      veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea
      commodo consequat.
    </p>
    <p>
      Duis aute irure dolor in reprehenderit in voluptate velit esse cillum
      dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non
      proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
    </p>
    <p>
      Sed ut perspiciatis unde omnis iste natus error sit voluptatem accusantium
      doloremque laudantium, totam rem aperiam, eaque ipsa quae ab illo
      inventore veritatis et quasi architecto beatae vitae dicta sunt explicabo.
    </p>
  </Fragment>
  <DrawerFooter slot="footer">
    <Button size="small" commandfor="drawer-block-end" command="close"
      >Close</Button
    >
  </DrawerFooter>
</Drawer>

Output

<div class="drawer-examples">
  <button
    commandfor="drawer-block-start"
    command="show-modal"
    class="ui-button top"
  >
    Block Start</button
  ><button
    commandfor="drawer-inline-start"
    command="show-modal"
    class="ui-button left"
  >
    Inline Start</button
  ><button
    commandfor="drawer-inline-end"
    command="show-modal"
    class="ui-button right"
  >
    Inline End</button
  ><button
    commandfor="drawer-block-end"
    command="show-modal"
    class="ui-button bottom"
  >
    Block End
  </button>
</div>
<dialog
  closedby="any"
  class="ui-drawer ui-inline-start ui-scroll-lock"
  id="drawer-inline-start"
>
  <div class="ui-header" slot="header">
    <span>Inline Start</span
    ><button
      onclick="this.closest('dialog').close()"
      title="Close"
      class="ui-icon-button"
    >
      <svg
        xmlns="http://www.w3.org/2000/svg"
        width="32"
        height="32"
        viewBox="0 0 32 32"
      >
        <path
          fill="currentColor"
          d="M26.29 4.293a1 1 0 1 1 1.414 1.414L17.413 16l10.291 10.29a1 1 0 1 1-1.414 1.414L16 17.413L5.707 27.704a1 1 0 0 1-1.414-1.414L14.585 16L4.293 5.707a1 1 0 0 1 1.414-1.414L16 14.584z"
        ></path>
      </svg>
    </button>
  </div>
  <div class="ui-content">
    <p>
      Lorem ipsum dolor sit amet, consectetur adipiscing elit. Sed do eiusmod
      tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim
      veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea
      commodo consequat.
    </p>
    <p>
      Duis aute irure dolor in reprehenderit in voluptate velit esse cillum
      dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non
      proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
    </p>
    <p>
      Sed ut perspiciatis unde omnis iste natus error sit voluptatem accusantium
      doloremque laudantium, totam rem aperiam, eaque ipsa quae ab illo
      inventore veritatis et quasi architecto beatae vitae dicta sunt explicabo.
    </p>
    <p>
      Nemo enim ipsam voluptatem quia voluptas sit aspernatur aut odit aut
      fugit, sed quia consequuntur magni dolores eos qui ratione voluptatem
      sequi nesciunt. Neque porro quisquam est, qui dolorem ipsum quia dolor sit
      amet, consectetur, adipisci velit, sed quia non numquam eius modi tempora
      incidunt ut labore et dolore magnam aliquam quaerat voluptatem.
    </p>
    <p>
      Ut enim ad minima veniam, quis nostrum exercitationem ullam corporis
      suscipit laboriosam, nisi ut aliquid ex ea commodi consequatur? Quis autem
      vel eum iure reprehenderit qui in ea voluptate velit esse quam nihil
      molestiae consequatur, vel illum qui dolorem eum fugiat quo voluptas nulla
      pariatur?
    </p>
  </div>
  <div class="ui-footer" slot="footer">
    <button
      commandfor="drawer-inline-start"
      command="close"
      class="ui-button ui-small"
    >
      Close
    </button>
  </div>
</dialog>
<dialog
  closedby="any"
  class="ui-drawer ui-inline-end ui-scroll-lock"
  id="drawer-inline-end"
>
  <div class="ui-header" slot="header">
    <span>Inline End</span
    ><button
      onclick="this.closest('dialog').close()"
      title="Close"
      class="ui-icon-button"
    >
      <svg
        xmlns="http://www.w3.org/2000/svg"
        width="32"
        height="32"
        viewBox="0 0 32 32"
      >
        <path
          fill="currentColor"
          d="M26.29 4.293a1 1 0 1 1 1.414 1.414L17.413 16l10.291 10.29a1 1 0 1 1-1.414 1.414L16 17.413L5.707 27.704a1 1 0 0 1-1.414-1.414L14.585 16L4.293 5.707a1 1 0 0 1 1.414-1.414L16 14.584z"
        ></path>
      </svg>
    </button>
  </div>
  <div class="ui-content">
    <p>
      Lorem ipsum dolor sit amet, consectetur adipiscing elit. Sed do eiusmod
      tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim
      veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea
      commodo consequat.
    </p>
    <p>
      Duis aute irure dolor in reprehenderit in voluptate velit esse cillum
      dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non
      proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
    </p>
    <p>
      Sed ut perspiciatis unde omnis iste natus error sit voluptatem accusantium
      doloremque laudantium, totam rem aperiam, eaque ipsa quae ab illo
      inventore veritatis et quasi architecto beatae vitae dicta sunt explicabo.
    </p>
    <p>
      Nemo enim ipsam voluptatem quia voluptas sit aspernatur aut odit aut
      fugit, sed quia consequuntur magni dolores eos qui ratione voluptatem
      sequi nesciunt. Neque porro quisquam est, qui dolorem ipsum quia dolor sit
      amet, consectetur, adipisci velit, sed quia non numquam eius modi tempora
      incidunt ut labore et dolore magnam aliquam quaerat voluptatem.
    </p>
    <p>
      Ut enim ad minima veniam, quis nostrum exercitationem ullam corporis
      suscipit laboriosam, nisi ut aliquid ex ea commodi consequatur? Quis autem
      vel eum iure reprehenderit qui in ea voluptate velit esse quam nihil
      molestiae consequatur, vel illum qui dolorem eum fugiat quo voluptas nulla
      pariatur?
    </p>
  </div>
  <div class="ui-footer" slot="footer">
    <button
      commandfor="drawer-inline-end"
      command="close"
      class="ui-button ui-small"
    >
      Close
    </button>
  </div>
</dialog>
<dialog
  closedby="any"
  class="ui-drawer ui-block-start ui-scroll-lock"
  id="drawer-block-start"
>
  <div class="ui-header" slot="header">
    <span>Block Start</span
    ><button
      onclick="this.closest('dialog').close()"
      title="Close"
      class="ui-icon-button"
    >
      <svg
        xmlns="http://www.w3.org/2000/svg"
        width="32"
        height="32"
        viewBox="0 0 32 32"
      >
        <path
          fill="currentColor"
          d="M26.29 4.293a1 1 0 1 1 1.414 1.414L17.413 16l10.291 10.29a1 1 0 1 1-1.414 1.414L16 17.413L5.707 27.704a1 1 0 0 1-1.414-1.414L14.585 16L4.293 5.707a1 1 0 0 1 1.414-1.414L16 14.584z"
        ></path>
      </svg>
    </button>
  </div>
  <div class="ui-content">
    <p>
      Lorem ipsum dolor sit amet, consectetur adipiscing elit. Sed do eiusmod
      tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim
      veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea
      commodo consequat.
    </p>
    <p>
      Duis aute irure dolor in reprehenderit in voluptate velit esse cillum
      dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non
      proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
    </p>
    <p>
      Sed ut perspiciatis unde omnis iste natus error sit voluptatem accusantium
      doloremque laudantium, totam rem aperiam, eaque ipsa quae ab illo
      inventore veritatis et quasi architecto beatae vitae dicta sunt explicabo.
    </p>
  </div>
  <div class="ui-footer" slot="footer">
    <button
      commandfor="drawer-block-start"
      command="close"
      class="ui-button ui-small"
    >
      Close
    </button>
  </div>
</dialog>
<dialog
  closedby="any"
  class="ui-drawer ui-block-end ui-scroll-lock"
  id="drawer-block-end"
>
  <div class="ui-header" slot="header">
    <span>Block End</span
    ><button
      onclick="this.closest('dialog').close()"
      title="Close"
      class="ui-icon-button"
    >
      <svg
        xmlns="http://www.w3.org/2000/svg"
        width="32"
        height="32"
        viewBox="0 0 32 32"
      >
        <path
          fill="currentColor"
          d="M26.29 4.293a1 1 0 1 1 1.414 1.414L17.413 16l10.291 10.29a1 1 0 1 1-1.414 1.414L16 17.413L5.707 27.704a1 1 0 0 1-1.414-1.414L14.585 16L4.293 5.707a1 1 0 0 1 1.414-1.414L16 14.584z"
        ></path>
      </svg>
    </button>
  </div>
  <div class="ui-content">
    <p>
      Lorem ipsum dolor sit amet, consectetur adipiscing elit. Sed do eiusmod
      tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim
      veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea
      commodo consequat.
    </p>
    <p>
      Duis aute irure dolor in reprehenderit in voluptate velit esse cillum
      dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non
      proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
    </p>
    <p>
      Sed ut perspiciatis unde omnis iste natus error sit voluptatem accusantium
      doloremque laudantium, totam rem aperiam, eaque ipsa quae ab illo
      inventore veritatis et quasi architecto beatae vitae dicta sunt explicabo.
    </p>
  </div>
  <div class="ui-footer" slot="footer">
    <button
      commandfor="drawer-block-end"
      command="close"
      class="ui-button ui-small"
    >
      Close
    </button>
  </div>
</dialog>

How to close a drawer

Use the closedby prop to control the closing behavior.

Prop	Description
`closedby="any"`	Click anywhere outside of the drawer to close it.
`closedby="closerequest"`	Device-specific way to close, ex: `Esc` on desktop, back button on mobile, and whatever dismiss action assistive tools use.
`closedby="none"`	You have to handroll a closing solution yourself.

Accessibility

The autofocus attribute should be added to the element the user is expected to interact with immediately upon opening a modal dialog. If no other element involves more immediate interaction, it is recommended to add autofocus to the close button inside the dialog, or the dialog itself if the user is expected to click/activate it to dismiss.
Do not add the tabindex property to the<dialog> element as it is not interactive and does not receive focus. The dialog's contents, including the close button contained in the dialog, can receive focus and be interactive.

Source: MDN

Role & attributes

Role/attribute	Usage
`role="dialog"`	Identifies the element that serves as the drawer container.
`aria-labelledby="IDREF"`	Gives the drawer an accessible name by referring to the element that provides the drawer title.
`aria-describedby="IDREF"`	Gives the drawer an accessible description by referring to the drawer content that describes the primary message or purpose of the drawer.
`aria-modal="true"`	Tells assistive technologies that the windows underneath the current drawer are not available for interaction (inert).

Keyboard support

Key	Function
`Tab`	Moves focus to next focusable element inside the drawer. When focus is on the last focusable element in the drawer, moves focus to the first focusable element in the drawer.
`Shift + Tab`	Moves focus to previous focusable element inside the drawer. When focus is on the first focusable element in the drawer, moves focus to the last focusable element in the drawer.
`Esc`	Closes the drawer.

API

Drawer API

Prop	Type	Default	Description
`backdrop`	`"transparent"`, `"blurred"`	`"blurred"`	The backdrop style.
`closedby`	`"none"`, `"any"`, `"closerequest"`	`"any"`	How the drawer can be closed. `"any"` also closes it on a click outside.
`id`	`string`	-	The id of the `<dialog>`. Generated when omitted.
`scrollLock`	`boolean`	`true`	Locks page scroll while the drawer is open.
`side`	`"inline-start"`, `"inline-end"`, `"block-start"`, `"block-end"`	`"inline-start"`	The side it opens from.

Slots

Slot	Description
`content`	The scrollable content.
`default`	Raw content placed directly in the drawer.
`footer`	The footer. `DrawerFooter` renders it.
`header`	The header. `DrawerHeader` renders it with a close button.

Prop	Type	Default	Description
`heading`	`string`	-	The heading.

Slots

Slot	Description
`default`	Content placed between the heading and the close button.

Browser support

See also the full browser support guide.

Installation

drawer.css

@layer components.root {
  :where(dialog.ui-drawer) {
    --_motion: var(--motion, 1);
    --_backdrop-bg-color: transparent;
    --_backdrop-blur: blur(2px);
    --_bg-color: var(--surface-default);
    --_block-size: min(80vb, 650px);
    --_border-color: var(--border-color);
    --_border-width: var(--border-width);
    --_color: var(--text-primary);
    --_content-padding: var(--size-4);
    --_footer-gap: var(--size-3);
    --_footer-padding: var(--size-3);
    --_header-font-size: var(--font-size-3);
    --_header-padding: var(--size-3);
    --_inline-size: min(375px, 100vi);
    --_shadow: var(--shadow-2);
    --_transition-duration: calc(0.2s * var(--_motion));
    --_transition-timing: var(--ease-out-3);

    background-color: var(--_bg-color);
    border: none;
    box-shadow: var(--_shadow);
    color: var(--_color);
    display: flex;
    flex-direction: column;
    margin: 0;
    max-inline-size: 100%;
    padding: 0;
    position: fixed;
    transition:
      display var(--_transition-duration) allow-discrete,
      overlay var(--_transition-duration) allow-discrete,
      translate var(--_transition-duration) var(--_transition-timing);
    z-index: 1000;

    &::backdrop {
      backdrop-filter: var(--_backdrop-blur);
      background-color: var(--_backdrop-bg-color);
      opacity: 0;
      transition:
        display var(--_transition-duration) allow-discrete,
        overlay var(--_transition-duration) allow-discrete,
        opacity var(--_transition-duration) var(--_transition-timing);
    }

    &.ui-backdrop-transparent {
      --_backdrop-blur: none;
    }

    .ui-header {
      align-items: center;
      border-block-end: var(--_border-width) solid var(--_border-color);
      display: flex;
      padding: var(--_header-padding);

      :where(h1, h2, h3, h4, h5, h6) {
        font-size: var(--_header-font-size);
        margin: 0;
      }

      :where(.ui-icon-button) {
        margin-inline-start: auto;
      }
    }

    .ui-content {
      flex: 1;
      overflow-y: auto;
      padding: var(--_content-padding);
    }

    .ui-footer {
      border-block-start: var(--_border-width) solid var(--_border-color);
      display: flex;
      gap: var(--_footer-gap);
      justify-content: end;
      padding: var(--_footer-padding);
    }

    &.ui-inline-start,
    &.ui-inline-end {
      block-size: 100dvb;
      inline-size: var(--_inline-size);
      inset-block: 0;
      max-block-size: 100%;
    }

    &.ui-inline-start {
      border-inline-end: var(--_border-width) solid var(--_border-color);
      inset-inline-end: auto;
      inset-inline-start: 0;
      translate: -100% 0;
    }

    &.ui-inline-end {
      border-inline-start: var(--_border-width) solid var(--_border-color);
      inset-inline-end: 0;
      inset-inline-start: auto;
      translate: 100% 0;

      .ui-footer {
        justify-content: start;
      }
    }

    &.ui-block-start,
    &.ui-block-end {
      block-size: var(--_block-size);
      inline-size: 100dvi;
      inset-inline: 0;
      max-block-size: 80dvb;
    }

    &.ui-block-start {
      border-block-end: var(--_border-width) solid var(--_border-color);
      inset-block-end: auto;
      inset-block-start: 0;
      translate: 0 -100%;
    }

    &.ui-block-end {
      border-block-start: var(--_border-width) solid var(--_border-color);
      inset-block-end: 0;
      inset-block-start: auto;
      translate: 0 100%;
    }

    &[open] {
      translate: 0 0;

      &::backdrop {
        opacity: 1;
      }

      @starting-style {
        &::backdrop {
          opacity: 0;
        }

        &.ui-inline-start {
          translate: -100% 0;
        }

        &.ui-inline-end {
          translate: 100% 0;
        }

        &.ui-block-start {
          translate: 0 -100%;
        }

        &.ui-block-end {
          translate: 0 100%;
        }
      }
    }
  }

  /* Scroll-lock is provided by the shared `.ui-scroll-lock` utility in core/utils.css. */
  html:has(dialog.ui-drawer.ui-scroll-lock[open].ui-backdrop-transparent) {
    overflow: unset;
    overscroll-behavior: auto;

    @media (width < 500px) {
      overflow: clip;
      overscroll-behavior: contain;
    }
  }
}

Theme config

Drawer

Usage

How to close a drawer

Accessibility

Role & attributes

Keyboard support

API

Drawer API

Slots

Drawer header API

Slots

Browser support

Installation