Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

skeleton-elements

nolimits4web19.1kMIT4.0.1TypeScript support: included

Skeleton elements (aka UI Skeletons, Skeleton Screens, Ghost Elements) - UI for improved perceived performance

skeleton, ghost, lazy, lazy-loading, loader, placeholder, performance, vue, vuejs, react, svelte

readme

Skeleton Elements

Skeleton elements (aka UI Skeletons, Skeleton Screens, Ghost Elements) - UI for improved perceived performance

Documentation

See the documentation with examples and API documentation.

Installation

With npm:

npm i skeleton-elements --save

Styles

Skeleton Elements requires stylesheet to be included:

<link rel="stylesheet" href="path/to/skeleton-elements.css" />

With bundler (like webpack) you can import styles directly from JavaScript:

import 'skeleton-elements/css';

Or it can be included for each component separately:

  • skeleton-elements/css - All styles
  • skeleton-elements/css/core - Core styles
  • skeleton-elements/css/block - Block component
  • skeleton-elements/css/text - Text component
  • skeleton-elements/css/image - Image component
  • skeleton-elements/css/avatar - Avatar component
  • skeleton-elements/css/effects - Effects

SCSS

SCSS styles are also included:

  • skeleton-elements/scss - All styles
  • skeleton-elements/scss/core - Core styles
  • skeleton-elements/scss/block - Block component
  • skeleton-elements/scss/text - Text component
  • skeleton-elements/scss/image - Image component
  • skeleton-elements/scss/avatar - Avatar component
  • skeleton-elements/scss/effects - Effects

Usage

See the documentation for more examples and API documentation.

<style>
  .user-avatar .skeleton-block {
    width: 120px;
    height: 120px;
    border-radius: 50%;
  }
</style>
<div id="app">
  ...
  <div class="user">
    <div class="user-avatar">
      <div class="skeleton-block skeleton-effect-fade"></div>
    </div>
    <div class="user-name">
      <span class="skeleton-text skeleton-effect-fade">John Doe</span>
    </div>
  </div>
  ...
</div>

Contribution

Yes please! See the contributing guidelines for details.

Licence

This project is licensed under the terms of the MIT license.

changelog

Change Log

4.0.1 (2022-10-12)

Features

  • add direct CSS bundle export (19a6b36)

4.0.0 (2021-10-13)

  • 4.0.0 stable release

4.0.0-beta.6 (2021-10-13)

Bug Fixes

  • fix svelte helper import (a9fb761)

4.0.0-beta.3 (2021-10-13)

Bug Fixes

4.0.0-beta.1 (2021-09-30)

Features

  • move to pure ES module package (f92e71d)

3.5.0 (2021-08-23)

Features

  • svelte: add Svelte components typings (2fde2ed)
  • vue: add Vue components typings (f95ac63)

3.4.0 (2021-07-06)

Features

  • correct Svelte CJS build
  • generate font files (c822fea)
  • russian, arabic, hebrew, persian support (3f85047)

3.3.0

  • Added borderRadius prop for SkeletonImage and SkeletonAvatar (Thanks to @vltansky)
  • Fixed width: 100% styles for generated SVG images to use max-width instead (Thanks to @vltansky)
  • Build now uses dart-sass instead of node-sass (Thanks to @vltansky)

3.2.0

  • blink effect renamed to wave (blink will still work)

3.1.0

  • Added Angular package (Thanks to @vltansky)

3.0.0

  • Moved to single NPM skeleton-elements package

2.0.0

  • Vue.js components reworked for new Vue.js v3

1.0.0

  • Now font is bundled into styles using data: base64 font

0.9.0 - initial release