Create skeleton screens that automatically adapt to your app!
Switch branches/tags
Nothing to show
Clone or download
David Tang
David Tang v0.6.1
Latest commit 9b28353 Sep 1, 2018
Permalink
Failed to load latest commit information.
.storybook Use emotion Aug 31, 2018
src Use emotion Aug 31, 2018
stories Use emotion Aug 31, 2018
testSetup Use emotion Aug 31, 2018
.babelrc Upgrade webpack Aug 31, 2018
.gitignore Use emotion Aug 31, 2018
.npmignore Add basic tests Nov 1, 2017
LICENSE.md React loading skeleton Jun 20, 2017
README.md Format README Jul 15, 2018
package.json v0.6.1 Aug 31, 2018
webpack.config.js Upgrade webpack Aug 31, 2018
yarn.lock Upgrade webpack Aug 31, 2018

README.md

react-loading-skeleton

Make beautiful, animated loading skeletons that automatically adapt to your app.

Gif of skeleton in action

Basic usage

Install by npm/yarn with react-loading-skeleton.

import Skeleton from 'react-loading-skeleton';

<Skeleton/> // Simple, single-line loading skeleton
<Skeleton count={5}/> // Five-line loading skeleton

Principles

Adapts to the styles you have defined

The <Skeleton> component is designed to be used directly in your components, in place of content while it's still loading. Unlike other libraries, rather than meticulously crafting a skeleton screen to match the font-size, line-height or margins your content takes on, use a <Skeleton> component to have it automatically fill the correct dimensions.

For example:

class Blogpost extends Component {
  render() {
    return (
      <div style={{ fontSize: 20, lineHeight: 2 }}>
        <h1>{this.props.title || <Skeleton />}</h1>
        {this.props.body || <Skeleton count={10} />}
      </div>
    );
  }
}

...will produce the correctly-sized skeletons for the heading and body sections without any further configuration of the <Skeleton> component.

This ensures the loading state remains up-to-date with any changes to your layout or typography.

Don't make dedicated skeleton screens

Instead, make components with built-in skeleton states.

In addition to keeping the styling in-sync, here are some other reasons to do this:

  1. Components represent all possible states it can be in - loading included.
  2. It allows for more flexible loading patterns - in the Blogpost example, it's possible to have the title load first, and then the body, while having both pieces of content show loading skeletons at the right time.

Theming

Using a <SkeletonTheme> component, you can easily change the colors of all skeleton components below it in the React hierarchy:

import Skeleton, { SkeletonTheme } from "react-loading-skeleton";

<SkeletonTheme color="#202020" highlightColor="#444">
  <p>
    <Skeleton count={3} />
  </p>
</SkeletonTheme>;

Duration

<Skeleton duration={2} />

duration: Number, defaults to 1.2

Duration is how long it takes do one cycle of the skeleton animation.

Width

width: Number | String | null, defaults to null

<Skeleton width={100} />

Width of the skeleton. Useful when the skeleton is inside an inline element with no width of its own.