https://github.com/Availity/react-block-ui

Easy way to block the user from interacting with your UI.
https://github.com/Availity/react-block-ui

availity blockui hacktoberfest javascript loading-indicator react redux ui

Last synced: about 2 months ago
JSON representation

Easy way to block the user from interacting with your UI.

• Host: GitHub
• URL: https://github.com/Availity/react-block-ui
• Owner: Availity
• License: mit
• Archived: true
• Created: 2016-09-07T00:17:30.000Z (about 8 years ago)
• Default Branch: master
• Last Pushed: 2023-02-21T18:24:06.000Z (over 1 year ago)
• Last Synced: 2024-04-15T20:50:24.548Z (5 months ago)
• Topics: availity, blockui, hacktoberfest, javascript, loading-indicator, react, redux, ui
• Language: JavaScript
• Homepage: https://availity.github.io/react-block-ui/
• Size: 2.66 MB
• Stars: 302
• Watchers: 40
• Forks: 47
• Open Issues: 11
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-star-libs - Availity / react-block-ui

README

        
> Deprecation Notice: This package is no longer supported. Please switch to [@availity/block-ui](https://www.npmjs.com/package/@availity/block-ui).

[![npm version](https://badge.fury.io/js/react-block-ui.svg)](https://badge.fury.io/js/react-block-ui) [![Build Status](https://travis-ci.org/Availity/react-block-ui.svg?branch=master)](https://travis-ci.org/Availity/react-block-ui) [![Coverage Status](https://coveralls.io/repos/github/Availity/react-block-ui/badge.svg?branch=master)](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)