JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
    • 0
  • Score
    100M100P100Q47096F
  • License ISC

A shimmer

Package Exports

  • @ppci/custom-shimmer

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@ppci/custom-shimmer) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Shimmer

A pure CSS implementation of a shimmer effect

Table of contents

  1. Installation
  2. Usage
  3. Theme | Styling
  4. Properties
  5. Events
  6. Changelog

Installation

CDN

  <script type='module' src="https://unpkg.com/@ppci/custom-shimmer@1.0.0/index.js" />

NPM

  npm i @ppci/custom-shimmer

Usage

// Javascript import
import '@ppci/custom-shimmer'

// Or module import
<script type="module" src="https://unpkg.com/@ppci/custom-shimmer@1.0.0/index.js" />


<custom-shimmer hideAnimation="${Boolean}">
</custom-shimmer>

Theme | Styling

custom-shimmer {
  --height: 24px;
  --width: 200px;
  --animation-duration: 2s;

  /* use 50% to make a circular shimmer */
  --border-radius: 0;
}

Properties

Property Type Description Possible Values
hideAnimation Boolean Don't show subtle highlight animation ```html ```

Events

Name Description Detail / Payload

Changelog

1.0.1 | 1.0.2 | 1.0.3

  • Bundle and minify related fixes

1.0.0 ( Major )

  • Initial version of the shimmer