React Content Loader

SVG-Powered component to easily create skeleton loadings.

ReactSVG
danilowoz/react-content-loaderskeletonreact.comreact-content-loader

README

react-content-loader

Example's react-content-loader


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

Features


- :gear: Customizable: Feel free to change the colors, speed, sizes, and even RTL;
- :ok_hand: Plug and play: with many presets to use, see the examples;
- :pencil2: 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
- Usage
  - Native
- Options
- Examples
- Troubleshooting
- Similar packages
- Development

Getting Started


  1. ```sh
  2. npm i react-content-loader --save
  3. ```

  1. ```sh
  2. yarn add react-content-loader
  3. ```

For React Native


  1. ```sh
  2. npm i react-content-loader react-native-svg --save
  3. ```

  1. ```sh
  2. yarn add react-content-loader react-native-svg
  3. ```

CDN from JSDELIVR

Usage


There are two ways to use it:

1. Presets, see the examples:

  1. ``` js
  2. import ContentLoader, { Facebook } from 'react-content-loader'

  4. const MyLoader = () => <ContentLoader />
  5. const MyFacebookLoader = () => <Facebook />
  6. ```

2. Custom mode, see the online tool

  1. ``` js
  2. const MyLoader = () => (
  3.   <ContentLoader viewBox="0 0 380 70">
  4.     {/* Only SVG shapes */}    
  5.     <rect x="0" y="0" rx="5" ry="5" width="70" height="70" />
  6.     <rect x="80" y="17" rx="4" ry="4" width="300" height="13" />
  7.     <rect x="80" y="40" rx="3" ry="3" width="250" height="10" />
  8.   </ContentLoader>
  9. )
  10. ```

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:

  1. ``` js
  2. import ContentLoader, { Facebook } from 'react-content-loader/native'

  4. const MyLoader = () => <ContentLoader />
  5. const MyFacebookLoader = () => <Facebook />
  6. ```

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 fromreact-content-loader import:

  1. ``` js
  2. import ContentLoader, { Rect, Circle } from 'react-content-loader/native'

  4. const MyLoader = () => (
  5.   <ContentLoader viewBox="0 0 380 70">
  6.     <Circle cx="30" cy="30" r="30" />
  7.     <Rect x="80" y="17" rx="4" ry="4" width="300" height="13" />
  8.     <Rect x="80" y="40" rx="3" ry="3" width="250" height="10" />
  9.   </ContentLoader>
  10. )
  11. ```

Options


