React component that displays a spinner via spin.js until your component is loaded
npm install react-loaderreact-loader provides your React.js
component a simple mechanism for rendering a loading spinner (via
spin.js) while data is loading, such as an
asynchronous request to load data for a view.
> Important Note: The 2.x tagged release is compatible with React 1.4 and higher. If
> you're working with an older version of React, please use the 1.x release.
react-loader is available through both Bower and
npm via:
npm install react-loader
or:
bower install react-loader
Be sure to include the --save option to add this as a dependency in your
application's package.json or bower.json file.
Wrap the Loader component around your loading content within your React
component's render function.
``jsx
/* @jsx React.DOM /
var Loader = require('react-loader');
var MyComponent = React.createClass({
getInitialState: function () {
return { loaded: false, profile: null };
},
componentDidMount: function () {
new Profile({ id: this.props.id }).fetch({
success: this.onSuccess,
error: this.onError
})
},
onSuccess: function (profile) {
this.setState({ profile: profile, loaded: true });
},
onError: function (err) {
// error handling goes here
},
render: function () {
return (
);
}
});
`
Options can be passed to the Loader component as properties. The Loader accepts
a loaded boolean that specified whether the spinner or content should befalse
displayed, defaulting to . It also accepts a component property to"div"
specify the DOM node, defaulting to . Additionally, all options
available to spin.js are available to this component in two ways.
1. First, you can pass each option onto the loader as individual properties:
`jsx`
trail={60} shadow={false} hwaccel={false} className="spinner"
zIndex={2e9} top="50%" left="50%" scale={1.00}
loadedClassName="loadedContent" />
2. Alternatively, you can use supply an object using the options key:
`jsx
var options = {
lines: 13,
length: 20,
width: 10,
radius: 30,
scale: 1.00,
corners: 1,
color: '#000',
opacity: 0.25,
rotate: 0,
direction: 1,
speed: 1,
trail: 60,
fps: 20,
zIndex: 2e9,
top: '50%',
left: '50%',
shadow: false,
hwaccel: false,
position: 'absolute'
};
`
The loader is rendered inside a DIV element (unless otherwise specified via the
component property mentioned earlier) with class "loader". A simple solution
for rendering the spinner on the center of your screen would be to use some CSS
like the following:
`css`
.loader {
position: fixed;
top: 0;
right: 0;
bottom: 0;
left: 0;
background: white;
z-index: 9999;
}
Once the content is loaded and the spinner is removed, the DOM node is given a
class of "loadedContent" (which is customizable by specifying the
loadedClassName property).
To view the demo open demo/index.html in any browser.
To contribute:
1. Fork it
2. Create your feature branch (git checkout -b my-new-feature)lib/react-loader.jsx
3. Add your changes to the file along with associatedtest/spec/react-loader-test.js
tests under .npm run build
4. Build any JSX changes to JS (), and run tests (npm test).git commit -am 'Added some feature'
5. Commit your changes ()git push origin my-new-feature`)
6. Push to the branch (
7. Create new Pull Request
react-loader is released under the MIT License.