Skip to content

Commit a848f9e

Browse files
committed
Updated docs page for an overview description and gave each of the functions simple descriptions
1 parent 54990f2 commit a848f9e

File tree

2 files changed

+64
-0
lines changed

2 files changed

+64
-0
lines changed

documentation/docs/98-reference/21-svelte-easing.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,6 @@
22
title: svelte/easing
33
---
44

5+
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.
6+
57
> MODULE: svelte/easing

packages/svelte/src/easing/index.js

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@ Distributed under MIT License https://github.com/mattdesl/eases/blob/master/LICE
44
*/
55

66
/**
7+
* Returns value as is.
8+
*
79
* @param {number} t
810
* @returns {number}
911
*/
@@ -12,6 +14,8 @@ export function linear(t) {
1214
}
1315

1416
/**
17+
* Rebound effect on start and end of value range.
18+
*
1519
* @param {number} t
1620
* @returns {number}
1721
*/
@@ -22,6 +26,8 @@ export function backInOut(t) {
2226
}
2327

2428
/**
29+
* Rebound effect on start.
30+
*
2531
* @param {number} t
2632
* @returns {number}
2733
*/
@@ -31,6 +37,8 @@ export function backIn(t) {
3137
}
3238

3339
/**
40+
* Rebound effect on end.
41+
*
3442
* @param {number} t
3543
* @returns {number}
3644
*/
@@ -40,6 +48,8 @@ export function backOut(t) {
4048
}
4149

4250
/**
51+
* Bounce effect on end.
52+
*
4353
* @param {number} t
4454
* @returns {number}
4555
*/
@@ -61,6 +71,8 @@ export function bounceOut(t) {
6171
}
6272

6373
/**
74+
* Bounce effect on start and end.
75+
*
6476
* @param {number} t
6577
* @returns {number}
6678
*/
@@ -69,6 +81,8 @@ export function bounceInOut(t) {
6981
}
7082

7183
/**
84+
* Rebound effect on start.
85+
*
7286
* @param {number} t
7387
* @returns {number}
7488
*/
@@ -77,6 +91,8 @@ export function bounceIn(t) {
7791
}
7892

7993
/**
94+
* Circular effect, accelerate on start, decelerate towards end.
95+
*
8096
* @param {number} t
8197
* @returns {number}
8298
*/
@@ -86,6 +102,8 @@ export function circInOut(t) {
86102
}
87103

88104
/**
105+
* Circular effect, accelerate on start.
106+
*
89107
* @param {number} t
90108
* @returns {number}
91109
*/
@@ -94,6 +112,8 @@ export function circIn(t) {
94112
}
95113

96114
/**
115+
* Circular effect, decelerate towards end.
116+
*
97117
* @param {number} t
98118
* @returns {number}
99119
*/
@@ -102,6 +122,8 @@ export function circOut(t) {
102122
}
103123

104124
/**
125+
* Cubic scaling, accelerate on start, decelerate towards end.
126+
*
105127
* @param {number} t
106128
* @returns {number}
107129
*/
@@ -110,6 +132,8 @@ export function cubicInOut(t) {
110132
}
111133

112134
/**
135+
* Cubic scaling, accelerate on start
136+
*
113137
* @param {number} t
114138
* @returns {number}
115139
*/
@@ -118,6 +142,8 @@ export function cubicIn(t) {
118142
}
119143

120144
/**
145+
* Cubic scaling, decelerate towards end.
146+
*
121147
* @param {number} t
122148
* @returns {number}
123149
*/
@@ -127,6 +153,8 @@ export function cubicOut(t) {
127153
}
128154

129155
/**
156+
* Elastic effect on start and end.
157+
*
130158
* @param {number} t
131159
* @returns {number}
132160
*/
@@ -140,6 +168,8 @@ export function elasticInOut(t) {
140168
}
141169

