@proyecto26/animatable-component

<animatable/>

Web Component built with Stencil.js to use Web Animations API in a declarative way. You can animate any HTML element easily:

<animatable-component
  autoplay
  easing="ease-in-out"
  duration="800"
  delay="300"
  animation="tada"
>
  <h1>Hello World</h1>
</animatable-component>

Demo

Do you want to see this web component in action? Visit https://codepen.io/jdnichollsc/full/rNNYBbe yay! 🎉

• Meet <animatable />, a tiny Web Component: https://dev.to/jdnichollsc/meet-animatable-a-tiny-web-component-to-use-web-animations-api-as-a-component-1glh

As you can see it's like Animate.css but with superpowers because you can keep the last state (opacity, transform, etc) of a previous animation before to create another one.

Properties

Property	Attribute	Description	Type	Default
animateId	animate-id	A DOMString with which to reference the animation.	string	undefined
animation	animation	Name of the animation to get the keyFrames.	"none" | "bounce" | "flash" | "jello" | "pulse" | "rotate" | "shake" | "swing" | "rubberBand" | "tada" | "wobble" | "heartBeat" | "bounceIn" | "bounceInUp" | "bounceInDown" | "bounceInRight" | "bounceInLeft" | "bounceOut" | "bounceOutUp" | "bounceOutDown" | "bounceOutRight" | "bounceOutLeft" | "fadeIn" | "fadeInUp" | "fadeInUpBig" | "fadeInDown" | "fadeInDownBig" | "fadeInRight" | "fadeInRightBig" | "fadeInLeft" | "fadeInLeftBig" | "fadeOut" | "fadeOutUp" | "fadeOutUpBig" | "fadeOutDown" | "fadeOutDownBig" | "fadeOutRight" | "fadeOutRightBig" | "fadeOutLeft" | "fadeOutLeftBig" | "flip" | "flipInX" | "flipInY" | "flipOutX" | "flipOutY" | "lightSpeedIn" | "lightSpeedOut" | "rotateIn" | "rotateInClockwise" | "rotateInDownLeft" | "rotateInDownRight" | "rotateInUpLeft" | "rotateInUpRight" | "rotateOut" | "rotateOutClockwise" | "rotateOutDownLeft" | "rotateOutDownRight" | "rotateOutUpLeft" | "rotateOutUpRight" | "slideInUp" | "slideInDown" | "slideInLeft" | "slideInRight" | "slideOutUp" | "slideOutDown" | "slideOutLeft" | "slideOutRight" | "zoomIn" | "zoomInUp" | "zoomInDown" | "zoomInLeft" | "zoomInRight" | "zoomOut" | "zoomOutUp" | "zoomOutDown" | "zoomOutLeft" | "zoomOutRight" | "hinge" | "jackInTheBox" | "rollIn" | "rollOut"	undefined
autoPlay	autoplay	Start the animation when the component is mounted.	boolean	false
composite	composite	Determines how values are combined between this animation and other, separate animations that do not specify their own specific composite operation. Defaults to replace.	"accumulate" | "add" | "replace"	undefined
currentTime	current-time	Sets the current time value of the animation in milliseconds, whether running or paused.	number	undefined
delay	delay	The number of milliseconds to delay the start of the animation. Defaults to 0.	number	undefined
direction	direction	Direction of the animation.	"alternate" | "alternate-reverse" | "normal" | "reverse"	undefined
duration	duration	The number of milliseconds each iteration of the animation takes to complete. Defaults to 0.	number	undefined
easing	easing	The rate of the animation's change over time.	custom function | "linear" | "ease" | "ease-in" | "ease-out" | "ease-in-out" | "ease-in-cubic" | "ease-out-cubic" | "ease-in-out-cubic" | "ease-in-circ" | "ease-out-circ" | "ease-in-out-circ" | "ease-in-expo" | "ease-out-expo" | "ease-in-out-expo" | "ease-in-quad" | "ease-out-quad" | "ease-in-out-quad" | "ease-in-quart" | "ease-out-quart" | "ease-in-out-quart" | "ease-in-quint" | "ease-out-quint" | "ease-in-out-quint" | "ease-in-sine" | "ease-out-sine" | "ease-in-out-sine" | "ease-in-back" | "ease-out-back" | "ease-in-out-back"	undefined
endDelay	end-delay	The number of milliseconds to delay after the end of an animation.	number	undefined
fill	fill	Dictates whether the animation's effects should be reflected by the element(s) prior to playing ("backwards"), retained after the animation has completed playing ("forwards"), or both. Defaults to "none".	"auto" | "backwards" | "both" | "forwards" | "none"	undefined
iterationComposite	iteration-composite	Determines how values build from iteration to iteration in this animation.	"accumulate" | "replace"	undefined
iterationStart	iteration-start	Describes at what point in the iteration the animation should start.	number	undefined
iterations	iterations	The number of times the animation should repeat. Defaults to 1, and can also take a value of Infinity to make it repeat for as long as the element exists.	number	undefined
keyFrames	--	Keyframes of the animation.	Keyframe[]	undefined
keyFramesData	key-frames-data	Keyframes of the animation in string format.	string	undefined
options	--	Default options of the animation.	KeyframeAnimationOptions	undefined
optionsData	options-data	Default options of the animation in string format.	string	undefined
playbackRate	playback-rate	Sets the playback rate of the animation.	number	undefined
startTime	start-time	Sets the scheduled time when an animation's playback should begin.	number	undefined

