GoScrobble/web/node_modules/react-overlays/README.md

31 lines
1.4 KiB
Markdown
Raw Normal View History

2022-04-25 02:47:15 +00:00
# react-overlays
[![CI status][ci-badge]][actions]
[![Deploy docs status][deploy-docs-badge]][actions]
[![Codecov][codecov-badge]][codecov]
[![Netlify Status](https://api.netlify.com/api/v1/badges/e86fa356-4480-409e-9c24-52ea0660a923/deploy-status)](https://app.netlify.com/sites/react-overlays/deploys)
Utilities for creating robust overlay components.
## Documentation
https://react-bootstrap.github.io/react-overlays
## Installation
```sh
npm install --save react-overlays
```
## Notes
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.
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.
[actions]: https://github.com/react-bootstrap/react-overlays/actions
[codecov]: https://codecov.io/gh/react-bootstrap/react-overlays
[codecov-badge]: https://codecov.io/gh/react-bootstrap/react-overlays/branch/master/graph/badge.svg
[ci-badge]: https://github.com/react-bootstrap/react-overlays/workflows/CI/badge.svg
[deploy-docs-badge]: https://github.com/react-bootstrap/react-overlays/workflows/Deploy%20Documentation/badge.svg