react-native-reanimated 3.6.0 → 3.6.2

package/src/reanimated2/layoutReanimation/defaultAnimations/Rotate.ts

@@ -9,6 +9,13 @@ import type {
   IExitAnimationBuilder,
 } from '../animationBuilder/commonTypes';
 
+/**
+ * Rotate to bottom from left edge. 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#rotate
+ */
 export class RotateInDownLeft
   extends ComplexAnimationBuilder
   implements IEntryAnimationBuilder
@@ -52,6 +59,13 @@ export class RotateInDownLeft
   };
 }
 
+/**
+ * Rotate to bottom from right edge. 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#rotate
+ */
 export class RotateInDownRight
   extends ComplexAnimationBuilder
   implements IEntryAnimationBuilder
@@ -95,6 +109,13 @@ export class RotateInDownRight
   };
 }
 
+/**
+ * Rotate to top from left edge. 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#rotate
+ */
 export class RotateInUpLeft
   extends ComplexAnimationBuilder
   implements IEntryAnimationBuilder
@@ -138,6 +159,13 @@ export class RotateInUpLeft
   };
 }
 
+/**
+ * Rotate to top from right edge. 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#rotate
+ */
 export class RotateInUpRight
   extends ComplexAnimationBuilder
   implements IEntryAnimationBuilder
@@ -181,6 +209,13 @@ export class RotateInUpRight
   };
 }
 
+/**
+ * Rotate to bottom from left edge. 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#rotate
+ */
 export class RotateOutDownLeft
   extends ComplexAnimationBuilder
   implements IExitAnimationBuilder
@@ -236,6 +271,13 @@ export class RotateOutDownLeft
   };
 }
 
+/**
+ * Rotate to bottom from right edge. 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#rotate
+ */
 export class RotateOutDownRight
   extends ComplexAnimationBuilder
   implements IExitAnimationBuilder
@@ -291,6 +333,13 @@ export class RotateOutDownRight
   };
 }
 
+/**
+ * Rotate to top from left edge. 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#rotate
+ */
 export class RotateOutUpLeft
   extends ComplexAnimationBuilder
   implements IExitAnimationBuilder
@@ -346,6 +395,13 @@ export class RotateOutUpLeft
   };
 }
 
+/**
+ * Rotate to top from right edge. 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#rotate
+ */
 export class RotateOutUpRight
   extends ComplexAnimationBuilder
   implements IExitAnimationBuilder

package/src/reanimated2/layoutReanimation/defaultAnimations/Slide.ts

@@ -9,6 +9,13 @@ import type {
 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 class SlideInRight
   extends ComplexAnimationBuilder
   implements IEntryAnimationBuilder
@@ -45,6 +52,13 @@ export class SlideInRight
   };
 }
 
