A PIXI.JS wrapper plugin for MODUX
npm install @CrispCode/shimmer
Clone the shimmer repository to your machine and use the following commands:
To generate a documentation use npm run docs
If you want to check functionality you can use npm run test
In order to support older versions of browsers, you can use polyfill.io
| Name | Usage | Description |
|---|---|---|
| Button | import { Button } from 'shimmer' |
The Button class is an extension of the standard Element class |
| Element | import { Element } from 'shimmer' |
The base class for all Shimmer objects |
| Shimmer | import { Shimmer } from 'shimmer' |
The Shimmer component class, check Modux/Component for more information |
| Tween | import { Tween } from 'shimmer' |
A class used to create animation tweens in Element or Shimmer |
| Video | import { Video } from 'shimmer' |
A Video class which extends the Element class |
| Sprite | import { Sprite } from 'shimmer' |
PIXI.JS Sprite class |
| AnimatedSprite | import { AnimatedSprite } from 'shimmer' |
PIXI.JS AnimatedSprite class |
| Text | import { Text } from 'shimmer' |
PIXI.JS Text class |
| Graphics | import { Graphics } from 'shimmer' |
PIXI.JS Graphics class |
| Texture | import { Texture } from 'shimmer' |
PIXI.JS Texture class |
| BaseTexture | import { BaseTexture } from 'shimmer' |
PIXI.JS BaseTexture class |