This package has been deprecated

Author message:

Package no longer supported. Contact Support at https://www.npmjs.com/support for more info.

Coffeekraken text-intro

Provide some cool animations to display your titles, etc... with style. They are all triggered when the element appear in viewport.

Table of content

2. Features
3. Install
4. Requirements
5. Get Started
6. [intro-activator]
7. Javascript API
8. SASS API
9. Coffeekraken

Features

1. Multiple cool animations to display your titles, etc... with style
2. Trigger the animation when element is in the viewport
3. Support for [intro-activator] feature

Install

npm install @coffeekraken/text-intro --save

Requirements

In order to make this package work with your settings, you have to add the node_modules/@coffeekraken folder in the load paths of your sass installation.

Get Started

First import the component into your javascript file like so:

import lettersInReveal from '@coffeekraken/text-intro/js/lettersInReveal'
import lettersInRain from '@coffeekraken/text-intro/js/lettersInRain'
import slideIn from '@coffeekraken/text-intro/js/slideIn'
// init listeners
lettersInReveal();
lettersInRain();
slideIn();

Then import and generate the classes using the provided mixins like so:

@use '@coffeekraken/text-intro/index' as text-intro;
@include text-intro.letters-in-reveal-classes();
@include text-intro.letters-in-rain-classes();
@include text-intro.slide-in-classes();

Then simply use it inside your html like so:

<h1 intro="letters-in-reveal">
	My cool animated title
</h1>
<h1 intro="letters-in-rain">
	My cool animated title
</h1>
<h2 intro="slide-in-up">
	My cool animated title
</h2>
<h2 intro="slide-in-down">
	My cool animated title
</h2>
<h2 intro="slide-in-left">
	My cool animated title
</h2>
<h2 intro="slide-in-right">
	My cool animated title
</h2>

[intro-activator]

You can tell you animations to be played depending on the state of one of his parent node. To do that, simply apply the intro-activator attribute on the parent you want and handle the animation state on this element directly.

You animation will be played if the intro-activator node has the .active class or the [active] attribute. This is useful for example in a slider if you want each slides to trigger the animations independently.

<!-- here's an example -->
<div intro-activator>
	<h1 intro="slide-in-up">The animation will not been played</h1>
</div>
<div intro-activator class="active">
	<h1 intro="slide-in-up">The animation will been played</h1>
</div>

Coffeekraken

We are a young collective of front-end creative developers with one goal in mind. Build tools to make every team working day life better. This is our first and only concern. All our tools are build around that purpose. All what we provide are some cool tools that you can use the way you want. These tools features cover a large scope of the front-end workflow (styleguide generation, colors/fonts management, etc...). You can use only the parts that you need and let the rest aside...