ToxicJojo / SkeletonPlaceholder

A small css library to build skeleton placeholders

Skeleton Placeholder

A small CSS library to help you build skeleton placeholders. Allows you to keep using your existing layout and turn them into skeletons.

Quick Start

To get started you can include the minified css file from the CDN

<link rel='stylesheet' href='https://unpkg.com/skeleton-placeholder'>

The first thing you want to do is create a skeleton wrapper. With some bones in it.

<div class='skeleton'>
  <div class='bone bone-type-text'></div>
</div>

You can find the full documentation here

Installation

NPM

You can install the package from npm with

npm i -D skeleton-placeholder

CDN

Use our CDN to get the minified css

<link rel='stylesheet' href='https://unpkg.com/skeleton-placeholder'>

Demo

You can find a demo page with different use cases here.

Contributing

Contributions are welcome.

To get started with development clone the repo and install dependencies.

git clone https://github.com/ToxicJojo/BoneCss
cd BoneCss
npm install

To start a development sever run

npm run dev

To start the docs server

npm run docs

Both of them autoupdate the webpages on save.

License

This project is licensed under the MIT License - see the LICENSE file for details