1.0.3 • Published 5 years ago

react-simple-drawer v1.0.3

Weekly downloads
144
License
MIT
Repository
github
Last release
5 years ago

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>
    )
  }
}
propsDescriptionTypeRequiredDefault
ctaTo invoke the drawer (button, span etc..)ReactNodeYesNone
closeOnMaskClickclose the drawer by clicking mask areabooleanNotrue
maskableshow an overlay on the empty area outisde drawerbooleanNotrue
opendrawer is visible or notbooleanNofalse
placementplace where drawer appears fromright, left, top, bottomNoright
closableDisplay close icon on the drawerbooleanNofalse
closeIconcustom close icon in drawernodeNosvg
closeOnEscapePressClose drawer on esc key pressbooleanNotrue

License

MIT © georgejustin22

1.0.3

5 years ago

1.0.2

5 years ago

1.0.1

5 years ago

1.0.0

5 years ago