142170
/**
171+
* Elastic effect on start.
172+
*
143173
* @param {number} t
144174
* @returns {number}
145175
*/
@@ -148,6 +178,8 @@ export function elasticIn(t) {
148178
}
149179

150180
/**
181+
* Elastic effect on end.
182+
*
151183
* @param {number} t
152184
* @returns {number}
153185
*/
@@ -156,6 +188,8 @@ export function elasticOut(t) {
156188
}
157189

158190
/**
191+
* Exponential effect on start and end.
192+
*
159193
* @param {number} t
160194
* @returns {number}
161195
*/
@@ -168,6 +202,8 @@ export function expoInOut(t) {
168202
}
169203

170204
/**
205+
* Exponential effect on start.
206+
*
171207
* @param {number} t
172208
* @returns {number}
173209
*/
@@ -176,6 +212,8 @@ export function expoIn(t) {
176212
}
177213

178214
/**
215+
* Exponential effect on end.
216+
*
179217
* @param {number} t
180218
* @returns {number}
181219
*/
@@ -184,6 +222,8 @@ export function expoOut(t) {
184222
}
185223

186224
/**
225+
* Quadratic scaling, accelerate on start, decelerate towards end.
226+
*
187227
* @param {number} t
188228
* @returns {number}
189229
*/
@@ -195,6 +235,8 @@ export function quadInOut(t) {
195235
}
196236

197237
/**
238+
* Quadratic scaling, accelerate on start.
239+
*
198240
* @param {number} t
199241
* @returns {number}
200242
*/
@@ -203,6 +245,8 @@ export function quadIn(t) {
203245
}
204246

205247
/**
248+
* Quadratic scaling, decelerate towards end.
249+
*
206250
* @param {number} t
207251
* @returns {number}
208252
*/
@@ -211,6 +255,8 @@ export function quadOut(t) {
211255
}
212256

213257
/**
258+
* Quartic scaling, accelerate on start, decelerate towards end.
259+
*
214260
* @param {number} t
215261
* @returns {number}
216262
*/
@@ -219,6 +265,8 @@ export function quartInOut(t) {
219265
}
220266

221267
/**
268+
* Quartic scaling, accelerate on start.
269+
*
222270
* @param {number} t
223271
* @returns {number}
224272
*/
@@ -227,6 +275,8 @@ export function quartIn(t) {
227275
}
228276

229277
/**
278+
* Quartic scaling, decelerate towards end.
279+
*
230280
* @param {number} t
231281
* @returns {number}
232282
*/
@@ -235,6 +285,8 @@ export function quartOut(t) {
235285
}
236286

237287
/**
288+
* Quintic scaling, accelerate on start, decelerate towards end.
289+
*
238290
* @param {number} t
239291
* @returns {number}
240292
*/
@@ -244,6 +296,8 @@ export function quintInOut(t) {
244296
}
245297

246298
/**
299+
* Quintic scaling, accelerate on start.
300+
*
247301
* @param {number} t
248302
* @returns {number}
249303
*/
@@ -252,6 +306,8 @@ export function quintIn(t) {
252306
}
253307

254308
/**
309+
* Quintic scaling, decelerate towards end.
310+
*
255311
* @param {number} t
256312
* @returns {number}
257313
*/
@@ -260,6 +316,8 @@ export function quintOut(t) {
260316
}
261317

262318
/**
319+
* Sinusoidal effect, accelerate on start, decelerate towards end.
320+
*
263321
* @param {number} t
264322
* @returns {number}
265323
*/
@@ -268,6 +326,8 @@ export function sineInOut(t) {
268326
}
269327

270328
/**
329+
* Sinusoidal effect, accelerate on start.
330+
*
271331
* @param {number} t
272332
* @returns {number}
273333
*/
@@ -278,6 +338,8 @@ export function sineIn(t) {
278338
}
279339

280340
/**
341+
* Sinusoidal effect, decelerate towards end.
342+
*
281343
* @param {number} t
282344
* @returns {number}
283345
*/

0 commit comments

Comments
 (0)