Skip to content

Commit 9e3baba

Browse files
committed
chore: update some type descriptions
1 parent 1f03300 commit 9e3baba

File tree

1 file changed

+7
-4
lines changed

1 file changed

+7
-4
lines changed

packages/core/src/types/animated.ts

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,10 @@ export type OnProps<T = unknown> = (
2323
spring: SpringValue<T>
2424
) => void
2525

26-
/** Called before the animation is added to the frameloop */
26+
/**
27+
* Called before the first frame of every animation.
28+
* From inside the `requestAnimationFrame` callback.
29+
*/
2730
export type OnStart<T = unknown> = (spring: SpringValue<T>) => void
2831

2932
/** Called when a `SpringValue` changes */
@@ -90,15 +93,15 @@ export type AnimationEvents<T = unknown> = {
9093
*/
9194
onProps?: EventProp<OnProps<T>>
9295
/**
93-
* Called when an animation moves for the first time
96+
* Called when an animation moves for the first time.
9497
*/
9598
onStart?: EventProp<OnStart<T>>
9699
/**
97-
* Called when all animations come to a stand-still
100+
* Called when all animations come to a stand-still.
98101
*/
99102
onRest?: EventProp<OnRest<T>>
100103
/**
101-
* Called when a key/value pair is changed
104+
* Called when a spring has its value changed.
102105
*/
103106
onChange?: EventProp<OnChange<T>>
104107
}

0 commit comments

Comments
 (0)