Drawers slide in from the edge of the screen and are used to display content.


The default drawer has a title and a close button.

Storybook failed to load.

Text button

Drawers can be configured to display the close button as text - useful for when a close icon doesn't fit the context.

Storybook failed to load.


Backpack drawer component.


Check the main Readme for a complete installation guide.


                                                import { Component } from 'react';
                                                import BpkDrawer from '@skyscanner/backpack-web/bpk-component-drawer';
                                                import BpkButton from '@skyscanner/backpack-web/bpk-component-button';
                                                class App extends Component {
                                                  constructor() {
                                                    this.state = {
                                                      isOpen: false,
                                                  onOpen = () => {
                                                      isOpen: true,
                                                  onClose = () => {
                                                      isOpen: false,
                                                  render() {
                                                    return (
                                                        <div id="pagewrap">
                                                          <BpkButton onClick={this.onOpen}>Open drawer</BpkButton>
                                                          title="Drawer title"
                                                          closeLabel="Close drawer"
                                                          getApplicationElement={() => document.getElementById('pagewrap')}
                                                          This is a drawer. You can put anything you want in here.

Note: In order to "hide" your application from screen readers whilst the drawer is open you need to let it know what the root element for your application is by returning it's DOM node via the function passed to the getApplicationElement prop (see the example above). The pagewrap element id is a convention we use internally at Skyscanner. In most cases it should "just work".

Theming: In order to theme the drawer, a renderTarget needs to be supplied as a function which returns a DOM node in the scope of a BpkThemeProvider.


Property PropType Required Default Value
id string true -
className string true -
contentClassName string true -
children node true -
isOpen bool true -
onClose func true -
title string true -
getApplicationElement func true -
closeLabel string false null
closeText string false null
hideTitle bool false false
renderTarget func false null

Theme Props

  • linkColor
  • linkHoverColor
  • linkActiveColor
  • linkVisitedColor