| 1 | # react-overlays
|
| 2 |
|
| 3 | [![CI status][ci-badge]][actions]
|
| 4 | [![Deploy docs status][deploy-docs-badge]][actions]
|
| 5 | [![Codecov][codecov-badge]][codecov]
|
| 6 | [](https://app.netlify.com/sites/react-overlays/deploys)
|
| 7 |
|
| 8 | Utilities for creating robust overlay components.
|
| 9 |
|
| 10 | ## Documentation
|
| 11 |
|
| 12 | https://react-bootstrap.github.io/react-overlays
|
| 13 |
|
| 14 | ## Installation
|
| 15 |
|
| 16 | ```sh
|
| 17 | npm install --save react-overlays
|
| 18 | ```
|
| 19 |
|
| 20 | ## Notes
|
| 21 |
|
| 22 | All of these utilities have been abstracted out of [React-Bootstrap](https://github.com/react-bootstrap/react-bootstrap) in order to provide better access to the generic implementations of these commonly-needed components. The included components are building blocks for creating more polished components. Everything is bring-your-own-styles, CSS or otherwise.
|
| 23 |
|
| 24 | If you are looking for more complete overlays, modals, or tooltips – something you can use out-of-the-box – check out React-Bootstrap, which is built using these components.
|
| 25 |
|
| 26 | [actions]: https://github.com/react-bootstrap/react-overlays/actions
|
| 27 | [codecov]: https://codecov.io/gh/react-bootstrap/react-overlays
|
| 28 | [codecov-badge]: https://codecov.io/gh/react-bootstrap/react-overlays/branch/master/graph/badge.svg
|
| 29 | [ci-badge]: https://github.com/react-bootstrap/react-overlays/workflows/CI/badge.svg
|
| 30 | [deploy-docs-badge]: https://github.com/react-bootstrap/react-overlays/workflows/Deploy%20Documentation/badge.svg
|