animare/lib/module/utils/helpers.js

Advanced animation library for modern JavaScript.

import Animation from'../animation.js';import{Direction,Timing}from'../types.js';export const defaultValues={from:0,duration:350,delay:0,offset:0,delayCount:1,playCount:1,direction:Direction.Forward,timing:Timing.AfterPrevious,ease:t=>t};/**
 * Returns `true` if the animation is an alternate or alternate-reverse direction
 */export function isAlternateDirection(direction){return direction===Direction.Alternate||direction===Direction.AlternateReverse;}/**
 * Returns `true` if the animation is an reverse or alternate-reverse direction
 */export function isReverseDirection(direction){return direction===Direction.Reverse||direction===Direction.AlternateReverse;}export function validateAnimationValues(animation){if(!animation.name)throw new Error('Animation `name` is required');if(typeof animation.to!=='number')throw new Error('The `to` value is required');if(typeof animation.duration==='number'&&animation.duration<0)throw new Error('The `duration` value cannot be a negative value.');if(typeof animation.delay==='number'&&animation.delay<0)throw new Error('The `delay` value cannot be a negative value.');if(typeof animation.playCount==='number'&&animation.playCount<0)throw new Error('The `playCount` value cannot be a negative value.');if(typeof animation.delayCount==='number'&&animation.delayCount<0)throw new Error('The `delayCount` value cannot be a negative value.');if(typeof animation.playCount==='number'&&typeof animation.delayCount==='number'&&animation.delayCount>animation.playCount)throw new Error('The `delayCount` value cannot be greater than the `playCount` value.');}/**
 * - Set the default values for a single animation.
 * - If a value is optional and not passed, the default value from the global values will be used, else a default value will be used.
 */export function setDefaultValues(animation,globalValues,index){// call functions with the current index
const perValue=value=>typeof value==='function'?value(index):value;const from=perValue(animation.from)??globalValues.from??defaultValues.from,duration=perValue(animation.duration)??globalValues.duration??defaultValues.duration,delay=perValue(animation.delay)??globalValues.delay??defaultValues.delay,offset=perValue(animation.offset)??globalValues.offset??defaultValues.offset,playCount=perValue(animation.playCount)??globalValues.playCount??defaultValues.playCount,delayCount=typeof delay==='number'?perValue(animation.delayCount)??globalValues.delayCount??playCount:0,direction=perValue(animation.direction)??globalValues.direction??defaultValues.direction,timing=perValue(animation.timing)??globalValues.timing??defaultValues.timing;const results={name:animation.name,to:animation.to,from,duration,delay,offset,playCount,delayCount,direction,timing,ease:animation.ease??globalValues.ease??defaultValues.ease};return results;}export function prepareAnimationsPartialOptions(newValues,index){const hasValue=value=>typeof value!=='undefined';// call functions with the current index
const perValue=value=>typeof value==='function'?value(index):value;const results={};if(hasValue(newValues.from))results.from=perValue(newValues.from);if(hasValue(newValues.duration))results.duration=perValue(newValues.duration);if(hasValue(newValues.delay))results.delay=perValue(newValues.delay);if(hasValue(newValues.offset))results.offset=perValue(newValues.offset);if(hasValue(newValues.playCount))results.playCount=perValue(newValues.playCount);if(hasValue(newValues.delayCount))results.delayCount=perValue(newValues.delayCount);if(hasValue(newValues.direction))results.direction=perValue(newValues.direction);if(hasValue(newValues.timing))results.timing=perValue(newValues.timing);if(hasValue(newValues.to))results.to=newValues.to;if(hasValue(newValues.ease))results.ease=newValues.ease;return results;}export function prepareAnimationsValues(animations,globalValues){const results=[];for(let i=0;i<animations.length;i++){const animation=animations[i];const withDefaultValues=setDefaultValues(animation,globalValues,i);// first animation always should play from the start.
if(i===0)withDefaultValues.timing=Timing.FromStart;validateAnimationValues(withDefaultValues);results.push(withDefaultValues);}return results;}export function prepareTimelineValues(options){if(options.timelinePlayCount===0){console.warn('The `timelinePlayCount` with the value `0` will make the timeline not play.');}if(typeof options.timelineSpeed==='number'&&(options.timelineSpeed===0||options.timelineSpeed<0)){throw new Error('The `timelineSpeed` value cannot be a negative value or a zero.');}return{timelinePlayCount:options.timelinePlayCount??1,autoPlay:options.autoPlay??true,timelineSpeed:options.timelineSpeed??1};}/**
 * Create `Animation` classes and return them in an array
 */export function calculateTimeline(animations){const timelines=[];for(let i=0;i<animations.length;i++){const animation=animations[i];const previousTimeline=timelines[i-1];// should not throw, because we already forced it to be `AnimationTiming.FromStart`
if(i===0&&animation.timing!==Timing.FromStart){throw new Error(`The timing value in the first animation must be "${Timing.FromStart}".`);}timelines.push(new Animation(animation,previousTimeline,i));}return timelines;}/** Returns the overall duration of the timeline */export function calculateTimelineDuration(timelines){const timelineDuration=Math.max(...timelines.map(t=>t.endPoint));return timelineDuration===Infinity?Number.MAX_SAFE_INTEGER:timelineDuration;}