# react-load-mask

> React load mask

Latest version **3.0.2** (published 2017-02-13) · MIT license · 0 weekly downloads

## Install

```sh
npm install react-load-mask
pnpm add react-load-mask
yarn add react-load-mask
bun add react-load-mask
```

## Health

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

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 3.0.2 |
| Published | 2017-02-13 |
| First published | 2014-11-25 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | ZippyUI |
| Maintainers | zippyui |
| Keywords | load, mask, loading, loader, load-mask, mask, progress, react-component, react |

## Links

- npm: https://www.npmjs.com/package/react-load-mask
- Repository: https://github.com/zippyui/react-load-mask
- Issues: https://github.com/zippyui/react-load-mask/issues
- npm.io page: https://npm.io/package/react-load-mask

## Dependencies (2)

- [object-assign](https://npm.io/package/object-assign.md) ^4.1.0
- [react-clean-props](https://npm.io/package/react-clean-props.md) ^1.0.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

- 3.0.2 (latest) — 2017-02-13
- 3.0.1 — 2017-02-13
- 3.0.0 — 2017-01-09
- 2.0.2 — 2016-08-05
- 2.0.1 — 2016-06-16
- 2.0.0 — 2016-06-16
- 1.0.1 — 2015-03-10
- 1.0.0 — 2015-03-10
- 0.1.0 — 2014-11-25

## README

react-load-mask
===============

> A carefully crafted LoadMask for React

## Install

```sh
$ npm i react-load-mask --save
```

## Key features

 * adjustable size
 * adjustable visibility
 * easily themeable
 * css animations
 * small footprint

## Usage

```javascript 
import 'react-load-mask/index.css'
import LoadMask from 'react-load-mask'

<LoadMask visible={true} />
<LoadMask visible={true} size={20} />
<LoadMask visible={false} size={120} />
```

## Props

 * `visible` - defaults to `false`. Set to `true` if you want the `LoadMask` to be visible.
 * `size` - defaults to `40`. The size of the loader inside the `LoadMask`
 * `theme` - defaults to `"default"`. See the theming section below.

## Theming

The base css class of the component is `react-load-mask`.

For having the default theme, just import `react-load-mask/index.css`.
Basically, that uses `react-load-mask/base.css` (the functional styles) AND `react-load-mask/theme/default.css` (the default theme styles).

If you want to use/build another theme, you can render the `LoadMask` as:

```jsx
<LoadMask theme="custom" visible />
```

The code above makes the `LoadMask` component have the `react-load-mask--theme-custom` className.

## License

#### MIT

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