1.0.0 • Published 5 years ago

coffeekraken-s-sprite-transition-component v1.0.0

Weekly downloads
2
License
MIT
Repository
github
Last release
5 years ago

Coffeekraken s-sprite-transition-component

View demo

Table of content

  1. Demo
  2. Install
  3. Get Started
  4. Javascript API
  5. Demos and downloads
  6. Generate a sprite
  7. Sugar Web Components Documentation
  8. Browsers support
  9. Code linting
  10. Contribute
  11. Who are Coffeekraken?
  12. Licence

Install

npm install coffeekraken-s-sprite-transition-component --save

Get Started

First, import the component into your javascript file like so:

import ComponentName from 'coffeekraken-s-sprite-transition-component'

Then simply use it inside your html like so:

<s-sprite-transition src="urban-full-480x270@60.png" frame-width="480" still-frame="30"></s-sprite-transition>

and control your transition with javascript like so:

const $transition = document.querySelector('s-sprite-transition')
$transition.addEventListener('ready', async (e) => {
  await $transition.animateIn()
  await $transition.animateOut()
})

Demos and downloads

Here's some demos with each time the sprite to download

Urban transition

View demo

Source Download the sprite

Ink transition

View demo

Source Download the sprite

Draw transition

View demo

Download the sprite

Generate a sprite

In order to generate a sprite, you'll need to:

  1. Create your transition
  2. Export it as a png sequence
  3. Go to https://www.toptal.com/developers/css/sprite-generator/
  4. Upload your sequence. I found out that uploading more than 10 by 10 mess with the images order...
  5. Remove the padding in the option above the upload section
  6. Select Left-right in the "Align elements" option
  7. Click Download
  8. Enjoy your transition and share it with me it you want

Browsers support

IE / EdgeFirefoxChromeSafari
IE11+last 2 versionslast 2 versionslast 2 versions

As browsers are automatically updated, we will keep as reference the last two versions of each but this component can work on older ones as well.

The webcomponent API (custom elements, shadowDOM, etc...) is not supported in some older browsers like IE10, etc... In order to make them work, you will need to integrate the corresponding polyfill.

Code linting

This package uses some code linting rules. Here's the list:

  1. StandardJS for javascript files
  2. Stylelint with stylelint-config-standard for scss files

Your commits will not been accepted if the code style is not respected!

Contribute

This is an open source project and will ever be! You are more that welcomed to contribute to his development and make it more awesome every day. To do so, you have several possibilities:

  1. Share the love ❤️
  2. Declare issues
  3. Fix issues
  4. Add features
  5. Build web component

Who are Coffeekraken

We try to be some cool guys that build some cool tools to make our (and yours hopefully) every day life better.

More on who we are

License

The code is available under the MIT license. This mean that you can use, modify, or do whatever you want with it. This mean also that it is shipped to you for free, so don't be a hater and if you find some issues, etc... feel free to contribute instead of sharing your frustrations on social networks like an asshole...