Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

victorvoid/placeload.js

Repository files navigation

placeload.js

NPM version

The best way to create a placeholder layout effect.

What is it?

Placeload.js is a library to customize your interface previews/skeleton screen that yield a fantastic user experience.

Getting started

Compiled and production-ready code can be found in the dist directory. The lib directory contains development code.

Install placeload.js with npm:

$ npm install placeload.js

Install placeload.js with bower:

$ bower install https://github.com/victorvoid/placeload.js.git

1. Include placeload on your site.

<script src="dist/placeload.min.js"></script>

2. Paint your placeholder

import Placeload from 'placeload.js'
Placeload
 .$('.user-placeload')
 .config({speed: '2s'})
 .line((element) => element.width(300).height(200))
 .fold(
 (err) => console.log('error: ', err),
 (allElements) => console.log('allElements: ', allElements)
 )

3. Placeload uses lazy evaluation, in that nothing is evaluated until necessary.

import Placeload from 'placeload.js'
const userLoader = Placeload
 .$('.user-placeload')
 .config({speed: '2s'})
 .line((element) => element.width(300).height(200))
 .config({spaceBetween: '30px'})
 .line((element) => element.width(400).height(20))
 .config({spaceBetween: '30px'})
 .line((element) => element.width(400).height(20))
 .config({spaceBetween: '30px'})
 .line((element) => element.width(250).height(20))
//running
userLoader.fold(
 err => console.log('error: ', err),
 allElements => console.log('allElements: ', allElements)
)
//Removing when data are loaded
API.getUsers()
 .then(users => {
 userLoader.remove()
 })

Placeload 0.0.1 (OLD API) πŸ™ˆ

Read the reference documentation for this version here

$ npm install placeload.js@0.0.1
 var placeUserUI = new Placeload('.user-placeload');
 placeUserUI.draw({
 width: '300px',
 height: '200px'
 });
 placeUserUI.draw({
 width: '400px',
 height: '20px',
 marginTop: '10px'
 });
 placeUserUI.draw({
 width: '400px',
 height: '20px',
 marginTop: '10px'
 });
 placeUserUI.draw({
 width: '250px',
 height: '20px',
 marginTop: '10px'
 });

Authors

The repo is written and maintained by Victor Igor. Other contributors that have submitted something, in alphabetical order:

License

The code is available under the MIT License.

About

The best way to create a placeholder layout effect using pure js. 🐨 Like Facebook, Slack, Medium, etc.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

AltStyle γ«γ‚ˆγ£γ¦ε€‰ζ›γ•γ‚ŒγŸγƒšγƒΌγ‚Έ (->γ‚ͺγƒͺγ‚ΈγƒŠγƒ«) /