EnvironmentDescription
---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
**`animate?:ReactOpt-out
**`title?:ReactIt's
**`baseUrl?:ReactRequired
**`speed?:ReactAnimation
**`interval?:ReactInterval
**`viewBox?:ReactUse
**`gradientRatio?:ReactWidth
**`gradientDirection?:ReactDirection
**`rtl?:ReactContent
**`backgroundColor?:ReactUsed
**`foregroundColor?:ReactUsed
**`backgroundOpacity?:ReactBackground
**`foregroundOpacity?:ReactAnimation
**`style?:React|
**`uniqueKey?:ReactUse
**`beforeMask?:ReactDefine
**`animateBegin?:ReactDelay

See all options live

Examples


Facebook Style

  1. ``` js
  2. import { Facebook } from 'react-content-loader'

  4. const MyFacebookLoader = () => <Facebook />
  5. ```

Facebook Style

Instagram Style

  1. ``` js
  2. import { Instagram } from 'react-content-loader'

  4. const MyInstagramLoader = () => <Instagram />
  5. ```

Instagram Style

Code Style

  1. ``` js
  2. import { Code } from 'react-content-loader'

  4. const MyCodeLoader = () => <Code />
  5. ```

Code Style

List Style

  1. ``` js
  2. import { List } from 'react-content-loader'

  4. const MyListLoader = () => <List />
  5. ```

List Style

Bullet list Style

  1. ``` js
  2. import { BulletList } from 'react-content-loader'

  4. const MyBulletListLoader = () => <BulletList />
  5. ```

Bullet list Style

Custom Style


For the custom mode, use the
online tool.

  1. ``` js
  2. const MyLoader = () => (
  3.   <ContentLoader
  4.     height={140}
  5.     speed={1}
  6.     backgroundColor={'#333'}
  7.     foregroundColor={'#999'}
  8.     viewBox="0 0 380 70"
  9.   >
  10.     {/* Only SVG shapes */}
  11.     <rect x="0" y="0" rx="5" ry="5" width="70" height="70" />
  12.     <rect x="80" y="17" rx="4" ry="4" width="300" height="13" />
  13.     <rect x="80" y="40" rx="3" ry="3" width="250" height="10" />
  14.   </ContentLoader>
  15. )
  16. ```

Custom

Troubleshooting


Responsive - Mobile version


In order to avoid unexpected behavior, the package doesn't have opinioned settings. So if it needs to be responsive, have in mind that the output of the package is a regular SVG, so it just needs the same attributes to become a regular SVG responsive, which means:

  1. ``` js
  2. import { Code } from 'react-content-loader'

  4. const MyCodeLoader = () => (
  5.   <Code
  6.     width={100}
  7.     height={100}
  8.     viewBox="0 0 100 100"
  9.     style={{ width: '100%' }}
  10.   />
  11. )
  12. ```

Server-side rendering (SSR) - Match snapshot


As the main component generates random values to match the id of the SVG element with background style, it can encounter unexpected errors and unmatching warning on render, once the random value of id will be generated twice, in case of SSR: server and client; or in case of snapshot test: on the first match and re-running the test.

To fix it, set the prop [uniqueKey](https://github.com/danilowoz/react-content-loader#uniquekey-string---web-only), then the id will not be random anymore:

  1. ``` js
  2. import { Facebook } from 'react-content-loader'

  4. const MyFacebookLoader = () => <Facebook uniqueKey="my-random-value" />
  5. ```

Alpha is not working: Safari / iOS


When using rgba as a backgroundColor or foregroundColor value, Safari does not respect the alpha channel, meaning that the color will be opaque. To prevent this, instead of using argba value for backgroundColor/foregroundColor, use the rgb equivalent and move the alpha channel value to the backgroundOpacity/foregroundOpacity props.

  1. ``` js
  2. {/* Opaque color in Safari and iOS */}
  3. <ContentLoader
  4.   backgroundColor="rgba(0,0,0,0.06)"
  5.   foregroundColor="rgba(0,0,0,0.12)">


  8. {/_ Semi-transparent color in Safari and iOS _/}
  9. <ContentLoader
  10.     backgroundColor="rgb(0,0,0)"
  11.     foregroundColor="rgb(0,0,0)"
  12.     backgroundOpacity={0.06}
  13.     foregroundOpacity={0.12}>


  16. ```

Black box in Safari / iOS (again)


Using the 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 `` and the issue has been solved.

black box

See: #93 / 109

Browser supports SVG-Animate


Old browsers don't support animation in SVG (compatibility list), and if your project must support IE, for examples, here's a couple of ways to make sure that browser supports SVG Animate:

- window.SVGAnimateElement
- document.implementation.hasFeature("http://www.w3.org/TR/SVG11/feature#SVG-Animation", "1.1")
- Or even use https://modernizr.com/

Similar packages


- React Native: rn-placeholder, react-native-svg-animated-linear-gradient;
- Preact;
- Vue.js: vue-content-loading, vue-content-loader;
- Angular: ngx-content-loading, ngx-content-loader.


Development


Fork the repo and then clone it

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

$ npm i: Install the dependencies;

$ npm run build: Build to production;

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

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

$ npm run test:watch: Watch unit tests;

React Native


As React Native doesn't support symbolic links (to link the dependency to another folder) and as there is no playground to check your contributions (like storybook), this is recommended strategy to run the project locally:

1. Create a new React Native from scratch, either Metro or create-react-native-app;
2. Install the dependency to your root project:
   yarn add react-content-loader react-native-svg
3. Open the project just created and clone this repository there;
4. Create your loading component and point the react-content-loader to the project just cloned, like:
   import ContentLoader, { Rect, Circle } from './react-content-loader/native'

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 (ornpm run commit) instead of git commit, which provides an interactive CLI for generating proper commit messages.

License


MIT