1.1.0 • Published 6 years ago

react-bottomsheet v1.1.0

Weekly downloads
456
License
-
Repository
github
Last release
6 years ago

react-bottomsheet

version download

react bottom sheet component. It is not for react-native.

Demo & Examples

Live demo: BellaChoi.github.io/components/demos/react-bottomsheet

npm.io

To build the examples locally, run:

npm install
npm start

Then open localhost:8000 in a browser.

Installation

The easiest way to use react-bottomsheet is to install it from NPM and include it in your own React build process (using Browserify, Webpack, etc).

You can also use the standalone build by including dist/react-bottomsheet.js in your page. If you use this, make sure you have already included React, and it is available as a global variable.

npm install react-bottomsheet --save

Usage

var ReactBottomsheet = require('react-bottomsheet');

...

toggleBottomSheet () {
  let obj = (this.state.bottomSheet) ? { 'bottomSheet': false } : { 'bottomSheet': true }
  this.setState(obj)
}

...

let obj = []
obj.push({
  title: 'modify',
  handler: () => {
    window.alert('modify clicked!')
  }
})
obj.push({
  title: 'delete',
  handler: () => {
    window.alert('delete clicked!')
  }
})

...

<div>
  <button className='example' onClick={this.toggleBottomSheet.bind(this)}>open bottom sheet!</button>
  <ReactBottomsheet
    visible={this.state.bottomSheet}
    onClose={this.toggleBottomSheet.bind(this)}
    list={obj} />
</div>

custom menu

<ReactBottomsheet
  visible={this.state.bottomSheet}
  onClose={this.toggleBottomSheet.bind(this)}>
  <button className='bottom-sheet-item' onClick={this.onClickMenu1}>Menu1</button>
  <button className='bottom-sheet-item' onClick={this.onClickMenu2}>Menu2</button>
</ReactBottomsheet>

custom layout

let customLayout = (
  <div className='custom-layout'>Custom</div>
)

<ReactBottomsheet
  visible={this.state.bottomSheet}
  onClose={this.toggleBottomSheet.bind(this)}
  customLayout={customLayout}
  list={obj} />

Properties

PropertyTypeDescriptionDefault
showBlockLayerboolshow background layerTrue
visibleboolInitialize stateTrue
appendCancelBtnboolInitialize show cancel buttonTrue
classNamestringcustom class name
customLayoutstringhtml to add custom layout
onClosefunctioncallback at close (control state)
onCloseFinishAnimationfunctioncallback at close (after animation finish)

Development (src, lib and the build process)

NOTE: The source code for the component is in src. A transpiled CommonJS version (generated with Babel) is available in lib for use with node.js, browserify and webpack. A UMD bundle is also built to dist, which can be included without the need for any build system.

To build, watch and serve the examples (which will also watch the component source), run npm start. If you just want to watch changes to src and rebuild lib, run npm run watch (this is useful if you are working with npm link).

License

Copyright (c) 2017 BellaChoi.