Giter VIP home page Giter VIP logo

react-simple-drawer's Introduction

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

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.