Skip to content
This repository has been archived by the owner on Oct 21, 2021. It is now read-only.

Latest commit

 

History

History
76 lines (42 loc) · 1.79 KB

README.md

File metadata and controls

76 lines (42 loc) · 1.79 KB

react-overlay-popup

Travis npm package codecov.io

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 strategy and the formula behind the magic.

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

Running Tests

  • nwb test will run the tests once
  • nwb test --server will run the tests on every change

Building

  • nwb build