react-overlay-popup
v4.0.2
Published
Overlay and popup components for React.
Downloads
28
Readme
react-overlay-popup
Overlay and Popup components for React. Brought to you by Taskworld Inc.
Synopsis
const { Overlay, Popup } = require('react-overlay-popup');
See: src/App.js for example.
Overlay
Anything inside <Overlay></Overlay>
will be added to a separate DOM tree appended to document.body
.
Just that.
Popup
A special kind of Overlay that automatically positions itself relative to its parent.
The position is specified through the strategy
prop.
The gap
prop specifies how far should the popup be to its parent.
Prerequisites
You will need the following things properly installed on your computer.
Installation
git clone <repository-url>
this repository- change into the new directory
npm install
Running / Development
nwb serve
will run the component's demo app- Visit the demo at http://localhost:3000
Running Tests
nwb test
will run the tests oncenwb test --server
will run the tests on every change
Building
nwb build