react-block-ui
Version:
Block UI for react
67 lines (45 loc) • 1.9 kB
Markdown
[](https://badge.fury.io/js/react-block-ui) [](https://travis-ci.org/Availity/react-block-ui) [](https://coveralls.io/github/Availity/react-block-ui?branch=master)
# react-block-ui
Easy way to block the user from interacting with your UI.
## About
This library contains easy to use components to prevent the user from interacting with the user interface based on some conditions.
There is also a separate component which works with redux to help block and unblock automatically based on redux action types. See the ReduxBlockUi component for more details.
## Documentation
See: [https://availity.github.io/react-block-ui/](https://availity.github.io/react-block-ui/)
## Installation
Install `react-block-ui` via NPM
```sh
npm install --save react-block-ui react react-dom
```
Import the components you need, example:
```js
import BlockUi from 'react-block-ui';
import ReduxBlockUi from 'react-block-ui/redux'; // only for redux
import reduxMiddleware from 'react-block-ui/reduxMiddleware'; // only for redux
import from 'react-block-ui/style.css';
```
## Development
Install dependencies:
```sh
npm install
```
Run examples at [http://localhost:8080/](http://localhost:8080/) with webpack dev server:
```sh
npm start
```
Run tests:
```sh
npm test
```
Run tests & coverage report:
```sh
npm test:coverage
```
Watch tests:
```sh
npm run test:watch
```
## Disclaimer
Open source software components distributed or made available in the Availity Materials are licensed to Company under the terms of the applicable open source license agreements, which may be found in text files included in the Availity Materials.
## License
[MIT](./LICENSE)