react-loading-overlay - npm Package Compare versions

Comparing version 0.1.2 to 0.1.3

package.json

 {
   "name": "react-loading-overlay",
-  "version": "0.1.2",
+  "version": "0.1.3",
   "description": "Loading overlays with fade, spinner, message support.",
@@ -5,0 +5,0 @@ "keywords": [

README.md

@@ -1,1 +0,34 @@
-# react-loading-overlay
+# Loading Overlay
+
+[![npm version](https://badge.fury.io/js/react-loading-overlay.svg)](https://badge.fury.io/js/react-loading-overlay)
+
+A customizable, simple loading overlay.
+
+![](https://d17oy1vhnax1f7.cloudfront.net/items/1f1V3g0T0u403m3U431n/Screen%20Recording%202016-10-20%20at%2002.29%20PM.gif)
+
+-------
+
+## Usage
+
+```javascript
+<LoadingOverlay
+  active={isActive}
+  spinner
+  text='Loading your content...'
+  >
+  Some components
+</LoadingOverlay>
+
+```
+
+
+### props
+
++ **active**, `Boolean`, whether the loader is visible.
++ **animate**, `Boolean`, whether to fade the overlay in and out.
++ **spinner**, `Boolean`, whether to use a spinner in the loader.
++ **text**, `String`, used as content of the loader.
++ **background**, `String`, valid css color declaration for the overlay background.
++ **color**, `String`, valid css color declaration for the text and circle color.
++ **spinnerSize**, `String`, valid css size (`100px`) for the size of the spinner circle.
++ **zIndex**, `Integer`, use in case you are experiencing other z-indexed components appearing over top of the overlay.

No alert changes

Improved metrics

Total package byte prevSize

617033

increased by0.17%

Number of lines in readme file

35

increased by1650%

No dependency changes