Package Exports
- react-drag-drawer
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (react-drag-drawer) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
react-drag-drawer
Mobile draggable drawer that falls back to modals on desktop
Install
/* React */
$ npm install react-drag-drawer react-motion --save
/* Preact */
$ npm install react-drag-drawer preact-motion --save
Usage
import Drawer from 'react-drag-drawer'
..
toggle = () => {
let { toggle } = this.state
this.setState({ toggle: !toggle })
}
logState = () => {
console.log(`Drawer now ${this.state.open ? 'open' : 'closed'}`)
}
render () {
const { open } = this.state
return (
<Drawer
open={open}
onRequestClose={this.toggle}
onRest={this.logState}
>
<div>Hey Im inside the drawer!</div>
</Drawer>
)
}
API
Param | Type | functionality | required |
---|---|---|---|
open | Boolean | null | true |
children | Node | null | true |
onRequestClose | Function | null | true |
onDrag | Function | invoked on drag | false |
onOpen | Function | invoked on drawer focus | false |
notifyWillClose | Function | notify HOC if the drawer will close | false |
onClose | Function | invoked on drawer close | false |
onRest | Function | invoked on finish of open/close animation | false |
allowClose | Boolean | block closing if allowClose={false}, default is true | false |
overlayOpacity | Number | 0.6 unless different value is passed in | false |
scrollToClose | Number | pixel drag to trigger onRequestClose | false |
modalElementClass | Object | className to be applied to top |
false |
containerStyle | Object | styles to be applied to the drawer container | false |
disableDrag | Boolean | makes the drawer undraggable - basically just a modal | false |
maxNegativeScroll | Number | distance a drawer can be dragged above the bottom of the window container | false |
parentElement | ref | block scrolls on element if you're not using body scrolling | false |
spring | Object | React motion spring config | false |
escapeClose | Boolean | Close modal if escape button is pressed | false |
direction | String | direction to translate drawer | false |
Example modal style
.modal {
outline: none;
background: white;
font-size: 1.6rem;
width: 76rem;
max-width: 90%;
display: flex;
justify-content: space-between;
flex-direction: column;
z-index: 15;
min-height: 47rem;
will-change: transform;
transform: translate3d(0, 0, 0);
}
@media (max-width: 768px) {
.modal {
width: 100%;
max-width: 100%;
margin-bottom: 0;
border-top-left-radius: 8px;
border-top-right-radius: 8px;
}
}
TODO
- Figure out optimal way of handling styling (radium, CSS-Modules,