Skip to content
⚪ SVG-Powered component to easily create placeholder loadings (like Facebook cards loading)
TypeScript JavaScript
Branch: master
Clone or download
danilowoz Merge pull request #158 from danilowoz/docs-dependency
docs(getting started): add dependency
Latest commit c032ca7 Oct 14, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github Templates for pull requests and issues (#86) Mar 8, 2018
__mocks__ feat(codebase): react native support (#153) Sep 25, 2019
docs feat(codebase): react native support (#153) Sep 25, 2019
src fix(dependencies): move native dependencies to native module Oct 8, 2019
.eslintrc.json feat(codebase): react native support (#153) Sep 25, 2019
.gitignore feat(codebase): react native support (#153) Sep 25, 2019
.prettierrc Codebase migrations (#126) Jan 24, 2019
.travis.yml feat(codebase): react native support (#153) Sep 25, 2019
CODE_OF_CONDUCT.md Create CODE_OF_CONDUCT.md Aug 25, 2017
LICENSE add react-npm-boilerplate Jan 20, 2017
README.md docs(getting started): add dependency Oct 13, 2019
babel.web.config.js feat(codebase): react native support (#153) Sep 25, 2019
doczrc.js feat(svg): add a gradientRatio prop (#140) Mar 6, 2019
jest.native.config.js feat(codebase): react native support (#153) Sep 25, 2019
jest.web.config.js feat(codebase): react native support (#153) Sep 25, 2019
package-lock.json fix(dependency): add `react-native-svg` as dev dependency Oct 13, 2019
package.json fix(dependency): add `react-native-svg` as dev dependency Oct 13, 2019
rollup.config.js feat(codebase): react native support (#153) Sep 25, 2019
tsconfig.base.json feat(codebase): react native support (#153) Sep 25, 2019
tsconfig.json feat(codebase): react native support (#153) Sep 25, 2019
tsconfig.test.json feat(codebase): react native support (#153) Sep 25, 2019

README.md

react-content-loader

Example's react-content-loader

SVG-Powered component to easily create placeholder loadings (like Facebook's cards loading).

Features

  • ⚙️ Customizable: Feel free to change the colors, speed, sizes and even RTL;
  • 👌 Plug and play: with many presets to use, see the examples;
  • ✏️ DIY: use the create-content-loader to create your own custom loaders easily;
  • 📱 React Native support: same API, as same powerful features;
  • ⚛️ Really lightweight: less than 2kB and 0 dependencies for web version;

Index

Getting Started

npm i react-content-loader --save
yarn add react-content-loader

For React Native

npm i react-content-loader react-native-svg --save
yarn add react-content-loader react-native-svg

CDN from JSDELIVR

Usage

There are two ways to use it:

1. Presets, see the examples:

import ContentLoader, { Facebook } from 'react-content-loader'

const MyLoader = () => <ContentLoader />
const MyFacebookLoader = () => <Facebook />

2. Custom mode, see the online tool

const MyLoader = () => (
  <ContentLoader>
    {/* Only SVG shapes */}    
    <rect x="0" y="0" rx="5" ry="5" width="70" height="70" />
    <rect x="80" y="17" rx="4" ry="4" width="300" height="13" />
    <rect x="80" y="40" rx="3" ry="3" width="250" height="10" />
  </ContentLoader>
)

Still not clear? Take a look at this working example at codesandbox.io
Or try the components editable demo hands-on and install it from bit.dev

Native

react-content-loader can be used with React Native in the same way as web version with the same import:

1. Presets, see the examples:

import ContentLoader, { Facebook } from 'react-content-loader/native'

const MyLoader = () => <ContentLoader />
const MyFacebookLoader = () => <Facebook />

2. Custom mode

To create custom loaders there is an important difference: as React Native doesn't have any native module for SVG components, it's necessary to import the shapes from react-native-svg or use the named export Rect and Circle from react-content-loader import:

import ContentLoader, { Rect, Circle } from 'react-content-loader/native'

const MyLoader = () => (
  <ContentLoader>
    <Circle cx="30" cy="30" r="30" />
    <Rect x="80" y="17" rx="4" ry="4" width="300" height="13" />
    <Rect x="80" y="40" rx="3" ry="3" width="250" height="10" />
  </ContentLoader>
)

Options

animate?: boolean

Defaults to true. Opt-out of animations with false

ariaLabel? string | boolean - Web only

Defaults to Loading interface.... It's used to describe what element it is. Use false to remove.

baseUrl? string - Web only

Required if you're using <base url="/" /> document <head/>.  Defaults to an empty string. This prop is common used as: <ContentLoader baseUrl={window.location.pathname} /> which will fill the SVG attribute with the relative path. Related #93.

speed?: number

Defaults to 2. Animation speed in seconds.

interval?: number - Web only

Defaults to 0.25. Interval of time between runs of the animation, as a fraction of the animation speed.

className? string

Defaults to an empty string. The classname will be set in the <svg /> element.

width? number

Defaults to 400. It will be set in the viewbox attr in the <svg />.

height? number

Defaults to 130. It will be set in the viewbox attr in the <svg />.

gradientRatio? number - Web only

Defaults to 2. Width of the animated gradient as a fraction of the viewbox width.

rtl? boolean

Defaults to false. Content right-to-left.

preserveAspectRatio?: string

Defaults to xMidYMid meet. Aspect ratio option of <svg/>. See the available options here.

primaryColor?: string

Defaults to #f3f3f3 which is used as background of animation.

secondaryColor?: string

Defaults to #ecebeb which is used as the placeholder/layer of animation.

primaryOpacity?: string - Web only

Defaults to 1. Background opacity (0 = transparent, 1 = opaque) used to solve a issue in Safari

secondaryOpacity?: string - Web only

Defaults to 1. Animation opacity (0 = transparent, 1 = opaque) used to solve a issue in Safari

style?: React.CSSProperties

Defaults to an empty object.

uniquekey?: string - Web only

Defaults to random unique id. Use the same value of prop key, that will solve inconsistency on the SSR, see more here.

Examples

Facebook Style
import { Facebook } from 'react-content-loader'

const MyFacebookLoader = () => <Facebook />

Facebook Style

Instagram Style
import { Instagram } from 'react-content-loader'

const MyInstagramLoader = () => <Instagram />

Instagram Style

Code Style
import { Code } from 'react-content-loader'

const MyCodeLoader = () => <Code />

Code Style

List Style
import { List } from 'react-content-loader'

const MyListLoader = () => <List />

List Style

Bullet list Style
import { BulletList } from 'react-content-loader'

const MyBulletListLoader = () => <BulletList />

Bullet list Style

Custom Style

For the custom mode, use the online tool.

const MyLoader = () => (
  <ContentLoader
    height={140}
    speed={1}
    primaryColor={'#333'}
    secondaryColor={'#999'}
  >
        {/* Only SVG shapes */}
        
    <rect x="0" y="0" rx="5" ry="5" width="70" height="70" />
        
    <rect x="80" y="17" rx="4" ry="4" width="300" height="13" />
        
    <rect x="80" y="40" rx="3" ry="3" width="250" height="10" />
      
  </ContentLoader>
)

Custom

Similar packages

Development

Fork the repo then clone it

$ git clone git@github.com:YourUsername/react-content-loader.git && cd react-content-loader

$ npm i: Install the dependencies;

$ npm run build: Build to production;

$ npm run dev: Run the docz to see your changes;

$ npm run test: Run all tests: type checking, unit tests on web and native;

$ yarn test:watch: Watch unit tests;

$ yarn tsc: Typescript checking;

$ yarn tsc:watch: Typescript checking with watching;

Commit messages

Commit messages should follow the commit message convention so, changelogs could be generated automatically by that. Commit messages are validated automatically upon commit. If you aren't familiar with the commit message convention, you can use yarn commit (or npm run commit) instead of git commit, which provides an interactive CLI for generating proper commit messages.

License

MIT

Known Issues

Alpha is not working: Safari / iOS

When using rgba as a primaryColor or secondaryColor value, Safari does not respect the alpha channel, meaning that the color will be opaque. To prevent this, instead of using an rgba value for primaryColor/secondaryColor, use the rgb equivalent and move the alpha channel value to the primaryOpacity/secondaryOpacity props.

{/* Opaque color in Safari and iOS */}
<ContentLoader
  primaryColor="rgba(0,0,0,0.06)"
  secondaryColor="rgba(0,0,0,0.12)">


{/_ Semi-transparent color in Safari and iOS _/}
<ContentLoader
    primaryColor="rgb(0,0,0)"
    secondaryColor="rgb(0,0,0)"
    primaryOpacity={0.06}
    secondaryOpacity={0.12}>

Black box in Safari / iOS (again)

Using base tag on a page that contains SVG elements fails to render and it looks like a black box. Just remove the base-href tag from the <head /> and issue solved.

<img width="200" alt="Black box" src="https://user-images.githubusercontent.com/11562881/39406054-2f308de6-4bce-11e8-91fb-bbb35e29fc10.png" />

See: #93 / [109](

You can’t perform that action at this time.