react-simple-drawer

Simple React drawer

NPM JavaScript Style Guide

Install

npm install --save react-simple-drawer

Usage

import React, { Component } from 'react'

import Drawer from 'react-simple-drawer'
import 'react-simple-drawer/dist/index.css'

class Example extends Component {
  render() {
    return (
      <Drawer 
        cta={ <button> Open drawer </button> }
        maskable={true}
        placement={placement}
        open={false}
      >
        <p>
          This is the drawer body content
        </p>
      </Drawer>
    )
  }
}
props Description Type Required Default
cta To invoke the drawer (button, span etc..) ReactNode Yes None
closeOnMaskClick close the drawer by clicking mask area boolean No true
maskable show an overlay on the empty area outisde drawer boolean No true
open drawer is visible or not boolean No false
placement place where drawer appears from right, left, top, bottom No right
closable Display close icon on the drawer boolean No false
closeIcon custom close icon in drawer node No svg
closeOnEscapePress Close drawer on esc key press boolean No true

License

MIT © georgejustin22