Events

Event	Description	Type
start	This event is sent when the animation is going to play.	CustomEvent<HTMLElement>
cancel	This event is sent when the animation is cancelled.	CustomEvent<HTMLElement>
finish	This event is sent when the animation finishes playing.	CustomEvent<HTMLElement>

Methods

cancel() => Promise<void>

Clears all KeyframeEffects caused by this animation and aborts its playback.

Returns

Type: Promise<void>

finish() => Promise<void>

Sets the current playback time to the end of the animation corresponding to the current playback direction.

Returns

Type: Promise<void>

getCurrentTime() => Promise<number>

Returns the current time value of the animation in milliseconds, whether running or paused.

Returns

Type: Promise<number>

getPending() => Promise<boolean>

Indicates whether the animation is currently waiting for an asynchronous operation such as initiating playback or pausing a running animation.

Returns

Type: Promise<boolean>

getPlayState() => Promise<AnimationPlayState>

Returns an enumerated value describing the playback state of an animation.

Returns

Type: Promise<AnimationPlayState>

getPlaybackRate() => Promise<number>

Returns the playback rate of the animation.

Returns

Type: Promise<number>

getStartTime() => Promise<number>

Returns the scheduled time when an animation's playback should begin.

Returns

Type: Promise<number>

pause() => Promise<void>

Suspends playback of the animation.

Returns

Type: Promise<void>

play() => Promise<void>

Starts or resumes playing of an animation.

Returns

Type: Promise<void>

reverse() => Promise<void>

Reverses the playback direction, meaning the animation ends at its beginning.

Returns

Type: Promise<void>

Using this component

Script tag

• Put a script tag similar to this <script src='https://unpkg.com/animatable-component@1.0.1/dist/animatable-component.js'></script> in the head of your index.html
• Then you can use the element anywhere in your template, JSX, html etc

Node Modules

• Run npm install @proyecto26/animatable-component --save
• Put a script tag similar to this <script src='node_modules/@proyecto26/animatable-component/dist/animatable-component.js'></script> in the head of your index.html
• Then you can use the element anywhere in your template, JSX, html etc

In a stencil-starter app

• Run npm install @proyecto26/animatable-component --save
• Add an import to the npm packages import @proyecto26/animatable-component;
• Then you can use the element anywhere in your template, JSX, html etc

Framework integrations

Angular

