A simple side drawer written as HTML custom element

Published on webcomponents.org npm

CircleCI

side-drawer

A simple, animating side drawer built as a Web Component

side-drawer demo

Demo

Installation

You can integrate side-drawer via <script> tag or via NPM.

Via <script> tag

In the <head> of your index.html put a script tag like this:

<script
  type="module"
  src="https://unpkg.com/side-drawer/dist/esm/side-drawer.min.js"
></script>
<script
  nomodule
  src="https://unpkg.com/side-drawer/dist/iife/side-drawer.min.js"
></script>

Now you can use the side-drawer element anywhere in your html, JSX, template, etc.

Via NPM

npm install side-drawer --save

And then you need to import the module before you can use it in your html/jsx/template:

import "side-drawer";

Web Component Browser Support

This web component uses HTML templates, the shadow DOM, and custom elements. If you need to polyfill for any of these standards then take a look at the web components polyfill.

API and Customization

Attributes/Properties

  • open
    • Add this attribute to open the drawer.
      • Example: <side-drawer open></side-drawer>
    • Set the property in Javascript to imperatively toggle the drawer
      • Example: drawer.open = true
    • In (p)react you might need to set undefined in your JSX (since false !== undefined for html attribute existence)
      • Example: <side-drawer open={this.state.isDrawerOpen || undefined}></side-drawer>

Events

  • open
    • Raised when the drawer is opened.
    • Example: drawer.addEventListener("open", handleOpen())
    • When subscribing in html listen for onopen
      • Ex: <side-drawer onopen="handleOpen()">
  • close -Raised when the drawer is closed.
    • Example: drawer.addEventListener("close", handleClose())
    • When subscribing in html listen for onclose
      • Ex: <side-drawer onclose="handleClose()">

Styling

You can style the side-drawer element as you would any regular element, in CSS. A list of supported CSS properties are below, along with the default values.

side-drawer {
  background-color: #ffffff;
  color: inherit;
  width: 350px;
  max-width: 75vw;
  border-top-right-radius: 0;
  border-bottom-right-radius: 0;
}

You can customize the overlay that appears to the right of the drawer (when it's open) by setting one of the following CSS variables.

  • --side-drawer-overlay-transition
    • Sets the transition
    • Default is opacity 0.25s ease-in-out 0.25s
  • --side-drawer-overlay-opacity
    • Sets the opacity of the overlay
    • Default is 0.7

Contribute

This project is built with standard HTML/CSS/TS, no frameworks or special web-component compilers here (for maximum simplicity and minimum size). If you want to learn more about writing custom elements see MDN or this web fundamentals page.

npm install
npm start

This will start a live-server on port localhost:8080. Any changes you make to files in lib/ or any changes to example/index.html should get live reloaded.

Install

Link to this version
ImportedReleased 29 April 2019MIT License
Framework Support
Browser Independent
Install with
npm install side-drawer"@2.2.0"
Run the above npm command in your project folder. If you have any issues installing, please contact the author.
Release notes - Version 2.2.0

Dependencies