chirashi-cover

Get started

API documentation, guide and more coming on chirashijs.org.

Quick view

Installation

Using npm

npm i --save chirashi-cover

Now you can import methods in your project:

import ChirashiCover from 'chirashi-cover'

const cover = new ChirashiCover({
  [
    {
      elements: '.fill',
      mode: 'fill'
    }
  ],
  auto: true
})

For advanced usage see chirashi-loader.

Standalone

You can also load chirashi-cover.js or chirashi-cover.min.js using a script tag. You'll need to load its dependencies the same way, fastdom, chirashi and chirashi-utils. It'll create an intance of ChirashiCover on your window. Then use as following example

var cover = new ChirashiCover({
  [
    {
      elements: '.fill',
      mode: 'fill'
    }
  ],
  auto: true
})