Coffeekraken.io 0.0.1

Coffeekraken s-i-typed-component

Webcomponent wrapper around the freaking cool iTyped micro library to create nice typewriter effect.

Table of content

  1. Demo
  2. Install
  3. Get Started
  4. Javascript API
  5. Sugar Web Components Documentation
  6. Browsers support
  7. Contribute
  8. Who are Coffeekraken?
  9. Licence

Install

npm install coffeekraken-s-i-typed-component --save

Get Started

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

import SITypedComponent from 'coffeekraken-s-i-typed-component'

Then simply use it inside your html like so:

<s-i-typed></s-i-typed>

Browsers support

IE / Edge
IE / Edge
Firefox
Firefox
Chrome
Chrome
Safari
Safari
IE11+ last 2 versions last 2 versions last 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.

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...