Using animatable-component component within an Angular project:

Including the Custom Elements Schema

Including the CUSTOM_ELEMENTS_SCHEMA in the module allows the use of Web Components in the HTML files. Here is an example of adding it to AppModule:

import { BrowserModule } from '@angular/platform-browser';
import { CUSTOM_ELEMENTS_SCHEMA, NgModule } from '@angular/core';
import { AppComponent } from './app.component';

@NgModule({
  declarations: [AppComponent],
  imports: [BrowserModule],
  bootstrap: [AppComponent],
  schemas: [CUSTOM_ELEMENTS_SCHEMA]
})
export class AppModule {}

The CUSTOM_ELEMENTS_SCHEMA needs to be included in any module that uses Animatable.

Calling defineCustomElements

Animatable component includes a function used to load itself in the application window object. That function is called defineCustomElements() and needs to be executed once during the bootstrapping of your application. One convenient place to add it is in the main.ts file as follows:

import { enableProdMode } from '@angular/core';
import { platformBrowserDynamic } from '@angular/platform-browser-dynamic';
import { defineCustomElements as defineAnimatable } from '@proyecto26/animatable-component/loader';

import { AppModule } from './app/app.module';
import { environment } from './environments/environment';

if (environment.production) {
  enableProdMode();
}

platformBrowserDynamic().bootstrapModule(AppModule)
  .catch(err => console.log(err));
defineAnimatable(window);

from stencil documentation

React

import React from 'react'
import ReactDOM from 'react-dom'
import { defineCustomElements as defineAnimatable } from '@proyecto26/animatable-component/loader'
import App from './App';

ReactDOM.render(<App />, document.getElementById('root'));

defineAnimatable(window);

from stencil documentation

Vue

In order to use the animatable-component Web Component inside of a Vue application, it should be modified to define the custom elements and to inform the Vue compiler which elements to ignore during compilation. This can all be done within the main.js file as follows:

import Vue from 'vue';
import { defineCustomElements as defineAnimatable } from '@proyecto26/animatable-component/loader'

import App from './App.vue';

Vue.config.productionTip = false;
Vue.config.ignoredElements = [/animatable-\w*/];

// Bind the custom element to the window object
defineAnimatable(window);

new Vue({
  render: h => h(App)
}).$mount('#app');

from stencil documentation

Stencil

To animate Functional Components you can use the createAnimatableComponent utility, e.g:

• utils.tsx

import {
  createAnimatableComponent
} from '@proyecto26/animatable-component';

const SendMessageButton = (props) => (
  <ion-fab-button {...props}>
    <ion-icon name='send' />
  </ion-fab-button>
);
export const AnimatableSendMessageButton = createAnimatableComponent(SendMessageButton);
export const keyFramesSendMessage: Keyframe[] = [
  {
    opacity: '0',
    transform: 'rotate(0deg)'
  },
  {
    opacity: '1',
    transform: 'rotate(360deg)'
  }
];
export const optionsSendMessage: KeyframeAnimationOptions = {
  duration: 500,
  easing: 'ease-in-out'
};

• my-component.tsx

import { Component, Host, h } from '@stencil/core';
import { AnimatableSendMessageButton, keyFramesSendMessage, optionsSendMessage } from './utils'

@Component({
  tag: 'my-component',
  shadow: false
})
export class MyComponent {
  render() {
    return (
       <AnimatableSendMessageButton
        autoPlay
        keyFrames={keyFramesSendMessage}
        options={optionsSendMessage}
        onFinish={() => alert('Eureka!')}
      />
    )
  }
}

Supporting 🍻

I believe in Unicorns 🦄 Support me, if you do too.

Security contact information 🚨

To report a security vulnerability, please use the Tidelift security contact. Tidelift will coordinate the fix and disclosure.

Happy coding 💯

Made with ❤️

Changelog

[1.0.2] - 2020-03-01

Fixed

• Fix validation loading easing option (79d9d10).