msb-public
/
svelte
mirror of https://github.com/sveltejs/svelte
1
0
Code Issues Projects Releases Wiki Activity

docs: Updated docs to include information on easing functions (#16070)

Browse Source 
closes #15992 

This is a minor update to the easing documents. It adds an overview
description for the module and short descriptions for each of the easing
functions.

---------

Co-authored-by: Simon H <5968653+dummdidumm@users.noreply.github.com>
Co-authored-by: vercel[bot] <35613825+vercel[bot]@users.noreply.github.com>
Co-authored-by: Simon Holthausen <simon.holthausen@vercel.com>
pull/18690/head
ChaseCopeland 1 month ago committed by GitHub
parent 63b4c3652d
commit 15720b16a5
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
3 changed files with 188 additions and 30 deletions
Show Stats Download Patch File Download Diff File

2
documentation/docs/98-reference/21-svelte-easing.md
Unescape View File

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

62
packages/svelte/src/easing/index.js
Unescape View File

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

154
packages/svelte/types/index.d.ts vendored
Unescape View File

@ -1875,66 +1875,160 @@ declare module 'svelte/compiler' {
} }
declare module 'svelte/easing' { declare module 'svelte/easing' {
/**
* Returns value as is.
*
* */
export function linear(t: number): number; export function linear(t: number): number;
/**
* Rebound effect on start and end of value range.
*
* */
export function backInOut(t: number): number; export function backInOut(t: number): number;
/**
* Rebound effect on start.
*
* */
export function backIn(t: number): number; export function backIn(t: number): number;
/**
* Rebound effect on end.
*
* */
export function backOut(t: number): number; export function backOut(t: number): number;
/**
* Bounce effect on end.
*
* */
export function bounceOut(t: number): number; export function bounceOut(t: number): number;
/**
* Bounce effect on start and end.
*
* */
export function bounceInOut(t: number): number; export function bounceInOut(t: number): number;
/**
* Bounce effect on start.
*
* */
export function bounceIn(t: number): number; export function bounceIn(t: number): number;
/**
* Circular effect, accelerate on start, decelerate towards end.
*
* */
export function circInOut(t: number): number; export function circInOut(t: number): number;
/**
* Circular effect, accelerate on start.
*
* */
export function circIn(t: number): number; export function circIn(t: number): number;
/**
* Circular effect, decelerate towards end.
*
* */
export function circOut(t: number): number; export function circOut(t: number): number;
/**
* Cubic scaling, accelerate on start, decelerate towards end.
*
* */
export function cubicInOut(t: number): number; export function cubicInOut(t: number): number;
/**
* Cubic scaling, accelerate on start
*
* */
export function cubicIn(t: number): number; export function cubicIn(t: number): number;
/**
* Cubic scaling, decelerate towards end.
*
* */
export function cubicOut(t: number): number; export function cubicOut(t: number): number;
/**
* Elastic effect on start and end.
*
* */
export function elasticInOut(t: number): number; export function elasticInOut(t: number): number;
/**
* Elastic effect on start.
*
* */
export function elasticIn(t: number): number; export function elasticIn(t: number): number;
/**
* Elastic effect on end.
*
* */
export function elasticOut(t: number): number; export function elasticOut(t: number): number;
/**
* Exponential effect on start and end.
*
* */
export function expoInOut(t: number): number; export function expoInOut(t: number): number;
/**
* Exponential effect on start.
*
* */
export function expoIn(t: number): number; export function expoIn(t: number): number;
/**
* Exponential effect on end.
*
* */
export function expoOut(t: number): number; export function expoOut(t: number): number;
/**
* Quadratic scaling, accelerate on start, decelerate towards end.
*
* */
export function quadInOut(t: number): number; export function quadInOut(t: number): number;
/**
* Quadratic scaling, accelerate on start.
*
* */
export function quadIn(t: number): number; export function quadIn(t: number): number;
/**
* Quadratic scaling, decelerate towards end.
*
* */
export function quadOut(t: number): number; export function quadOut(t: number): number;
/**
* Quartic scaling, accelerate on start, decelerate towards end.
*
* */
export function quartInOut(t: number): number; export function quartInOut(t: number): number;
/**
* Quartic scaling, accelerate on start.
*
* */
export function quartIn(t: number): number; export function quartIn(t: number): number;
/**
* Quartic scaling, decelerate towards end.
*
* */
export function quartOut(t: number): number; export function quartOut(t: number): number;
/**
* Quintic scaling, accelerate on start, decelerate towards end.
*
* */
export function quintInOut(t: number): number; export function quintInOut(t: number): number;
/**
* Quintic scaling, accelerate on start.
*
* */
export function quintIn(t: number): number; export function quintIn(t: number): number;
/**
* Quintic scaling, decelerate towards end.
*
* */
export function quintOut(t: number): number; export function quintOut(t: number): number;
/**
* Sinusoidal effect, accelerate on start, decelerate towards end.
*
* */
export function sineInOut(t: number): number; export function sineInOut(t: number): number;
/**
* Sinusoidal effect, accelerate on start.
*
* */
export function sineIn(t: number): number; export function sineIn(t: number): number;
/**
* Sinusoidal effect, decelerate towards end.
*
* */
export function sineOut(t: number): number; export function sineOut(t: number): number;
export {}; export {};

Write Preview
Loading…
Cancel
Save