Du kan inte välja fler än 25 ämnen Ämnen måste starta med en bokstav eller siffra, kan innehålla bindestreck ('-') och vara max 35 tecken långa.

README.md 1.8 KiB

3 år sedan
123456789101112131415161718192021222324252627282930
  1. # react-overlays
  2. [![test status][test-badge]][actions]
  3. [![deploy docs status][deploy-docs-badge]][actions]
  4. [![codecov][codecov-badge]][codecov]
  5. [![Netlify Status](https://api.netlify.com/api/v1/badges/e86fa356-4480-409e-9c24-52ea0660a923/deploy-status)](https://app.netlify.com/sites/react-overlays/deploys)
  6. Utilities for creating robust overlay components
  7. demos and docs at: https://react-bootstrap.github.io/react-overlays/modal/
  8. ## Install
  9. ```sh
  10. npm install --save react-overlays
  11. ```
  12. 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.
  13. If you are looking for more complete overlays, modals, or tooltips--something you can use right out of the box--check out react-bootstrap, which is (or soon will be) built on using these components.
  14. **note:** we are still in the process of abstracting out these components so the API's will probably change until we are sure that all of the bootstrap components can cleanly be implemented on top of them.
  15. Pre `1.0.0` breaking changes happen on the `minor` bump while feature and patches accompany a `patch` bump.
  16. [actions]: https://github.com/react-bootstrap/react-overlays/actions
  17. [codecov]: https://codecov.io/gh/react-bootstrap/react-overlays
  18. [codecov-badge]: https://codecov.io/gh/react-bootstrap/react-overlays/branch/master/graph/badge.svg
  19. [test-badge]: https://github.com/react-bootstrap/react-overlays/workflows/Run%20Tests/badge.svg
  20. [deploy-docs-badge]: https://github.com/react-bootstrap/react-overlays/workflows/Deploy%20Documentation/badge.svg