Updated docs page for an overview description and gave each of the functions simple descriptions

pull/16070/head
DusterFan668 3 months ago
parent 54990f2329
commit a848f9eaa9

@ -2,4 +2,6 @@
title: svelte/easing
---
This module provides a set of functions that allow you to manipulate time values in different ways. Its particularly useful for animations when combined with the `motion` module.
> MODULE: svelte/easing

@ -4,6 +4,8 @@ Distributed under MIT License https://github.com/mattdesl/eases/blob/master/LICE
*/
/**
* Returns value as is.
*
* @param {number} t
* @returns {number}
*/
@ -12,6 +14,8 @@ export function linear(t) {
}
/**
* Rebound effect on start and end of value range.
*
* @param {number} t
* @returns {number}
*/
@ -22,6 +26,8 @@ export function backInOut(t) {
}
/**
* Rebound effect on start.
*
* @param {number} t
* @returns {number}
*/
@ -31,6 +37,8 @@ export function backIn(t) {
}
/**
* Rebound effect on end.
*
* @param {number} t
* @returns {number}
*/
@ -40,6 +48,8 @@ export function backOut(t) {
}
/**
* Bounce effect on end.
*
* @param {number} t
* @returns {number}
*/
@ -61,6 +71,8 @@ export function bounceOut(t) {
}
/**
* Bounce effect on start and end.
*
* @param {number} t
* @returns {number}
*/
@ -69,6 +81,8 @@ export function bounceInOut(t) {
}
/**
* Rebound effect on start.
*
* @param {number} t
* @returns {number}
*/
@ -77,6 +91,8 @@ export function bounceIn(t) {
}
/**
* Circular effect, accelerate on start, decelerate towards end.
*
* @param {number} t
* @returns {number}
*/
@ -86,6 +102,8 @@ export function circInOut(t) {
}
/**
* Circular effect, accelerate on start.
*
* @param {number} t
* @returns {number}
*/
@ -94,6 +112,8 @@ export function circIn(t) {
}
/**
* Circular effect, decelerate towards end.
*
* @param {number} t
* @returns {number}
*/
@ -102,6 +122,8 @@ export function circOut(t) {
}
/**
* Cubic scaling, accelerate on start, decelerate towards end.
*
* @param {number} t
* @returns {number}
*/
@ -110,6 +132,8 @@ export function cubicInOut(t) {
}
/**
* Cubic scaling, accelerate on start
*
* @param {number} t
* @returns {number}
*/
@ -118,6 +142,8 @@ export function cubicIn(t) {
}
/**
* Cubic scaling, decelerate towards end.
*
* @param {number} t
* @returns {number}
*/
@ -127,6 +153,8 @@ export function cubicOut(t) {
}
/**
* Elastic effect on start and end.
*
* @param {number} t
* @returns {number}
*/
@ -140,6 +168,8 @@ export function elasticInOut(t) {
}
/**
* Elastic effect on start.
*
* @param {number} t
* @returns {number}
*/
@ -148,6 +178,8 @@ export function elasticIn(t) {
}
/**
* Elastic effect on end.
*
* @param {number} t
* @returns {number}
*/
@ -156,6 +188,8 @@ export function elasticOut(t) {
}
/**
* Exponential effect on start and end.
*
* @param {number} t
* @returns {number}
*/
@ -168,6 +202,8 @@ export function expoInOut(t) {
}
/**
* Exponential effect on start.
*
* @param {number} t
* @returns {number}
*/
@ -176,6 +212,8 @@ export function expoIn(t) {
}
/**
* Exponential effect on end.
*
* @param {number} t
* @returns {number}
*/
@ -184,6 +222,8 @@ export function expoOut(t) {
}
/**
* Quadratic scaling, accelerate on start, decelerate towards end.
*
* @param {number} t
* @returns {number}
*/
@ -195,6 +235,8 @@ export function quadInOut(t) {
}
/**
* Quadratic scaling, accelerate on start.
*
* @param {number} t
* @returns {number}
*/
@ -203,6 +245,8 @@ export function quadIn(t) {
}
/**
* Quadratic scaling, decelerate towards end.
*
* @param {number} t
* @returns {number}
*/
@ -211,6 +255,8 @@ export function quadOut(t) {
}
/**
* Quartic scaling, accelerate on start, decelerate towards end.
*
* @param {number} t
* @returns {number}
*/
@ -219,6 +265,8 @@ export function quartInOut(t) {
}
/**
* Quartic scaling, accelerate on start.
*
* @param {number} t
* @returns {number}
*/
@ -227,6 +275,8 @@ export function quartIn(t) {
}
/**
* Quartic scaling, decelerate towards end.
*
* @param {number} t
* @returns {number}
*/
@ -235,6 +285,8 @@ export function quartOut(t) {
}
/**
* Quintic scaling, accelerate on start, decelerate towards end.
*
* @param {number} t
* @returns {number}
*/
@ -244,6 +296,8 @@ export function quintInOut(t) {
}
/**
* Quintic scaling, accelerate on start.
*
* @param {number} t
* @returns {number}
*/
@ -252,6 +306,8 @@ export function quintIn(t) {
}
/**
* Quintic scaling, decelerate towards end.
*
* @param {number} t
* @returns {number}
*/
@ -260,6 +316,8 @@ export function quintOut(t) {
}
/**
* Sinusoidal effect, accelerate on start, decelerate towards end.
*
* @param {number} t
* @returns {number}
*/
@ -268,6 +326,8 @@ export function sineInOut(t) {
}
/**
* Sinusoidal effect, accelerate on start.
*
* @param {number} t
* @returns {number}
*/
@ -278,6 +338,8 @@ export function sineIn(t) {
}
/**
* Sinusoidal effect, decelerate towards end.
*
* @param {number} t
* @returns {number}
*/

Loading…
Cancel
Save