+/**
+ * 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 class SlideInLeft
   extends ComplexAnimationBuilder
   implements IEntryAnimationBuilder
@@ -81,6 +95,13 @@ export class SlideInLeft
   };
 }
 
+/**
+ * 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 class SlideOutRight
   extends ComplexAnimationBuilder
   implements IExitAnimationBuilder
@@ -123,6 +144,13 @@ export class SlideOutRight
   };
 }
 
+/**
+ * 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 class SlideOutLeft
   extends ComplexAnimationBuilder
   implements IExitAnimationBuilder
@@ -165,6 +193,13 @@ export class SlideOutLeft
   };
 }
 
+/**
+ * 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 class SlideInUp
   extends ComplexAnimationBuilder
   implements IEntryAnimationBuilder
@@ -201,6 +236,13 @@ export class SlideInUp
   };
 }
 
+/**
+ * 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 class SlideInDown
   extends ComplexAnimationBuilder
   implements IEntryAnimationBuilder
@@ -237,6 +279,13 @@ export class SlideInDown
   };
 }
 
+/**
+ * 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 class SlideOutUp
   extends ComplexAnimationBuilder
   implements IExitAnimationBuilder
@@ -276,6 +325,13 @@ export class SlideOutUp
   };
 }
 
+/**
+ * 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 class SlideOutDown
   extends ComplexAnimationBuilder
   implements IExitAnimationBuilder

package/src/reanimated2/layoutReanimation/defaultAnimations/Stretch.ts

@@ -6,6 +6,13 @@ import type {
 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 class StretchInX
   extends ComplexAnimationBuilder
   implements IEntryExitAnimationBuilder
@@ -39,6 +46,13 @@ export class StretchInX
   };
 }
 
+/**
+ * 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 class StretchInY
   extends ComplexAnimationBuilder
   implements IEntryExitAnimationBuilder
@@ -72,6 +86,13 @@ export class StretchInY
   };
 }
 
+/**
+ * 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 class StretchOutX
   extends ComplexAnimationBuilder
   implements IEntryExitAnimationBuilder
@@ -105,6 +126,13 @@ export class StretchOutX
   };
 }
 
+/**
+ * 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 class StretchOutY
   extends ComplexAnimationBuilder
   implements IEntryExitAnimationBuilder

package/src/reanimated2/layoutReanimation/defaultAnimations/Zoom.ts

@@ -12,6 +12,13 @@ import type {
 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 class ZoomIn
   extends ComplexAnimationBuilder
   implements IEntryExitAnimationBuilder
@@ -45,6 +52,13 @@ export class ZoomIn
   };
 }
 
+/**
+ * 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 class ZoomInRotate
   extends ComplexAnimationBuilder
   implements IEntryExitAnimationBuilder
@@ -82,6 +96,13 @@ export class ZoomInRotate
   };
 }
 
+/**
+ * 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 class ZoomInLeft
   extends ComplexAnimationBuilder
   implements IEntryExitAnimationBuilder
@@ -118,6 +139,13 @@ export class ZoomInLeft
   };
 }
 
+/**
+ * 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 class ZoomInRight
   extends ComplexAnimationBuilder
   implements IEntryExitAnimationBuilder
@@ -154,6 +182,13 @@ export class ZoomInRight
   };
 }
 
+/**
+ * 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 class ZoomInUp
   extends ComplexAnimationBuilder
   implements IEntryExitAnimationBuilder
@@ -190,6 +225,13 @@ export class ZoomInUp
   };
 }
 
+/**
+ * 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 class ZoomInDown
   extends ComplexAnimationBuilder
   implements IEntryExitAnimationBuilder
@@ -226,6 +268,13 @@ export class ZoomInDown
   };
 }
 
+/**
+ * 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 class ZoomInEasyUp
   extends ComplexAnimationBuilder
   implements IEntryAnimationBuilder
@@ -262,6 +311,13 @@ export class ZoomInEasyUp
   };
 }
 
+/**
+ * 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 class ZoomInEasyDown
   extends ComplexAnimationBuilder
   implements IEntryAnimationBuilder
@@ -298,6 +354,13 @@ export class ZoomInEasyDown
   };
 }
 
+/**
+ * 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 class ZoomOut
   extends ComplexAnimationBuilder
   implements IEntryExitAnimationBuilder
@@ -331,6 +394,13 @@ export class ZoomOut
   };
 }
 
+/**
+ * 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 class ZoomOutRotate
   extends ComplexAnimationBuilder
   implements IEntryExitAnimationBuilder
@@ -368,6 +438,13 @@ export class ZoomOutRotate
   };
 }
 
+/**
+ * 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 class ZoomOutLeft
   extends ComplexAnimationBuilder
   implements IEntryExitAnimationBuilder
@@ -409,6 +486,13 @@ export class ZoomOutLeft
   };
 }
 
+/**
+ * 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 class ZoomOutRight
   extends ComplexAnimationBuilder
   implements IEntryExitAnimationBuilder
@@ -450,6 +534,13 @@ export class ZoomOutRight
   };
 }
 
+/**
+ * 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 class ZoomOutUp
   extends ComplexAnimationBuilder
   implements IEntryExitAnimationBuilder
@@ -491,6 +582,13 @@ export class ZoomOutUp
   };
 }
 
+/**
+ * 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 class ZoomOutDown
   extends ComplexAnimationBuilder
   implements IEntryExitAnimationBuilder
@@ -532,6 +630,13 @@ export class ZoomOutDown
   };
 }
 
+/**
+ * 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 class ZoomOutEasyUp
   extends ComplexAnimationBuilder
   implements IExitAnimationBuilder
@@ -573,6 +678,13 @@ export class ZoomOutEasyUp
   };
 }
 
+/**
+ * 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 class ZoomOutEasyDown
   extends ComplexAnimationBuilder
   implements IExitAnimationBuilder

package/src/reanimated2/layoutReanimation/defaultTransitions/CurvedTransition.ts

@@ -8,6 +8,13 @@ import type { EasingFunction } from '../../Easing';
 import { Easing } from '../../Easing';
 import { withTiming } from '../../animation';
 
+/**
+ * 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 class CurvedTransition
   extends BaseAnimationBuilder
   implements ILayoutAnimationBuilder

package/src/reanimated2/layoutReanimation/defaultTransitions/EntryExitTransition.ts

@@ -246,6 +246,14 @@ export class EntryExitTransition
   };
 }
 
+/**
+ * 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 function combineTransition(
   exiting: BaseAnimationBuilder | typeof BaseAnimationBuilder,
   entering: BaseAnimationBuilder | typeof BaseAnimationBuilder

package/src/reanimated2/layoutReanimation/defaultTransitions/FadingTransition.ts

@@ -6,6 +6,13 @@ import type {
 } 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 class FadingTransition
   extends BaseAnimationBuilder
   implements ILayoutAnimationBuilder

package/src/reanimated2/layoutReanimation/defaultTransitions/JumpingTransition.ts

@@ -6,6 +6,14 @@ import type {
 import { withSequence, withTiming } from '../../animation';
 import { Easing } from '../../Easing';
 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 class JumpingTransition
   extends BaseAnimationBuilder
   implements ILayoutAnimationBuilder

package/src/reanimated2/layoutReanimation/defaultTransitions/LinearTransition.ts

@@ -6,6 +6,13 @@ import type {
   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 class LinearTransition
   extends ComplexAnimationBuilder
   implements ILayoutAnimationBuilder
@@ -49,7 +56,7 @@ export class LinearTransition
   };
 }
 
-// This export is unofficially deprecated because it's
-// name makes little sense - should be something among the lines of
-// `DefaultLayoutTransition` but it's so long!
+/**
+ * @deprecated Please use {@link LinearTransition} instead.
+ */
 export const Layout = LinearTransition;

package/src/reanimated2/layoutReanimation/defaultTransitions/SequencedTransition.ts

@@ -6,6 +6,13 @@ import type {
 } 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 class SequencedTransition
   extends BaseAnimationBuilder
   implements ILayoutAnimationBuilder