# react-loader-overlay

> A react package for pre loader with overlay.

Latest version **1.0.0** (published 2022-02-02) · MIT license · 0 weekly downloads

## Install

```sh
npm install react-loader-overlay
pnpm add react-loader-overlay
yarn add react-loader-overlay
bun add react-loader-overlay
```

## Health

**Score 20/100 (F)** — status: abandoned.

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.0 |
| Published | 2022-02-02 |
| First published | 2022-01-18 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Node | * |
| Dependencies | 9 |
| Unpacked size | 12.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Muhaimenul Islam |
| Maintainers | muhaimenul |
| Keywords | react, loader, overlay, progressbar, preloader, spinner, loading, fade, components, transition |

## Links

- npm: https://www.npmjs.com/package/react-loader-overlay
- Repository: https://github.com/muhaimenul/react-loader-overlay
- Homepage: https://github.com/muhaimenul/react-loader-overlay#readme
- Issues: https://github.com/muhaimenul/react-loader-overlay/issues
- npm.io page: https://npm.io/package/react-loader-overlay

## Dependencies (9)

- [react](https://npm.io/package/react.md) ^16.8.0
- [react-dom](https://npm.io/package/react-dom.md) ^16.8.0
- [web-vitals](https://npm.io/package/web-vitals.md) ^2.1.3
- [react-scripts](https://npm.io/package/react-scripts.md) 5.0.0
- [@babel/polyfill](https://npm.io/package/@babel/polyfill.md) ^7.12.1
- [babel-preset-react](https://npm.io/package/babel-preset-react.md) ^6.24.1
- [@testing-library/react](https://npm.io/package/@testing-library/react.md) ^12.1.2
- [@testing-library/jest-dom](https://npm.io/package/@testing-library/jest-dom.md) ^5.16.1
- [@testing-library/user-event](https://npm.io/package/@testing-library/user-event.md) ^13.5.0

## Alternatives

- [mobx-react](https://npm.io/package/mobx-react.md) — 2.8M weekly downloads
- [rc-tree](https://npm.io/package/rc-tree.md) — 2.6M weekly downloads
- [@react-oauth/google](https://npm.io/package/@react-oauth/google.md) — 1.3M weekly downloads
- [@wagmi/connectors](https://npm.io/package/@wagmi/connectors.md) — 877.0K weekly downloads
- [vee-validate](https://npm.io/package/vee-validate.md) — 836.4K weekly downloads

## Recent versions

- 1.0.0 (latest) — 2022-02-02
- 0.1.3 — 2022-01-19
- 0.1.2 — 2022-01-19
- 0.1.1 — 2022-01-18
- 0.1.0 — 2022-01-18

## README

# react-loader-overlay
A simple loading overlay with spinner and transitions for React applications.


## Installation
Install using `npm`

```
npm install react-loader-overlay --save
```
or

```bash
yarn add react-loader-overlay --save
```

## Usage:

1. Import `Loader` from `react-loader-overlay`

2. Use `Loader` like a React component. When the `active` prop passed to `Loader` is `true`, a translucent overlay is shown over the entire page, with a spinner in the center.


```javascript
import React, { useState } from "react";
import { Loader } from "react-loader-overlay";

function App() {
  const [loading, setLoading] = useState(false)

  return (
    <div className="App">
      <header className="App-header">
        <Loader active={loading}/>
        <p>
          Welcome! <code>React Pre Loader with Overlay</code>.
        </p>
      </header>
    </div>
  );
}

export default App;
```


## Props :hammer_and_wrench:

- `active` (boolean)
  - default: `true` - whether the loader is visible.


## Contributing

[Muhaimenul Islam](https://github.com/muhaimenul)

## Security Vulnerabilities

If you discover a security vulnerability or bugs within React Overlay Preloader, please send an e-mail to Muhaimenul Islam via [i.muhaimen@gmail.com](mailto:i.muhaimen@gmail.com).

## License

The React Overlay Preloader package is open-sourced project licensed under the [MIT license](https://opensource.org/licenses/MIT).

---
_Source: https://npm.io/package/react-loader-overlay · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._