react-native-reanimated 3.6.0 → 3.6.2

package/lib/typescript/reanimated2/layoutReanimation/defaultAnimations/Slide.d.ts

@@ -1,34 +1,90 @@
 import type { EntryAnimationsValues, ExitAnimationsValues, AnimationConfigFunction, IEntryAnimationBuilder, IExitAnimationBuilder } from '../animationBuilder/commonTypes';
 import type { BaseAnimationBuilder } from '../animationBuilder';
 import { ComplexAnimationBuilder } from '../animationBuilder';
+/**
+ * Slide from right animation. You can modify the behavior by chaining methods like `.springify()` or `.duration(500)`.
+ *
+ * You pass it to the `entering` prop on [an Animated component](https://docs.swmansion.com/react-native-reanimated/docs/fundamentals/glossary#animated-component).
+ *
+ * @see https://docs.swmansion.com/react-native-reanimated/docs/layout-animations/entering-exiting-animations#slide
+ */
 export declare class SlideInRight extends ComplexAnimationBuilder implements IEntryAnimationBuilder {
     static createInstance<T extends typeof BaseAnimationBuilder>(this: T): InstanceType<T>;
     build: () => AnimationConfigFunction<EntryAnimationsValues>;
 }
+/**
+ * Slide from left animation. You can modify the behavior by chaining methods like `.springify()` or `.duration(500)`.
+ *
+ * You pass it to the `entering` prop on [an Animated component](https://docs.swmansion.com/react-native-reanimated/docs/fundamentals/glossary#animated-component).
+ *
+ * @see https://docs.swmansion.com/react-native-reanimated/docs/layout-animations/entering-exiting-animations#slide
+ */
 export declare class SlideInLeft extends ComplexAnimationBuilder implements IEntryAnimationBuilder {
     static createInstance<T extends typeof BaseAnimationBuilder>(this: T): InstanceType<T>;
     build: () => AnimationConfigFunction<EntryAnimationsValues>;
 }
+/**
+ * Slide to right animation. You can modify the behavior by chaining methods like `.springify()` or `.duration(500)`.
+ *
+ * You pass it to the `exiting` prop on [an Animated component](https://docs.swmansion.com/react-native-reanimated/docs/fundamentals/glossary#animated-component).
+ *
+ * @see https://docs.swmansion.com/react-native-reanimated/docs/layout-animations/entering-exiting-animations#slide
+ */
 export declare class SlideOutRight extends ComplexAnimationBuilder implements IExitAnimationBuilder {
     static createInstance<T extends typeof BaseAnimationBuilder>(this: T): InstanceType<T>;
     build: () => AnimationConfigFunction<ExitAnimationsValues>;
 }
+/**
+ * Slide to left animation. You can modify the behavior by chaining methods like `.springify()` or `.duration(500)`.
+ *
+ * You pass it to the `exiting` prop on [an Animated component](https://docs.swmansion.com/react-native-reanimated/docs/fundamentals/glossary#animated-component).
+ *
+ * @see https://docs.swmansion.com/react-native-reanimated/docs/layout-animations/entering-exiting-animations#slide
+ */
 export declare class SlideOutLeft extends ComplexAnimationBuilder implements IExitAnimationBuilder {
     static createInstance<T extends typeof BaseAnimationBuilder>(this: T): InstanceType<T>;
     build: () => AnimationConfigFunction<ExitAnimationsValues>;
 }
+/**
+ * Slide from top animation. You can modify the behavior by chaining methods like `.springify()` or `.duration(500)`.
+ *
+ * You pass it to the `entering` prop on [an Animated component](https://docs.swmansion.com/react-native-reanimated/docs/fundamentals/glossary#animated-component).
+ *
+ * @see https://docs.swmansion.com/react-native-reanimated/docs/layout-animations/entering-exiting-animations#slide
+ */
 export declare class SlideInUp extends ComplexAnimationBuilder implements IEntryAnimationBuilder {
     static createInstance<T extends typeof BaseAnimationBuilder>(this: T): InstanceType<T>;
     build: () => AnimationConfigFunction<EntryAnimationsValues>;
 }
+/**
+ * Slide from bottom animation. You can modify the behavior by chaining methods like `.springify()` or `.duration(500)`.
+ *
+ * You pass it to the `entering` prop on [an Animated component](https://docs.swmansion.com/react-native-reanimated/docs/fundamentals/glossary#animated-component).
+ *
+ * @see https://docs.swmansion.com/react-native-reanimated/docs/layout-animations/entering-exiting-animations#slide
+ */
 export declare class SlideInDown extends ComplexAnimationBuilder implements IEntryAnimationBuilder {
     static createInstance<T extends typeof BaseAnimationBuilder>(this: T): InstanceType<T>;
     build: () => AnimationConfigFunction<EntryAnimationsValues>;
 }
+/**
+ * Slide to top animation. You can modify the behavior by chaining methods like `.springify()` or `.duration(500)`.
+ *
+ * You pass it to the `exiting` prop on [an Animated component](https://docs.swmansion.com/react-native-reanimated/docs/fundamentals/glossary#animated-component).
+ *
+ * @see https://docs.swmansion.com/react-native-reanimated/docs/layout-animations/entering-exiting-animations#slide
+ */
 export declare class SlideOutUp extends ComplexAnimationBuilder implements IExitAnimationBuilder {
     static createInstance<T extends typeof BaseAnimationBuilder>(this: T): InstanceType<T>;
     build: () => AnimationConfigFunction<ExitAnimationsValues>;
 }
