forked from software-mansion/react-native-reanimated
-
Notifications
You must be signed in to change notification settings - Fork 0
/
react-native-reanimated.d.ts
1221 lines (1107 loc) · 41 KB
/
react-native-reanimated.d.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
// Project: https://github.com/software-mansion/react-native-reanimated
// TypeScript Version: 2.8
declare module 'react-native-reanimated' {
import {
ComponentClass,
ReactNode,
Component,
RefObject,
FunctionComponent,
} from 'react';
import {
ViewProps,
TextProps,
ImageProps,
ScrollViewProps,
FlatListProps,
StyleProp,
RegisteredStyle,
ViewStyle,
TextStyle,
ImageStyle,
TransformsStyle,
View as ReactNativeView,
Text as ReactNativeText,
Image as ReactNativeImage,
ScrollView as ReactNativeScrollView,
FlatList as ReactNativeFlatList,
NativeScrollEvent,
NativeSyntheticEvent,
ColorValue,
EasingFunction,
} from 'react-native';
import {
GestureHandlerGestureEvent,
PanGestureHandlerGestureEvent,
} from 'react-native-gesture-handler';
import('./lib/reanimated2/globals');
export type TimingAnimation =
import('./lib/types/lib/reanimated2/animation/index').TimingAnimation;
export type SpringAnimation =
import('./lib/types/lib/reanimated2/animation/index').SpringAnimation;
export type DecayAnimation =
import('./lib/types/lib/reanimated2/animation/index').DecayAnimation;
export type DelayAnimation =
import('./lib/types/lib/reanimated2/animation/commonTypes').DelayAnimation;
export type RepeatAnimation =
import('./lib/types/lib/reanimated2/animation/index').RepeatAnimation;
export type SequenceAnimation =
import('./lib/types/lib/reanimated2/animation/index').SequenceAnimation;
export type StyleLayoutAnimation =
import('./lib/types/lib/reanimated2/animation/index').StyleLayoutAnimation;
export type Animation<T> =
import('./lib/types/lib/reanimated2/commonTypes').Animation<T>;
namespace Animated {
type Nullable<T> = T | null | undefined;
class AnimatedNode<T> {
constructor(
nodeConfig: object,
inputNodes?: ReadonlyArray<AnimatedNode<any>>
);
isNativelyInitialized(): boolean;
/**
* ' __value' is not available at runtime on AnimatedNode<T>. It is
* necessary to have some discriminating property on a type to know that
* an AnimatedNode<number> and AnimatedNode<string> are not compatible types.
*/
' __value': T;
}
class AnimatedClock extends AnimatedNode<number> {
constructor();
}
export enum Extrapolate {
EXTEND = 'extend',
CLAMP = 'clamp',
IDENTITY = 'identity',
}
type ExtrapolateParameter =
| Extrapolate
| { extrapolateLeft?: Extrapolate; extrapolateRight?: Extrapolate };
interface InterpolationConfig {
inputRange: ReadonlyArray<Adaptable<number>>;
outputRange: ReadonlyArray<Adaptable<number | string>>;
extrapolate?: ExtrapolateParameter;
extrapolateLeft?: Extrapolate;
extrapolateRight?: Extrapolate;
}
type Value = string | number | boolean;
class AnimatedValue<T extends Value> extends AnimatedNode<T> {
constructor(value?: T);
setValue(value: Adaptable<T>): void;
interpolate(config: InterpolationConfig): AnimatedNode<number>;
}
export interface AnimationState {
finished: AnimatedValue<number>;
position: AnimatedValue<number>;
time: AnimatedValue<number>;
}
export type SharedValue<T> = { value: T };
export type DerivedValue<T> = Readonly<SharedValue<T>>;
export type Mapping = { [key: string]: Mapping } | Adaptable<any>;
export type Adaptable<T> =
| T
| AnimatedNode<T>
| ReadonlyArray<T | AnimatedNode<T> | ReadonlyArray<T | AnimatedNode<T>>>;
type BinaryOperator<T = number> = (
left: Adaptable<number>,
right: Adaptable<number>
) => AnimatedNode<T>;
type UnaryOperator = (value: Adaptable<number>) => AnimatedNode<number>;
type MultiOperator<T = number> = (
a: Adaptable<number>,
b: Adaptable<number>,
...others: Adaptable<number>[]
) => AnimatedNode<T>;
export type TransformStyleTypes = TransformsStyle['transform'] extends
| readonly (infer T)[]
| undefined
? T
: never;
export type AdaptTransforms<T> = {
[P in keyof T]: Adaptable<T[P]>;
};
export type AnimatedTransform = AdaptTransforms<TransformStyleTypes>[];
export type AnimateStyle<S> = {
[K in keyof S]: K extends 'transform'
? AnimatedTransform
: S[K] extends ReadonlyArray<any>
? ReadonlyArray<AnimateStyle<S[K][0]>>
: S[K] extends object
? AnimateStyle<S[K]>
: S[K] extends ColorValue | undefined
? S[K] | number
:
| S[K]
| AnimatedNode<
// allow `number` where `string` normally is to support colors
S[K] extends ColorValue | undefined ? S[K] | number : S[K]
>;
};
export type StylesOrDefault<T> = 'style' extends keyof T
? T['style']
: Record<string, unknown>;
export type AnimateProps<P extends object> = {
[K in keyof Omit<P, 'style'>]: P[K] | AnimatedNode<P[K]>;
} & {
style?: StyleProp<AnimateStyle<StylesOrDefault<P>>>;
} & {
animatedProps?: Partial<AnimateProps<P>>;
layout?:
| BaseAnimationBuilder
| LayoutAnimationFunction
| typeof BaseAnimationBuilder;
entering?:
| BaseAnimationBuilder
| typeof BaseAnimationBuilder
| EntryExitAnimationFunction
| Keyframe;
exiting?:
| BaseAnimationBuilder
| typeof BaseAnimationBuilder
| EntryExitAnimationFunction
| Keyframe;
};
export interface PhysicsAnimationState extends AnimationState {
velocity: AnimatedValue<number>;
}
export type DecayState = PhysicsAnimationState;
export interface DecayConfig {
deceleration: Adaptable<number>;
}
export interface BackwardCompatibleWrapper {
start: (callback?: (data: { finished: boolean }) => any) => void;
stop: () => void;
}
export interface TimingState extends AnimationState {
frameTime: AnimatedValue<number>;
}
export type EasingNodeFunction = (
value: Adaptable<number>
) => AnimatedNode<number>;
export type EasingFunction = (value: number) => number;
export interface TimingConfig {
toValue: Adaptable<number>;
duration: Adaptable<number>;
easing: EasingNodeFunction;
}
export type SpringState = PhysicsAnimationState;
export interface SpringConfig {
damping: Adaptable<number>;
mass: Adaptable<number>;
stiffness: Adaptable<number>;
overshootClamping: Adaptable<number> | boolean;
restSpeedThreshold: Adaptable<number>;
restDisplacementThreshold: Adaptable<number>;
toValue: Adaptable<number>;
}
interface SpringConfigWithOrigamiTensionAndFriction {
tension: Adaptable<number>;
mass: Adaptable<number>;
friction: Adaptable<number>;
overshootClamping: Adaptable<number> | boolean;
restSpeedThreshold: Adaptable<number>;
restDisplacementThreshold: Adaptable<number>;
toValue: Adaptable<number>;
}
interface SpringConfigWithBouncinessAndSpeed {
bounciness: Adaptable<number>;
mass: Adaptable<number>;
speed: Adaptable<number>;
overshootClamping: Adaptable<number> | boolean;
restSpeedThreshold: Adaptable<number>;
restDisplacementThreshold: Adaptable<number>;
toValue: Adaptable<number>;
}
type SpringUtils = {
makeDefaultConfig: () => SpringConfig;
makeConfigFromBouncinessAndSpeed: (
prevConfig: SpringConfigWithBouncinessAndSpeed
) => SpringConfig;
makeConfigFromOrigamiTensionAndFriction: (
prevConfig: SpringConfigWithOrigamiTensionAndFriction
) => SpringConfig;
};
export const SpringUtils: SpringUtils;
type CodeProps = {
exec?: AnimatedNode<number>;
children?: () => AnimatedNode<number>;
dependencies?: Array<any>;
};
// components
export class View extends Component<AnimateProps<ViewProps>> {
getNode(): ReactNativeView;
}
// eslint-disable-next-line @typescript-eslint/no-empty-interface
export interface View extends ReactNativeView {}
export class Text extends Component<AnimateProps<TextProps>> {
getNode(): ReactNativeText;
}
// eslint-disable-next-line @typescript-eslint/no-empty-interface
export interface Text extends ReactNativeText {}
export class Image extends Component<AnimateProps<ImageProps>> {
getNode(): ReactNativeImage;
}
// eslint-disable-next-line @typescript-eslint/no-empty-interface
export interface Image extends ReactNativeImage {}
export class ScrollView extends Component<AnimateProps<ScrollViewProps>> {
getNode(): ReactNativeScrollView;
}
// eslint-disable-next-line @typescript-eslint/no-empty-interface
export interface ScrollView extends ReactNativeScrollView {}
export class Code extends Component<CodeProps> {}
export class FlatList<T> extends Component<AnimateProps<FlatListProps<T>>> {
itemLayoutAnimation: ILayoutAnimationBuilder;
getNode(): ReactNativeFlatList;
}
// eslint-disable-next-line @typescript-eslint/no-empty-interface
export interface FlatList<T> extends ReactNativeView<T> {}
type Options<P> = {
setNativeProps: (ref: any, props: P) => void;
};
export function createAnimatedComponent<P extends object>(
component: ComponentClass<P>,
options?: Options<P>
): ComponentClass<AnimateProps<P>>;
export function createAnimatedComponent<P extends object>(
component: FunctionComponent<P>,
options?: Options<P>
): FunctionComponent<AnimateProps<P>>;
// classes
export {
AnimatedClock as Clock,
AnimatedNode as Node,
AnimatedValue as Value,
};
// base operations
export const add: MultiOperator;
export const sub: MultiOperator;
export const multiply: MultiOperator;
export const divide: MultiOperator;
export const pow: MultiOperator;
export const modulo: MultiOperator;
export const sqrt: UnaryOperator;
export const log: UnaryOperator;
export const sin: UnaryOperator;
export const cos: UnaryOperator;
export const tan: UnaryOperator;
export const acos: UnaryOperator;
export const asin: UnaryOperator;
export const atan: UnaryOperator;
export const exp: UnaryOperator;
export const round: UnaryOperator;
export const floor: UnaryOperator;
export const ceil: UnaryOperator;
export const lessThan: BinaryOperator<0 | 1>;
export const eq: BinaryOperator<0 | 1>;
export const greaterThan: BinaryOperator<0 | 1>;
export const lessOrEq: BinaryOperator<0 | 1>;
export const greaterOrEq: BinaryOperator<0 | 1>;
export const neq: BinaryOperator<0 | 1>;
export const and: MultiOperator<0 | 1>;
export const or: MultiOperator<0 | 1>;
export function proc<T extends (Adaptable<Value> | undefined)[]>(
func: (...args: T) => AnimatedNode<number>
): typeof func;
export function defined(value: Adaptable<any>): AnimatedNode<0 | 1>;
export function not(value: Adaptable<any>): AnimatedNode<0 | 1>;
export function set<T extends Value>(
valueToBeUpdated: AnimatedValue<T>,
sourceNode: Adaptable<T>
): AnimatedNode<T>;
export function concat(
...args: Array<Adaptable<string> | Adaptable<number>>
): AnimatedNode<string>;
export function cond<T1 extends Value = number, T2 extends Value = number>(
conditionNode: Adaptable<number>,
ifNode: Adaptable<T1>,
elseNode?: Adaptable<T2>
): AnimatedNode<T1 | T2>;
export function block<T1 extends Value = number, T2 extends Value = any>(
items: ReadonlyArray<Adaptable<T2>>
): AnimatedNode<T1>;
export function call<T>(
args: ReadonlyArray<T | AnimatedNode<T>>,
callback: (args: ReadonlyArray<T>) => void
): AnimatedNode<0>;
export function debug<T>(
message: string,
value: AnimatedNode<T>
): AnimatedNode<T>;
export function onChange(
value: Adaptable<number>,
action: Adaptable<number>
): AnimatedNode<number>;
export function startClock(clock: AnimatedClock): AnimatedNode<0>;
export function stopClock(clock: AnimatedClock): AnimatedNode<0>;
export function clockRunning(clock: AnimatedClock): AnimatedNode<0 | 1>;
// the return type for `event` is a lie, but it's the same lie that
// react-native makes within Animated
type EventArgFunc<T> = (arg: T) => AnimatedNode<number>;
type EventMapping<T> = T extends object
? { [K in keyof T]?: EventMapping<T[K]> | EventArgFunc<T[K]> }
: Adaptable<T> | EventArgFunc<T>;
type EventMappingArray<T> = T extends Array<any>
? { [I in keyof T]: EventMapping<T[I]> }
: [EventMapping<T>];
export function event<T>(
argMapping: T extends never
? ReadonlyArray<Mapping>
: Readonly<EventMappingArray<T>>,
config?: {}
): (...args: any[]) => void;
// derived operations
export function abs(value: Adaptable<number>): AnimatedNode<number>;
export function acc(value: Adaptable<number>): AnimatedNode<number>;
export function color(
r: Adaptable<number>,
g: Adaptable<number>,
b: Adaptable<number>,
a?: Adaptable<number>
): AnimatedNode<number | string>;
export function diff(value: Adaptable<number>): AnimatedNode<number>;
export function diffClamp(
value: Adaptable<number>,
minVal: Adaptable<number>,
maxVal: Adaptable<number>
): AnimatedNode<number>;
export function interpolateNode(
value: Adaptable<number>,
config: InterpolationConfig
): AnimatedNode<number>;
export function interpolateColors<T extends string | number>(
animationValue: Adaptable<number>,
{
inputRange,
outputColorRange,
}: {
inputRange: ReadonlyArray<Adaptable<number>>;
outputColorRange: ReadonlyArray<Adaptable<T>>;
}
): AnimatedNode<T>;
export const max: BinaryOperator;
export const min: BinaryOperator;
// animations
export function decay(
clock: AnimatedClock,
state: DecayState,
config: DecayConfig
): AnimatedNode<number>;
export function timing(
clock: AnimatedClock,
state: TimingState,
config: TimingConfig
): AnimatedNode<number>;
export function spring(
clock: AnimatedClock,
state: SpringState,
config: SpringConfig
): AnimatedNode<number>;
// backward compatible API
export function spring(
node: AnimatedNode<number>,
config: SpringConfig
): BackwardCompatibleWrapper;
export function timing(
node: AnimatedNode<number>,
config: TimingConfig
): BackwardCompatibleWrapper;
export function decay(
node: AnimatedNode<number>,
config: DecayConfig
): BackwardCompatibleWrapper;
// hooks
export function useCode(
exec: () =>
| Nullable<AnimatedNode<number>[] | AnimatedNode<number>>
| boolean,
deps: Array<any>
): void;
export function useValue<T extends Value>(
initialValue: T
): AnimatedValue<T>;
// configuration
export function addWhitelistedNativeProps(props: {
[key: string]: true;
}): void;
export function addWhitelistedUIProps(props: { [key: string]: true }): void;
}
export default Animated;
export type SharedValue<T> = Animated.SharedValue<T>;
export type AnimateStyle<S> = Animated.AnimateStyle<S>;
export type DerivedValue<T> = Animated.DerivedValue<T>;
export type Mapping = Animated.Mapping;
export type Adaptable<T> = Animated.Adaptable<T>;
export type TransformStyleTypes = Animated.TransformStyleTypes;
export type AdaptTransforms<T> = Animated.AdaptTransforms<T>;
export type AnimatedTransform = Animated.AnimatedTransform;
export type AnimateProps<P extends object> = Animated.AnimateProps<P>;
export type LayoutAnimation = {
initialValues: StyleProps;
animations: AnimateStyle;
};
export interface EntryAnimationsValues {
targetOriginX: number;
targetOriginY: number;
targetWidth: number;
targetHeight: number;
targetGlobalOriginX: number;
targetGlobalOriginY: number;
}
export enum SensorType {
ACCELEROMETER = 1,
GYROSCOPE = 2,
GRAVITY = 3,
MAGNETIC_FIELD = 4,
ROTATION = 5,
}
export type SensorConfig = {
interval: number | 'auto';
};
export type Value3D = {
x: number;
y: number;
z: number;
};
export type SensorValue3D = SharedValue<Value3D>;
export type ValueRotation = {
qw: number;
qx: number;
qy: number;
qz: number;
yaw: number;
pitch: number;
roll: number;
};
export type SensorValueRotation = SharedValue<ValueRotation>;
export type AnimatedSensor<SensorValueType> = {
sensor: SensorValueType;
unregister: () => void;
isAvailable: boolean;
config: SensorConfig;
};
export function useAnimatedSensor(
sensorType: SensorType.ROTATION,
userConfig?: SensorConfig
): AnimatedSensor<SensorValueRotation>;
export function useAnimatedSensor(
sensorType: Exclude<SensorType, SensorType.ROTATION>,
userConfig?: SensorConfig
): AnimatedSensor<SensorValue3D>;
export function useAnimatedSensor(
sensorType: SensorType,
userConfig?: SensorConfig
): AnimatedSensor<any>;
export type AnimatedKeyboardInfo = {
isShown: SharedValue<boolean>;
isAnimating: SharedValue<boolean>;
height: SharedValue<number>;
};
export function useAnimatedKeyboard(): AnimatedKeyboardInfo;
export interface ExitAnimationsValues {
currentOriginX: number;
currentOriginY: number;
currentWidth: number;
currentHeight: number;
currentGlobalOriginX: number;
currentGlobalOriginY: number;
}
export type EntryExitAnimationFunction =
| ((targetValues: EntryAnimationsValues) => LayoutAnimation)
| ((targetValues: ExitAnimationsValues) => LayoutAnimation);
export type LayoutAnimationsValues = {
currentOriginX: number;
currentOriginY: number;
currentWidth: number;
currentHeight: number;
currentGlobalOriginX: number;
currentGlobalOriginY: number;
targetOriginX: number;
targetOriginY: number;
targetWidth: number;
targetHeight: number;
targetGlobalOriginX: number;
targetGlobalOriginY: number;
windowWidth: number;
windowHeight: number;
};
export type LayoutAnimationFunction = (
targetValues: LayoutAnimationsValues
) => LayoutAnimation;
export interface ILayoutAnimationBuilder {
build: () => LayoutAnimationFunction;
}
export interface IEntryExitAnimationBuilder {
build: () => EntryExitAnimationFunction;
}
export type AnimatableValue = number | string | Array<number>;
// reanimated2 derived operations
export enum Extrapolation {
IDENTITY = 'identity',
CLAMP = 'clamp',
EXTEND = 'extend',
}
export interface InterpolatedNode {
__nodeId: number;
}
export interface ExtrapolationConfig {
extrapolateLeft?: Extrapolation | string;
extrapolateRight?: Extrapolation | string;
}
export type ExtrapolationType =
| ExtrapolationConfig
| Extrapolation
| string
| undefined;
export function interpolate(
x: number,
input: readonly number[],
output: readonly number[],
type?: ExtrapolationType
): number;
// reanimated2 animations
export type AnimationCallback = (
finished?: boolean,
current?: AnimatableValue
) => void;
export type EasingFunctionFactory = { factory: () => EasingFunction };
export interface WithTimingConfig {
duration?: number;
easing?: EasingFunction | EasingFunctionFactory;
}
export interface WithDecayConfig {
deceleration?: number;
velocity?: number;
clamp?: [number, number];
velocityFactor?: number;
rubberBandEffect?: boolean;
rubberBandFactor?: number;
}
export interface WithSpringConfig {
damping?: number;
mass?: number;
stiffness?: number;
overshootClamping?: boolean;
restSpeedThreshold?: number;
restDisplacementThreshold?: number;
velocity?: number;
}
export function withTiming<T extends AnimatableValue>(
toValue: T,
userConfig?: WithTimingConfig,
callback?: AnimationCallback
): T;
export function withSpring<T extends AnimatableValue>(
toValue: T,
userConfig?: WithSpringConfig,
callback?: AnimationCallback
): T;
export function withDecay(
userConfig: WithDecayConfig,
callback?: AnimationCallback
): number;
export function cancelAnimation<T>(sharedValue: SharedValue<T>): void;
export function withDelay<T extends AnimatableValue>(
delayMS: number,
delayedAnimation: T
): T;
export function withRepeat<T extends AnimatableValue>(
animation: T,
numberOfReps?: number,
reverse?: boolean,
callback?: AnimationCallback
): T;
export function withSequence<T extends AnimatableValue>(
...animations: [T, ...T[]]
): T;
// reanimated2 functions
export function runOnUI<A extends any[], R>(
fn: (...args: A) => R
): (...args: Parameters<typeof fn>) => void;
export function runOnJS<A extends any[], R>(
fn: (...args: A) => R
): (...args: Parameters<typeof fn>) => void;
type PropsAdapterFunction = (props: Record<string, unknown>) => void;
export function createAnimatedPropAdapter(
adapter: PropsAdapterFunction,
nativeProps?: string[]
): PropsAdapterFunction;
export function processColor(color: number | string): number;
export function interpolateColor<T extends string | number>(
value: number,
inputRange: readonly number[],
outputRange: readonly T[],
colorSpace?: 'RGB' | 'HSV'
): T;
export enum ColorSpace {
RGB = 0,
HSV = 1,
}
export interface InterpolateRGB {
r: number[];
g: number[];
b: number[];
a: number[];
}
export interface InterpolateHSV {
h: number[];
s: number[];
v: number[];
}
export interface InterpolateConfig {
inputRange: readonly number[];
outputRange: readonly (string | number)[];
colorSpace: ColorSpace;
cache: SharedValue<InterpolateRGB | InterpolateHSV | null>;
}
export function useInterpolateConfig(
inputRange: readonly number[],
outputRange: readonly (string | number)[],
colorSpace?: ColorSpace
): SharedValue<InterpolateConfig>;
export function interpolateSharableColor(
value: number,
interpolateConfig: SharedValue<InterpolateConfig>
): string | number;
export function makeMutable<T>(initialValue: T): SharedValue<T>;
type DependencyList = ReadonlyArray<any>;
// reanimated2 hooks
export function useSharedValue<T>(initialValue: T): SharedValue<T>;
export function useDerivedValue<T>(
processor: () => T,
deps?: DependencyList
): DerivedValue<T>;
export function useAnimatedReaction<D>(
prepare: () => D,
react: (prepareResult: D, preparePreviousResult: D | null) => void,
deps?: DependencyList
): void;
export type AnimatedStyleProp<T> =
| AnimateStyle<T>
| RegisteredStyle<AnimateStyle<T>>;
export function useAnimatedStyle<
T extends AnimatedStyleProp<ViewStyle | ImageStyle | TextStyle>
>(updater: () => T, deps?: DependencyList | null): T;
export function useAnimatedProps<T extends {}>(
updater: () => Partial<T>,
deps?: DependencyList | null,
adapters?: PropsAdapterFunction | PropsAdapterFunction[] | null
): Partial<T>;
export function useEvent<T extends {}>(
handler: (e: T) => void,
eventNames?: string[],
rebuild?: boolean
): (e: NativeSyntheticEvent<T>) => void;
export function useHandler<T, TContext extends Context = {}>(
handlers: Record<string, Handler<T, TContext>>,
deps?: DependencyList
): { context: TContext; doDependenciesDiffer: boolean; useWeb: boolean };
export function useAnimatedGestureHandler<
T extends GestureHandlerGestureEvent = PanGestureHandlerGestureEvent,
TContext extends Context = {}
>(
handlers: GestureHandlers<T['nativeEvent'], TContext>,
deps?: DependencyList
): OnGestureEvent<T>;
export function useAnimatedScrollHandler<TContext extends Context = {}>(
handlers: ScrollHandlers<TContext> | ScrollHandler<TContext>,
deps?: DependencyList
): OnScroll;
export function useWorkletCallback<A extends any[], R>(
fn: (...args: A) => R,
deps?: DependencyList
): (...args: Parameters<typeof fn>) => R;
export function useAnimatedRef<T extends Component>(): RefObject<T>;
export function defineAnimation<T>(starting: any, factory: () => T): number;
export function measure<T extends Component>(
ref: RefObject<T>
): {
width: number;
height: number;
x: number;
y: number;
pageX: number;
pageY: number;
};
export function getRelativeCoords(
ref: RefObject<Component>,
x: number,
y: number
): {
x: number;
y: number;
};
export function scrollTo(
ref: RefObject<ReactNativeScrollView | ScrollView>,
x: number,
y: number,
animated: boolean
): void;
// gesture-handler
type OnGestureEvent<T extends GestureHandlerGestureEvent> = (
event: T
) => void;
type Context = Record<string, unknown>;
type Handler<T, TContext extends Context> = (
event: T,
context: TContext
) => void;
export interface GestureHandlers<T, TContext extends Context> {
onStart?: Handler<T, TContext>;
onActive?: Handler<T, TContext>;
onEnd?: Handler<T, TContext>;
onFail?: Handler<T, TContext>;
onCancel?: Handler<T, TContext>;
onFinish?: (
event: T,
context: TContext,
isCanceledOrFailed: boolean
) => void;
}
// scroll view
type OnScroll = (event: NativeSyntheticEvent<NativeScrollEvent>) => void;
type ScrollHandler<TContext extends Context> = (
event: NativeScrollEvent,
context: TContext
) => void;
export interface ScrollHandlers<TContext extends Context> {
onScroll?: ScrollHandler<TContext>;
onBeginDrag?: ScrollHandler<TContext>;
onEndDrag?: ScrollHandler<TContext>;
onMomentumBegin?: ScrollHandler<TContext>;
onMomentumEnd?: ScrollHandler<TContext>;
}
export interface StyleProps extends ViewStyle, TextStyle {
originX?: number;
originY?: number;
[key: string]: any;
}
export type EasingFn = (t: number) => number;
export interface KeyframeProps extends StyleProps {
easing?: EasingFn;
[key: string]: any;
}
export class Keyframe {
constructor(definitions: Record<string, KeyframeProps>);
duration(durationMs: number): Keyframe;
delay(delayMs: number): Keyframe;
withCallback(callback: (finished: boolean) => void): Keyframe;
}
export class BaseAnimationBuilder {
static duration(durationMs: number): BaseAnimationBuilder;
duration(durationMs: number): BaseAnimationBuilder;
static delay(durationMs: number): BaseAnimationBuilder;
delay(durationMs: number): BaseAnimationBuilder;
static withCallback(
callback: (finished: boolean) => void
): BaseAnimationBuilder;
withCallback(callback: (finished: boolean) => void): BaseAnimationBuilder;
static randomDelay(): BaseAnimationBuilder;
randomDelay(): BaseAnimationBuilder;
build: () => LayoutAnimationFunction | EntryExitAnimationFunction;
}
export class ComplexAnimationBuilder extends BaseAnimationBuilder {
static duration(durationMs: number): ComplexAnimationBuilder;
duration(durationMs: number): ComplexAnimationBuilder;
static delay(durationMs: number): ComplexAnimationBuilder;
delay(durationMs: number): ComplexAnimationBuilder;
static withCallback(
callback: (finished: boolean) => void
): ComplexAnimationBuilder;
withCallback(
callback: (finished: boolean) => void
): ComplexAnimationBuilder;
static withInitialValues(values: StyleProps): BaseAnimationBuilder;
withInitialValues(values: StyleProps): BaseAnimationBuilder;
static easing(easingFunction: EasingFunction): ComplexAnimationBuilder;
easing(easingFunction: EasingFunction): ComplexAnimationBuilder;
static springify(): ComplexAnimationBuilder;
springify(): ComplexAnimationBuilder;
static damping(dampingFactor: number): ComplexAnimationBuilder;
damping(dampingFactor: number): ComplexAnimationBuilder;
static mass(mass: number): ComplexAnimationBuilder;
mass(mass: number): ComplexAnimationBuilder;
static stiffness(stiffnessFactor: number): ComplexAnimationBuilder;
stiffness(stiffnessFactor: number): ComplexAnimationBuilder;
static overshootClamping(
overshootClampingFactor: number
): ComplexAnimationBuilder;
overshootClamping(overshootClampingFactor: number): ComplexAnimationBuilder;
static restDisplacementThreshold(
restDisplacementThresholdFactor: number
): ComplexAnimationBuilder;
restDisplacementThreshold(
restDisplacementThresholdFactor: number
): ComplexAnimationBuilder;
static restSpeedThreshold(
restSpeedThresholdFactor: number
): ComplexAnimationBuilder;
restSpeedThreshold(
restSpeedThresholdFactor: number
): ComplexAnimationBuilder;
}
export class Layout extends ComplexAnimationBuilder {}
export class FadingTransition extends BaseAnimationBuilder {}
export class SequencedTransition extends BaseAnimationBuilder {
static reverse(): SequencedTransition;
reverse(): SequencedTransition;
}
export class JumpingTransition extends BaseAnimationBuilder {}
export class CurvedTransition extends BaseAnimationBuilder {
static delay(durationMs: number): CurvedTransition;
delay(durationMs: number): CurvedTransition;
static easingX(easing: EasingFn): CurvedTransition;
easingX(easing: EasingFn): CurvedTransition;
static easingY(easing: EasingFn): CurvedTransition;
easingY(easing: EasingFn): CurvedTransition;
static easingWidth(easing: EasingFn): CurvedTransition;
easingWidth(easing: EasingFn): CurvedTransition;
static easingHeight(easing: EasingFn): CurvedTransition;
easingHeight(easing: EasingFn): CurvedTransition;
}
export class EntryExitTransition extends BaseAnimationBuilder {
static delay(durationMs: number): EntryExitTransition;
delay(durationMs: number): EntryExitTransition;
static entering(
animation: BaseAnimationBuilder | typeof BaseAnimationBuilder
): EntryExitTransition;
entering(
animation: BaseAnimationBuilder | typeof BaseAnimationBuilder
): EntryExitTransition;
static exiting(
animation: BaseAnimationBuilder | typeof BaseAnimationBuilder
): EntryExitTransition;
exiting(
animation: BaseAnimationBuilder | typeof BaseAnimationBuilder
): EntryExitTransition;
}
export function combineTransition(
exiting: BaseAnimationBuilder | typeof BaseAnimationBuilder,
entering: BaseAnimationBuilder | typeof BaseAnimationBuilder
): EntryExitTransition;
export class SlideInRight extends ComplexAnimationBuilder {}
export class SlideOutRight extends ComplexAnimationBuilder {}
export class SlideInUp extends ComplexAnimationBuilder {}
export class SlideInDown extends ComplexAnimationBuilder {}
export class SlideOutUp extends ComplexAnimationBuilder {}
export class SlideOutDown extends ComplexAnimationBuilder {}
export class FadeIn extends ComplexAnimationBuilder {}
export class FadeInRight extends ComplexAnimationBuilder {}
export class FadeInLeft extends ComplexAnimationBuilder {}
export class FadeInUp extends ComplexAnimationBuilder {}
export class FadeInDown extends ComplexAnimationBuilder {}
export class FadeOut extends ComplexAnimationBuilder {}
export class FadeOutRight extends ComplexAnimationBuilder {}
export class FadeOutLeft extends ComplexAnimationBuilder {}
export class FadeOutUp extends ComplexAnimationBuilder {}