Coffeekraken s-glitch-component
Create a nice glitch effect on any HTMLElement
This component make use of html2canvas and three.js
Table of content
- Demo
- Install
- Get Started
- Javascript API
- Sugar Web Components Documentation
- Browsers support
- Code linting
- Contribute
- Who are Coffeekraken?
- Licence
Install
npm install coffeekraken-s-glitch-component --save
Get Started
First, import the component into your javascript file like so:
import "@babel/polyfill"
import SGlitchComponent from "coffeekraken-s-glitch-component"
Then simply use it inside your html like so:
<s-glitch>
<h1>Hello World</h1>
<p>
Nullam suscipit risus facilisis, rhoncus massa id, bibendum metus. In urna
velit, ullamcorper vestibulum bibendum a, congue id orci. Vestibulum sed
massa turpis. Sed id felis euismod, mattis quam quis, mollis turpis. Integer
eu velit quis nisi ullamcorper ultrices. Nulla aliquet ex nisi.
</p>
<!-- etc... -->
</s-glitch>
Dom updated
When the DOM has been updated, you'll need to call the domUpdated
function to refresh the glitch canvas like so:
$glitchElm = document.querySelector("s-glitch")
$glitchElm.domUpdated()
Browsers support
IE / Edge | Firefox | Chrome | 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.
Code linting
This package uses some code linting rules. Here's the list:
- StandardJS for javascript files
-
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:
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...