+/**
+ * Slide to bottom animation. You can modify the behavior by chaining methods like `.springify()` or `.duration(500)`.
+ *
+ * You pass it to the `exiting` prop on [an Animated component](https://docs.swmansion.com/react-native-reanimated/docs/fundamentals/glossary#animated-component).
+ *
+ * @see https://docs.swmansion.com/react-native-reanimated/docs/layout-animations/entering-exiting-animations#slide
+ */
 export declare class SlideOutDown extends ComplexAnimationBuilder implements IExitAnimationBuilder {
     static createInstance<T extends typeof BaseAnimationBuilder>(this: T): InstanceType<T>;
     build: () => AnimationConfigFunction<ExitAnimationsValues>;

package/lib/typescript/reanimated2/layoutReanimation/defaultAnimations/Stretch.d.ts

@@ -1,18 +1,46 @@
 import type { IEntryExitAnimationBuilder, EntryExitAnimationFunction } from '../animationBuilder/commonTypes';
 import type { BaseAnimationBuilder } from '../animationBuilder';
 import { ComplexAnimationBuilder } from '../animationBuilder';
+/**
+ * Stretch animation on the X axis. You can modify the behavior by chaining methods like `.springify()` or `.duration(500)`.
+ *
+ * You pass it to the `entering` prop on [an Animated component](https://docs.swmansion.com/react-native-reanimated/docs/fundamentals/glossary#animated-component).
+ *
+ * @see https://docs.swmansion.com/react-native-reanimated/docs/layout-animations/entering-exiting-animations/#stretch
+ */
 export declare class StretchInX extends ComplexAnimationBuilder implements IEntryExitAnimationBuilder {
     static createInstance<T extends typeof BaseAnimationBuilder>(this: T): InstanceType<T>;
     build: () => EntryExitAnimationFunction;
 }
+/**
+ * Stretch animation on the Y axis. You can modify the behavior by chaining methods like `.springify()` or `.duration(500)`.
+ *
+ * You pass it to the `entering` prop on [an Animated component](https://docs.swmansion.com/react-native-reanimated/docs/fundamentals/glossary#animated-component).
+ *
+ * @see https://docs.swmansion.com/react-native-reanimated/docs/layout-animations/entering-exiting-animations/#stretch
+ */
 export declare class StretchInY extends ComplexAnimationBuilder implements IEntryExitAnimationBuilder {
     static createInstance<T extends typeof BaseAnimationBuilder>(this: T): InstanceType<T>;
     build: () => EntryExitAnimationFunction;
 }
+/**
+ * Stretch animation on the X axis. You can modify the behavior by chaining methods like `.springify()` or `.duration(500)`.
+ *
+ * You pass it to the `exiting` prop on [an Animated component](https://docs.swmansion.com/react-native-reanimated/docs/fundamentals/glossary#animated-component).
+ *
+ * @see https://docs.swmansion.com/react-native-reanimated/docs/layout-animations/entering-exiting-animations/#stretch
+ */
 export declare class StretchOutX extends ComplexAnimationBuilder implements IEntryExitAnimationBuilder {
     static createInstance<T extends typeof BaseAnimationBuilder>(this: T): InstanceType<T>;
     build: () => EntryExitAnimationFunction;
 }
+/**
+ * Stretch animation on the Y axis. You can modify the behavior by chaining methods like `.springify()` or `.duration(500)`.
+ *
+ * You pass it to the `exiting` prop on [an Animated component](https://docs.swmansion.com/react-native-reanimated/docs/fundamentals/glossary#animated-component).
+ *
+ * @see https://docs.swmansion.com/react-native-reanimated/docs/layout-animations/entering-exiting-animations/#stretch
+ */
 export declare class StretchOutY extends ComplexAnimationBuilder implements IEntryExitAnimationBuilder {
     static createInstance<T extends typeof BaseAnimationBuilder>(this: T): InstanceType<T>;
     build: () => EntryExitAnimationFunction;

package/lib/typescript/reanimated2/layoutReanimation/defaultAnimations/Zoom.d.ts

@@ -1,66 +1,178 @@
 import type { IEntryExitAnimationBuilder, EntryExitAnimationFunction, EntryAnimationsValues, ExitAnimationsValues, AnimationConfigFunction, IEntryAnimationBuilder, IExitAnimationBuilder } from '../animationBuilder/commonTypes';
 import type { BaseAnimationBuilder } from '../animationBuilder';
 import { ComplexAnimationBuilder } from '../animationBuilder';
+/**
+ * Scale from center animation. You can modify the behavior by chaining methods like `.springify()` or `.duration(500)`.
+ *
+ * You pass it to the `entering` prop on [an Animated component](https://docs.swmansion.com/react-native-reanimated/docs/fundamentals/glossary#animated-component).
+ *
+ * @see https://docs.swmansion.com/react-native-reanimated/docs/layout-animations/entering-exiting-animations/#zoom
+ */
 export declare class ZoomIn extends ComplexAnimationBuilder implements IEntryExitAnimationBuilder {
     static createInstance<T extends typeof BaseAnimationBuilder>(this: T): InstanceType<T>;
     build: () => EntryExitAnimationFunction;
 }
+/**
+ * Scale from center with rotation. You can modify the behavior by chaining methods like `.springify()` or `.duration(500)`.
+ *
+ * You pass it to the `entering` prop on [an Animated component](https://docs.swmansion.com/react-native-reanimated/docs/fundamentals/glossary#animated-component).
+ *
+ * @see https://docs.swmansion.com/react-native-reanimated/docs/layout-animations/entering-exiting-animations/#zoom
+ */
 export declare class ZoomInRotate extends ComplexAnimationBuilder implements IEntryExitAnimationBuilder {
     static createInstance<T extends typeof BaseAnimationBuilder>(this: T): InstanceType<T>;
     build: () => EntryExitAnimationFunction;
 }
+/**
+ * Scale from left animation. You can modify the behavior by chaining methods like `.springify()` or `.duration(500)`.
+ *
+ * You pass it to the `entering` prop on [an Animated component](https://docs.swmansion.com/react-native-reanimated/docs/fundamentals/glossary#animated-component).
+ *
+ * @see https://docs.swmansion.com/react-native-reanimated/docs/layout-animations/entering-exiting-animations/#zoom
+ */
 export declare class ZoomInLeft extends ComplexAnimationBuilder implements IEntryExitAnimationBuilder {
     static createInstance<T extends typeof BaseAnimationBuilder>(this: T): InstanceType<T>;
     build: () => EntryExitAnimationFunction;
 }
+/**
+ * Scale from right animation. You can modify the behavior by chaining methods like `.springify()` or `.duration(500)`.
+ *
+ * You pass it to the `entering` prop on [an Animated component](https://docs.swmansion.com/react-native-reanimated/docs/fundamentals/glossary#animated-component).
+ *
+ * @see https://docs.swmansion.com/react-native-reanimated/docs/layout-animations/entering-exiting-animations/#zoom
+ */
 export declare class ZoomInRight extends ComplexAnimationBuilder implements IEntryExitAnimationBuilder {
     static createInstance<T extends typeof BaseAnimationBuilder>(this: T): InstanceType<T>;
     build: () => EntryExitAnimationFunction;
 }
+/**
+ * Scale from top animation. You can modify the behavior by chaining methods like `.springify()` or `.duration(500)`.
+ *
+ * You pass it to the `entering` prop on [an Animated component](https://docs.swmansion.com/react-native-reanimated/docs/fundamentals/glossary#animated-component).
+ *
+ * @see https://docs.swmansion.com/react-native-reanimated/docs/layout-animations/entering-exiting-animations/#zoom
+ */
 export declare class ZoomInUp extends ComplexAnimationBuilder implements IEntryExitAnimationBuilder {
     static createInstance<T extends typeof BaseAnimationBuilder>(this: T): InstanceType<T>;
     build: () => EntryExitAnimationFunction;
 }
+/**
+ * Scale from bottom animation. You can modify the behavior by chaining methods like `.springify()` or `.duration(500)`.
+ *
+ * You pass it to the `entering` prop on [an Animated component](https://docs.swmansion.com/react-native-reanimated/docs/fundamentals/glossary#animated-component).
+ *
+ * @see https://docs.swmansion.com/react-native-reanimated/docs/layout-animations/entering-exiting-animations/#zoom
+ */
 export declare class ZoomInDown extends ComplexAnimationBuilder implements IEntryExitAnimationBuilder {
     static createInstance<T extends typeof BaseAnimationBuilder>(this: T): InstanceType<T>;
     build: () => EntryExitAnimationFunction;
 }
+/**
+ * Eased scale from top animation. You can modify the behavior by chaining methods like `.springify()` or `.duration(500)`.
+ *
+ * You pass it to the `entering` prop on [an Animated component](https://docs.swmansion.com/react-native-reanimated/docs/fundamentals/glossary#animated-component).
+ *
+ * @see https://docs.swmansion.com/react-native-reanimated/docs/layout-animations/entering-exiting-animations/#zoom
+ */
 export declare class ZoomInEasyUp extends ComplexAnimationBuilder implements IEntryAnimationBuilder {
     static createInstance<T extends typeof BaseAnimationBuilder>(this: T): InstanceType<T>;
     build: () => AnimationConfigFunction<EntryAnimationsValues>;
 }
+/**
+ * Eased scale from bottom animation. You can modify the behavior by chaining methods like `.springify()` or `.duration(500)`.
+ *
+ * You pass it to the `entering` prop on [an Animated component](https://docs.swmansion.com/react-native-reanimated/docs/fundamentals/glossary#animated-component).
+ *
+ * @see https://docs.swmansion.com/react-native-reanimated/docs/layout-animations/entering-exiting-animations/#zoom
+ */
 export declare class ZoomInEasyDown extends ComplexAnimationBuilder implements IEntryAnimationBuilder {
     static createInstance<T extends typeof BaseAnimationBuilder>(this: T): InstanceType<T>;
     build: () => AnimationConfigFunction<EntryAnimationsValues>;
 }
+/**
+ * Scale to center animation. You can modify the behavior by chaining methods like `.springify()` or `.duration(500)`.
+ *
+ * You pass it to the `exiting` prop on [an Animated component](https://docs.swmansion.com/react-native-reanimated/docs/fundamentals/glossary#animated-component).
+ *
+ * @see https://docs.swmansion.com/react-native-reanimated/docs/layout-animations/entering-exiting-animations/#zoom
+ */
 export declare class ZoomOut extends ComplexAnimationBuilder implements IEntryExitAnimationBuilder {
     static createInstance<T extends typeof BaseAnimationBuilder>(this: T): InstanceType<T>;
     build: () => EntryExitAnimationFunction;
 }
+/**
+ * Scale to center with rotation. You can modify the behavior by chaining methods like `.springify()` or `.duration(500)`.
+ *
+ * You pass it to the `exiting` prop on [an Animated component](https://docs.swmansion.com/react-native-reanimated/docs/fundamentals/glossary#animated-component).
+ *
+ * @see https://docs.swmansion.com/react-native-reanimated/docs/layout-animations/entering-exiting-animations/#zoom
+ */
 export declare class ZoomOutRotate extends ComplexAnimationBuilder implements IEntryExitAnimationBuilder {
     static createInstance<T extends typeof BaseAnimationBuilder>(this: T): InstanceType<T>;
     build: () => EntryExitAnimationFunction;
 }
+/**
+ * Scale to left animation. You can modify the behavior by chaining methods like `.springify()` or `.duration(500)`.
+ *
+ * You pass it to the `exiting` prop on [an Animated component](https://docs.swmansion.com/react-native-reanimated/docs/fundamentals/glossary#animated-component).
+ *
+ * @see https://docs.swmansion.com/react-native-reanimated/docs/layout-animations/entering-exiting-animations/#zoom
+ */
 export declare class ZoomOutLeft extends ComplexAnimationBuilder implements IEntryExitAnimationBuilder {
     static createInstance<T extends typeof BaseAnimationBuilder>(this: T): InstanceType<T>;
     build: () => EntryExitAnimationFunction;
 }
+/**
+ * Scale to right animation. You can modify the behavior by chaining methods like `.springify()` or `.duration(500)`.
+ *
+ * You pass it to the `exiting` prop on [an Animated component](https://docs.swmansion.com/react-native-reanimated/docs/fundamentals/glossary#animated-component).
+ *
+ * @see https://docs.swmansion.com/react-native-reanimated/docs/layout-animations/entering-exiting-animations/#zoom
+ */
 export declare class ZoomOutRight extends ComplexAnimationBuilder implements IEntryExitAnimationBuilder {
     static createInstance<T extends typeof BaseAnimationBuilder>(this: T): InstanceType<T>;
     build: () => EntryExitAnimationFunction;
 }
+/**
+ * Scale to top animation. You can modify the behavior by chaining methods like `.springify()` or `.duration(500)`.
+ *
+ * You pass it to the `exiting` prop on [an Animated component](https://docs.swmansion.com/react-native-reanimated/docs/fundamentals/glossary#animated-component).
+ *
+ * @see https://docs.swmansion.com/react-native-reanimated/docs/layout-animations/entering-exiting-animations/#zoom
+ */
 export declare class ZoomOutUp extends ComplexAnimationBuilder implements IEntryExitAnimationBuilder {
     static createInstance<T extends typeof BaseAnimationBuilder>(this: T): InstanceType<T>;
     build: () => EntryExitAnimationFunction;
 }
+/**
+ * Scale to bottom animation. You can modify the behavior by chaining methods like `.springify()` or `.duration(500)`.
+ *
+ * You pass it to the `exiting` prop on [an Animated component](https://docs.swmansion.com/react-native-reanimated/docs/fundamentals/glossary#animated-component).
+ *
+ * @see https://docs.swmansion.com/react-native-reanimated/docs/layout-animations/entering-exiting-animations/#zoom
+ */
 export declare class ZoomOutDown extends ComplexAnimationBuilder implements IEntryExitAnimationBuilder {
     static createInstance<T extends typeof BaseAnimationBuilder>(this: T): InstanceType<T>;
     build: () => EntryExitAnimationFunction;
 }
+/**
+ * Eased scale to top animation. You can modify the behavior by chaining methods like `.springify()` or `.duration(500)`.
+ *
+ * You pass it to the `exiting` prop on [an Animated component](https://docs.swmansion.com/react-native-reanimated/docs/fundamentals/glossary#animated-component).
+ *
+ * @see https://docs.swmansion.com/react-native-reanimated/docs/layout-animations/entering-exiting-animations/#zoom
+ */
 export declare class ZoomOutEasyUp extends ComplexAnimationBuilder implements IExitAnimationBuilder {
     static createInstance<T extends typeof BaseAnimationBuilder>(this: T): InstanceType<T>;
     build: () => AnimationConfigFunction<ExitAnimationsValues>;
 }
+/**
+ * Eased scale to bottom animation. You can modify the behavior by chaining methods like `.springify()` or `.duration(500)`.
+ *
+ * You pass it to the `exiting` prop on [an Animated component](https://docs.swmansion.com/react-native-reanimated/docs/fundamentals/glossary#animated-component).
+ *
+ * @see https://docs.swmansion.com/react-native-reanimated/docs/layout-animations/entering-exiting-animations/#zoom
+ */
 export declare class ZoomOutEasyDown extends ComplexAnimationBuilder implements IExitAnimationBuilder {
     static createInstance<T extends typeof BaseAnimationBuilder>(this: T): InstanceType<T>;
     build: () => AnimationConfigFunction<ExitAnimationsValues>;

package/lib/typescript/reanimated2/layoutReanimation/defaultTransitions/CurvedTransition.d.ts

@@ -1,6 +1,13 @@
 import type { ILayoutAnimationBuilder, LayoutAnimationFunction } from '../animationBuilder/commonTypes';
 import { BaseAnimationBuilder } from '../animationBuilder';
 import type { EasingFunction } from '../../Easing';
+/**
+ * Layout transitions with a curved animation. You can modify the behavior by chaining methods like `.duration(500)` or `.delay(500)`.
+ *
+ * You pass it to the `layout` prop on [an Animated component](https://docs.swmansion.com/react-native-reanimated/docs/fundamentals/glossary#animated-component).
+ *
+ * @see https://docs.swmansion.com/react-native-reanimated/docs/layout-animations/layout-transitions#fading-transition
+ */
 export declare class CurvedTransition extends BaseAnimationBuilder implements ILayoutAnimationBuilder {
     easingXV: EasingFunction;
     easingYV: EasingFunction;

package/lib/typescript/reanimated2/layoutReanimation/defaultTransitions/EntryExitTransition.d.ts

@@ -10,4 +10,12 @@ export declare class EntryExitTransition extends BaseAnimationBuilder implements
     exiting(animation: BaseAnimationBuilder | typeof BaseAnimationBuilder): EntryExitTransition;
     build: () => LayoutAnimationFunction;
 }
+/**
+ * Lets you combine two layout animations into a layout transition. You can modify the behavior by chaining methods like `.delay(500)`.
+ *
+ * @param exiting - Layout animation used when components are removed from layout (eg. `FadeOut`).
+ * @param entering - Layout animation used when components are added to layout (eg. `FadeIn`).
+ * @returns A custom layout transition. You pass it to the `layout` prop on [an Animated component](https://docs.swmansion.com/react-native-reanimated/docs/fundamentals/glossary#animated-component).
+ * @see https://docs.swmansion.com/react-native-reanimated/docs/layout-animations/layout-transitions#combine-transition
+ */
 export declare function combineTransition(exiting: BaseAnimationBuilder | typeof BaseAnimationBuilder, entering: BaseAnimationBuilder | typeof BaseAnimationBuilder): EntryExitTransition;

package/lib/typescript/reanimated2/layoutReanimation/defaultTransitions/FadingTransition.d.ts

@@ -1,5 +1,12 @@
 import type { ILayoutAnimationBuilder, LayoutAnimationFunction } from '../animationBuilder/commonTypes';
 import { BaseAnimationBuilder } from '../animationBuilder';
+/**
+ * Fades out components from one position and shows them in another. You can modify the behavior by chaining methods like `.duration(500)` or `.delay(500)`.
+ *
+ * You pass it to the `layout` prop on [an Animated component](https://docs.swmansion.com/react-native-reanimated/docs/fundamentals/glossary#animated-component).
+ *
+ * @see https://docs.swmansion.com/react-native-reanimated/docs/layout-animations/layout-transitions#fading-transition
+ */
 export declare class FadingTransition extends BaseAnimationBuilder implements ILayoutAnimationBuilder {
     static createInstance<T extends typeof BaseAnimationBuilder>(this: T): InstanceType<T>;
     build: () => LayoutAnimationFunction;

package/lib/typescript/reanimated2/layoutReanimation/defaultTransitions/JumpingTransition.d.ts

@@ -1,5 +1,12 @@
 import type { ILayoutAnimationBuilder, LayoutAnimationFunction } from '../animationBuilder/commonTypes';
 import { BaseAnimationBuilder } from '../animationBuilder';
+/**
+ * Layout jumps - quite literally - from one position to another. You can modify the behavior by chaining methods like `.springify()` or `.duration(500)`.
+ *
+ * You pass it to the `layout` prop on [an Animated component](https://docs.swmansion.com/react-native-reanimated/docs/fundamentals/glossary#animated-component).
+ *
+ * @see https://docs.swmansion.com/react-native-reanimated/docs/layout-animations/layout-transitions#jumping-transition
+ */
 export declare class JumpingTransition extends BaseAnimationBuilder implements ILayoutAnimationBuilder {
     static createInstance<T extends typeof BaseAnimationBuilder>(this: T): InstanceType<T>;
     build: () => LayoutAnimationFunction;

package/lib/typescript/reanimated2/layoutReanimation/defaultTransitions/LinearTransition.d.ts

@@ -1,8 +1,18 @@
 import type { BaseAnimationBuilder } from '../animationBuilder';
 import { ComplexAnimationBuilder } from '../animationBuilder';
 import type { ILayoutAnimationBuilder, LayoutAnimationFunction } from '../animationBuilder/commonTypes';
+/**
+ * Linearly transforms the layout from one position to another. You can modify the behavior by chaining methods like `.springify()` or `.duration(500)`.
+ *
+ * You pass it to the `layout` prop on [an Animated component](https://docs.swmansion.com/react-native-reanimated/docs/fundamentals/glossary#animated-component).
+ *
+ * @see https://docs.swmansion.com/react-native-reanimated/docs/layout-animations/layout-transitions#linear-transition
+ */
 export declare class LinearTransition extends ComplexAnimationBuilder implements ILayoutAnimationBuilder {
     static createInstance<T extends typeof BaseAnimationBuilder>(this: T): InstanceType<T>;
     build: () => LayoutAnimationFunction;
 }
+/**
+ * @deprecated Please use {@link LinearTransition} instead.
+ */
 export declare const Layout: typeof LinearTransition;

package/lib/typescript/reanimated2/layoutReanimation/defaultTransitions/SequencedTransition.d.ts

@@ -1,5 +1,12 @@
 import type { ILayoutAnimationBuilder, LayoutAnimationFunction } from '../animationBuilder/commonTypes';
 import { BaseAnimationBuilder } from '../animationBuilder';
+/**
+ * Transforms layout starting from the X-axis and width first, followed by the Y-axis and height. You can modify the behavior by chaining methods like `.springify()` or `.duration(500)`.
+ *
+ * You pass it to the `layout` prop on [an Animated component](https://docs.swmansion.com/react-native-reanimated/docs/fundamentals/glossary#animated-component).
+ *
+ * @see https://docs.swmansion.com/react-native-reanimated/docs/layout-animations/layout-transitions#sequenced-transition
+ */
 export declare class SequencedTransition extends BaseAnimationBuilder implements ILayoutAnimationBuilder {
     reversed: boolean;
     static createInstance<T extends typeof BaseAnimationBuilder>(this: T): InstanceType<T>;

package/lib/typescript/reanimated2/layoutReanimation/sharedTransitions/SharedTransition.d.ts

@@ -3,6 +3,12 @@ import { SharedTransitionType } from '../animationBuilder/commonTypes';
 import type { StyleProps } from '../../commonTypes';
 import { ReduceMotion } from '../../commonTypes';
 type AnimationFactory = (values: SharedTransitionAnimationsValues) => StyleProps;
+/**
+ * A SharedTransition builder class.
+ *
+ * @see https://docs.swmansion.com/react-native-reanimated/docs/shared-element-transitions/overview
+ * @experimental
+ */
 export declare class SharedTransition {
     private _customAnimationFactory;
     private _animation;
@@ -24,10 +30,46 @@ export declare class SharedTransition {
     private getProgressAnimation;
     private buildAnimation;
     private buildProgressAnimation;
+    /**
+     * Lets you create a custom shared transition animation. Other shared transition modifiers can be chained alongside this modifier.
+     *
+     * @param customAnimationFactory - Callback function that have to return an object with styles for the custom shared transition.
+     * @returns A {@link SharedTransition} object. Styles returned from this function need to be to the `sharedTransitionStyle` prop.
+     * @see https://docs.swmansion.com/react-native-reanimated/docs/shared-element-transitions/overview
+     * @experimental
+     */
     static custom(customAnimationFactory: AnimationFactory): SharedTransition;
+    /**
+     * Lets you change the duration of the shared transition. Other shared transition modifiers can be chained alongside this modifier.
+     *
+     * @param duration - The duration of the shared transition animation in milliseconds.
+     * @see https://docs.swmansion.com/react-native-reanimated/docs/shared-element-transitions/overview
+     * @experimental
+     */
     static duration(duration: number): SharedTransition;
+    /**
+     * Lets you create a shared transition animation bound to the progress between navigation screens. Other shared transition modifiers can be chained alongside this modifier.
+     *
+     * @param progressAnimationCallback - A callback called with the current progress value on every animation frame. It should return an object with styles for the shared transition.
+     * @see https://docs.swmansion.com/react-native-reanimated/docs/shared-element-transitions/overview
+     * @experimental
+     */
     static progressAnimation(progressAnimationCallback: CustomProgressAnimation): SharedTransition;
+    /**
+     * Whether the transition is progress-bound or not. Other shared transition modifiers can be chained alongside this modifier.
+     *
+     * @param transitionType - Type of the transition. Configured with {@link SharedTransitionType} enum.
+     * @see https://docs.swmansion.com/react-native-reanimated/docs/shared-element-transitions/overview
+     * @experimental
+     */
     static defaultTransitionType(transitionType: SharedTransitionType): SharedTransition;
-    static reduceMotion(_reduceMotion: ReduceMotion): SharedTransition;
+    /**
+     * Lets you adjust the behavior when the device's reduced motion accessibility setting is turned on. Other shared transition modifiers can be chained alongside this modifier.
+     *
+     * @param reduceMotion - Determines how the animation responds to the device's reduced motion accessibility setting. Default to `ReduceMotion.System` - {@link ReduceMotion}.
+     * @see https://docs.swmansion.com/react-native-reanimated/docs/shared-element-transitions/overview
+     * @experimental
+     */
+    static reduceMotion(reduceMotion: ReduceMotion): SharedTransition;
 }
 export {};

package/lib/typescript/reanimated2/layoutReanimation/web/createAnimation.d.ts

@@ -4,16 +4,16 @@ import type { TransformsStyle } from 'react-native';
 /**
  *  Modifies default animation by preserving transformations that given element already contains.
  *
- * @param animationName Name of the animation to be modified (e.g. `FadeIn`).
- * @param existingTransform Transform values that element already contains.
+ * @param animationName - Name of the animation to be modified (e.g. `FadeIn`).
+ * @param existingTransform - Transform values that element already contains.
  * @returns Animation parsed to keyframe string.
  */
 export declare function createAnimationWithExistingTransform(animationName: string, existingTransform: NonNullable<TransformsStyle['transform']>, layoutTransition?: AnimationData): string;
 /**
  * Creates transition of given type, appends it to stylesheet and returns keyframe name.
  *
- * @param transitionType Type of transition (e.g. LINEAR).
- * @param transitionData Object containing data for transforms (translateX, scaleX,...).
+ * @param transitionType - Type of transition (e.g. LINEAR).
+ * @param transitionData - Object containing data for transforms (translateX, scaleX,...).
  * @returns Keyframe name that represents transition.
  */
 export declare function TransitionGenerator(transitionType: TransitionType, transitionData: TransitionData, existingTransform: TransformsStyle['transform'] | undefined): string;

package/lib/typescript/reanimated2/platform-specific/jsVersion.d.ts

@@ -3,4 +3,4 @@
  * with the version used to build the native part of the library in runtime.
  * Remember to keep this in sync with the version declared in `package.json`
  */
-export declare const jsVersion = "3.6.0";
+export declare const jsVersion = "3.6.2";

package/lib/typescript/reanimated2/platformFunctions/dispatchCommand.d.ts

@@ -1,3 +1,11 @@
 import type { AnimatedRef } from '../hook/commonTypes';
 import type { Component } from 'react';
+/**
+ * Lets you synchronously call a command of a native component.
+ *
+ * @param animatedRef - An [animated ref](https://docs.swmansion.com/react-native-reanimated/docs/core/useAnimatedRef#returns) connected to the component you'd want to call the command on.
+ * @param commandName - The name of the command to dispatch (e.g. `"focus"` or `"scrollToEnd"`).
+ * @param args - An optional array of arguments for the command.
+ * @see https://docs.swmansion.com/react-native-reanimated/docs/advanced/dispatchCommand
+ */
 export declare let dispatchCommand: <T extends Component>(animatedRef: AnimatedRef<T>, commandName: string, args?: Array<unknown>) => void;

package/lib/typescript/reanimated2/platformFunctions/getRelativeCoords.d.ts

@@ -1,11 +1,19 @@
 import type { Component } from 'react';
 import type { AnimatedRef } from '../hook/commonTypes';
+/**
+ * An object which contains relative coordinates.
+ */
 export interface ComponentCoords {
     x: number;
     y: number;
 }
 /**
- * Given an absolute position and a component ref, returns the relative
- * position in the component's local coordinate space.
+ * Lets you determines the location on the screen, relative to the given view.
+ *
+ * @param animatedRef - An [animated ref](https://docs.swmansion.com/react-native-reanimated/docs/core/useAnimatedRef#returns) connected to the component you'd want to get the coordinates from.
+ * @param absoluteX - A number which is an absolute x coordinate.
+ * @param absoluteY - A number which is an absolute y coordinate.
+ * @returns An object which contains relative coordinates - {@link ComponentCoords}.
+ * @see https://docs.swmansion.com/react-native-reanimated/docs/utilities/getRelativeCoords
  */
-export declare function getRelativeCoords(parentAnimatedRef: AnimatedRef<Component>, absoluteX: number, absoluteY: number): ComponentCoords | null;
+export declare function getRelativeCoords(animatedRef: AnimatedRef<Component>, absoluteX: number, absoluteY: number): ComponentCoords | null;

package/lib/typescript/reanimated2/platformFunctions/measure.d.ts

@@ -1,4 +1,11 @@
 import type { MeasuredDimensions } from '../commonTypes';
 import type { AnimatedRef } from '../hook/commonTypes';
 import type { Component } from 'react';
+/**
+ * Lets you synchronously get the dimensions and position of a view on the screen.
+ *
+ * @param animatedRef - An [animated ref](https://docs.swmansion.com/react-native-reanimated/docs/core/useAnimatedRef#returns) connected to the component you'd want to get the measurements from.
+ * @returns An object containing component measurements or null when the measurement couldn't be performed- {@link MeasuredDimensions}.
+ * @see https://docs.swmansion.com/react-native-reanimated/docs/advanced/measure/
+ */
 export declare let measure: <T extends Component>(animatedRef: AnimatedRef<T>) => MeasuredDimensions | null;

package/lib/typescript/reanimated2/platformFunctions/scrollTo.d.ts

@@ -1,3 +1,12 @@
 import type { AnimatedRef } from '../hook/commonTypes';
 import type { Component } from 'react';
+/**
+ * Lets you synchronously scroll to a given position of a `ScrollView`.
+ *
+ * @param animatedRef - An [animated ref](https://docs.swmansion.com/react-native-reanimated/docs/core/useAnimatedRef) attached to an `Animated.ScrollView` component.
+ * @param x - The x position you want to scroll to.
+ * @param y - The y position you want to scroll to.
+ * @param animated - Whether the scrolling should be smooth or instant.
+ * @see https://docs.swmansion.com/react-native-reanimated/docs/scroll/scrollTo
+ */
 export declare let scrollTo: <T extends Component>(animatedRef: AnimatedRef<T>, x: number, y: number, animated: boolean) => void;

package/lib/typescript/reanimated2/platformFunctions/setNativeProps.d.ts

@@ -1,4 +1,11 @@
 import type { StyleProps } from '../commonTypes';
 import type { AnimatedRef } from '../hook/commonTypes';
 import type { Component } from 'react';
+/**
+ * Lets you imperatively update component properties. You should always reach for [useAnimatedStyle](https://docs.swmansion.com/react-native-reanimated/docs/core/useAnimatedStyle) and [useAnimatedProps](https://docs.swmansion.com/react-native-reanimated/docs/core/useAnimatedProps) first when animating styles or properties.
+ *
+ * @param animatedRef - An [animated ref](https://docs.swmansion.com/react-native-reanimated/docs/core/useAnimatedRef#returns) connected to the component you'd want to update.
+ * @param updates - An object with properties you want to update.
+ * @see https://docs.swmansion.com/react-native-reanimated/docs/advanced/setNativeProps
+ */
 export declare let setNativeProps: <T extends Component>(animatedRef: AnimatedRef<T>, updates: StyleProps) => void;

package/lib/typescript/reanimated2/runtimes.d.ts

@@ -3,5 +3,13 @@ export type WorkletRuntime = {
     __hostObjectWorkletRuntime: never;
     readonly name: string;
 };
+/**
+ * Lets you create a new JS runtime which can be used to run worklets possibly on different threads than JS or UI thread.
+ *
+ * @param name - A name used to identify the runtime which will appear in devices list in Chrome DevTools.
+ * @param initializer - An optional worklet that will be run synchronously on the same thread immediately after the runtime is created.
+ * @returns WorkletRuntime which is a jsi::HostObject\<reanimated::WorkletRuntime\> - {@link WorkletRuntime}
+ * @see https://docs.swmansion.com/react-native-reanimated/docs/threading/createWorkletRuntime
+ */
 export declare function createWorkletRuntime(name: string, initializer?: __ComplexWorkletFunction<[], void>): WorkletRuntime;
 export declare function runOnRuntime<Args extends unknown[], ReturnValue>(workletRuntime: WorkletRuntime, worklet: (...args: Args) => ReturnValue): WorkletFunction<Args, ReturnValue>;

package/lib/typescript/reanimated2/threads.d.ts

@@ -1,6 +1,17 @@
 import type { WorkletFunction } from './commonTypes';
 export declare function setupMicrotasks(): void;
 export declare const callMicrotasks: () => void;
+/**
+ * Lets you asynchronously run [workletized](https://docs.swmansion.com/react-native-reanimated/docs/fundamentals/glossary#to-workletize) functions on the [UI thread](https://docs.swmansion.com/react-native-reanimated/docs/threading/runOnUI).
+ *
+ * This method does not schedule the work immediately but instead waits for other worklets
+ * to be scheduled within the same JS loop. It uses queueMicrotask to schedule all the worklets
+ * at once making sure they will run within the same frame boundaries on the UI thread.
+ *
+ * @param fun - A reference to a function you want to execute on the [UI thread](https://docs.swmansion.com/react-native-reanimated/docs/threading/runOnUI) from the [JavaScript thread](https://docs.swmansion.com/react-native-reanimated/docs/threading/runOnUI).
+ * @returns A function that accepts arguments for the function passed as the first argument.
+ * @see https://docs.swmansion.com/react-native-reanimated/docs/threading/runOnUI
+ */
 export declare function runOnUI<Args extends unknown[], ReturnValue>(worklet: (...args: Args) => ReturnValue): (...args: Args) => void;
 export declare function runOnUIImmediately<Args extends unknown[], ReturnValue>(worklet: (...args: Args) => ReturnValue): WorkletFunction<Args, ReturnValue>;
 type ReleaseRemoteFunction<Args extends unknown[], ReturnValue> = {
@@ -11,8 +22,12 @@ type DevRemoteFunction<Args extends unknown[], ReturnValue> = {
 };
 type RemoteFunction<Args extends unknown[], ReturnValue> = ReleaseRemoteFunction<Args, ReturnValue> | DevRemoteFunction<Args, ReturnValue>;
 /**
- * Returns a function that can be called to be executed asynchronously on both
- * UI and JS threads.
+ * Lets you asynchronously run non-[workletized](https://docs.swmansion.com/react-native-reanimated/docs/fundamentals/glossary#to-workletize) functions that couldn't otherwise run on the [UI thread](https://docs.swmansion.com/react-native-reanimated/docs/fundamentals/glossary#ui-thread).
+ * This applies to most external libraries as they don't have their functions marked with "worklet"; directive.
+ *
+ * @param fun - A reference to a function you want to execute on the JavaScript thread from the UI thread.
+ * @returns A function that accepts arguments for the function passed as the first argument.
+ * @see https://docs.swmansion.com/react-native-reanimated/docs/threading/runOnJS
  */
 export declare function runOnJS<Args extends unknown[], ReturnValue>(fun: ((...args: Args) => ReturnValue) | RemoteFunction<Args, ReturnValue> | WorkletFunction<Args, ReturnValue>): (...args: Args) => void;
 export {};