react-native-reanimated 3.6.0 → 3.6.2

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

@@ -7,6 +7,14 @@ import type {
 import { withSequence, withTiming } from '../../animation';
 import type { BaseAnimationBuilder } from '../animationBuilder';
 import { ComplexAnimationBuilder } from '../animationBuilder';
+
+/**
+ * Bounce entering animation. You can modify the behavior by chaining methods like `.delay(300)` or `.duration(100)`.
+ *
+ * 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#bounce
+ */
 export class BounceIn
   extends ComplexAnimationBuilder
   implements IEntryExitAnimationBuilder
@@ -60,6 +68,13 @@ export class BounceIn
   };
 }
 
+/**
+ * Bounce from bottom animation. You can modify the behavior by chaining methods like `.delay(300)` or `.duration(100)`.
+ *
+ * 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#bounce
+ */
 export class BounceInDown
   extends ComplexAnimationBuilder
   implements IEntryExitAnimationBuilder
@@ -117,6 +132,13 @@ export class BounceInDown
   };
 }
 
+/**
+ * Bounce from top animation. You can modify the behavior by chaining methods like `.delay(300)` or `.duration(100)`.
+ *
+ * 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#bounce
+ */
 export class BounceInUp
   extends ComplexAnimationBuilder
   implements IEntryExitAnimationBuilder
@@ -170,6 +192,13 @@ export class BounceInUp
   };
 }
 
+/**
+ * Bounce from left animation. You can modify the behavior by chaining methods like `.delay(300)` or `.duration(100)`.
+ *
+ * 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#bounce
+ */
 export class BounceInLeft
   extends ComplexAnimationBuilder
   implements IEntryExitAnimationBuilder
@@ -223,6 +252,13 @@ export class BounceInLeft
   };
 }
 
+/**
+ * Bounce from right animation. You can modify the behavior by chaining methods like `.delay(300)` or `.duration(100)`.
+ *
+ * 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#bounce
+ */
 export class BounceInRight
   extends ComplexAnimationBuilder
   implements IEntryExitAnimationBuilder
@@ -276,6 +312,13 @@ export class BounceInRight
   };
 }
 
+/**
+ * Bounce exiting animation. You can modify the behavior by chaining methods like `.delay(300)` or `.duration(100)`.
+ *
+ * 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#bounce
+ */
 export class BounceOut
   extends ComplexAnimationBuilder
   implements IEntryExitAnimationBuilder
@@ -329,6 +372,13 @@ export class BounceOut
   };
 }
 
+/**
+ * Bounce to bottom animation. You can modify the behavior by chaining methods like `.delay(300)` or `.duration(100)`.
+ *
+ * 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#bounce
+ */
 export class BounceOutDown
   extends ComplexAnimationBuilder
   implements IEntryExitAnimationBuilder
@@ -384,6 +434,13 @@ export class BounceOutDown
   };
 }
 
+/**
+ * Bounce to top animation. You can modify the behavior by chaining methods like `.delay(300)` or `.duration(100)`.
+ *
+ * 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#bounce
+ */
 export class BounceOutUp
   extends ComplexAnimationBuilder
   implements IEntryExitAnimationBuilder
@@ -439,6 +496,13 @@ export class BounceOutUp
   };
 }
 
+/**
+ * Bounce to left animation. You can modify the behavior by chaining methods like `.delay(300)` or `.duration(100)`.
+ *
+ * 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#bounce
+ */
 export class BounceOutLeft
   extends ComplexAnimationBuilder
   implements IEntryExitAnimationBuilder
@@ -494,6 +558,13 @@ export class BounceOutLeft
   };
 }
 
+/**
+ * Bounce to right animation. You can modify the behavior by chaining methods like `.delay(300)` or `.duration(100)`.
+ *
+ * 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#bounce
+ */
 export class BounceOutRight
   extends ComplexAnimationBuilder
   implements IEntryExitAnimationBuilder

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

@@ -6,6 +6,13 @@ import type {
 import type { BaseAnimationBuilder } from '../animationBuilder';
 import { ComplexAnimationBuilder } from '../animationBuilder';
 
+/**
+ * Fade in 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#fade
+ */
 export class FadeIn
   extends ComplexAnimationBuilder
   implements IEntryExitAnimationBuilder
@@ -39,6 +46,13 @@ export class FadeIn
   };
 }
 
+/**
+ * Fade 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#fade
+ */
 export class FadeInRight
   extends ComplexAnimationBuilder
   implements IEntryExitAnimationBuilder
@@ -76,6 +90,13 @@ export class FadeInRight
   };
 }
 
+/**
+ * Fade 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#fade
+ */
 export class FadeInLeft
   extends ComplexAnimationBuilder
   implements IEntryExitAnimationBuilder
@@ -113,6 +134,13 @@ export class FadeInLeft
   };
 }
 
+/**
+ * Fade 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#fade
+ */
 export class FadeInUp
   extends ComplexAnimationBuilder
   implements IEntryExitAnimationBuilder
@@ -150,6 +178,13 @@ export class FadeInUp
   };
 }
 
+/**
+ * Fade 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#fade
+ */
 export class FadeInDown
   extends ComplexAnimationBuilder
   implements IEntryExitAnimationBuilder
@@ -187,6 +222,13 @@ export class FadeInDown
   };
 }
 
+/**
+ * Fade out 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#fade
+ */
 export class FadeOut
   extends ComplexAnimationBuilder
   implements IEntryExitAnimationBuilder
@@ -220,6 +262,13 @@ export class FadeOut
   };
 }
 
+/**
+ * Fade 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#fade
+ */
 export class FadeOutRight
   extends ComplexAnimationBuilder
   implements IEntryExitAnimationBuilder
@@ -257,6 +306,13 @@ export class FadeOutRight
   };
 }
 
+/**
+ * Fade 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#fade
+ */
 export class FadeOutLeft
   extends ComplexAnimationBuilder
   implements IEntryExitAnimationBuilder
@@ -293,7 +349,13 @@ export class FadeOutLeft
     };
   };
 }
-
+/**
+ * Fade 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#fade
+ */
 export class FadeOutUp
   extends ComplexAnimationBuilder
   implements IEntryExitAnimationBuilder
@@ -331,6 +393,13 @@ export class FadeOutUp
   };
 }
 
+/**
+ * Fade 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#fade
+ */
 export class FadeOutDown
   extends ComplexAnimationBuilder
   implements IEntryExitAnimationBuilder

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

@@ -11,6 +11,13 @@ import type {
 import type { BaseAnimationBuilder } from '../animationBuilder';
 import { ComplexAnimationBuilder } from '../animationBuilder';
 
+/**
+ * Rotate from top 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#flip
+ */
 export class FlipInXUp
   extends ComplexAnimationBuilder
   implements IEntryAnimationBuilder
@@ -52,6 +59,13 @@ export class FlipInXUp
   };
 }
 
+/**
+ * Rotate from left 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#flip
+ */
 export class FlipInYLeft
   extends ComplexAnimationBuilder
   implements IEntryAnimationBuilder
@@ -93,6 +107,13 @@ export class FlipInYLeft
   };
 }
 
+/**
+ * Rotate from bottom 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#flip
+ */
 export class FlipInXDown
   extends ComplexAnimationBuilder
   implements IEntryAnimationBuilder
@@ -134,6 +155,13 @@ export class FlipInXDown
   };
 }
 
+/**
+ * Rotate from right 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#flip
+ */
 export class FlipInYRight
   extends ComplexAnimationBuilder
   implements IEntryAnimationBuilder
@@ -175,6 +203,13 @@ export class FlipInYRight
   };
 }
 
+/**
+ * Eased rotate in 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#flip
+ */
 export class FlipInEasyX
   extends ComplexAnimationBuilder
   implements IEntryExitAnimationBuilder
@@ -211,6 +246,13 @@ export class FlipInEasyX
   };
 }
 
+/**
+ * Eased rotate in 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#flip
+ */
 export class FlipInEasyY
   extends ComplexAnimationBuilder
   implements IEntryExitAnimationBuilder
@@ -247,6 +289,13 @@ export class FlipInEasyY
   };
 }
 
+/**
+ * Rotate to top 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#flip
+ */
 export class FlipOutXUp
   extends ComplexAnimationBuilder
   implements IExitAnimationBuilder
@@ -293,6 +342,13 @@ export class FlipOutXUp
   };
 }
 
+/**
+ * Rotate to left 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#flip
+ */
 export class FlipOutYLeft
   extends ComplexAnimationBuilder
   implements IExitAnimationBuilder
@@ -339,6 +395,13 @@ export class FlipOutYLeft
   };
 }
 
+/**
+ * Rotate to bottom 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#flip
+ */
 export class FlipOutXDown
   extends ComplexAnimationBuilder
   implements IExitAnimationBuilder
@@ -385,6 +448,13 @@ export class FlipOutXDown
   };
 }
 
+/**
+ * Rotate to right 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#flip
+ */
 export class FlipOutYRight
   extends ComplexAnimationBuilder
   implements IExitAnimationBuilder
@@ -431,6 +501,13 @@ export class FlipOutYRight
   };
 }
 
+/**
+ * Eased rotate 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#flip
+ */
 export class FlipOutEasyX
   extends ComplexAnimationBuilder
   implements IEntryExitAnimationBuilder
@@ -467,6 +544,13 @@ export class FlipOutEasyX
   };
 }
 
+/**
+ * Eased rotate 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#flip
+ */
 export class FlipOutEasyY
   extends ComplexAnimationBuilder
   implements IEntryExitAnimationBuilder

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

@@ -8,6 +8,13 @@ import type {
   IEntryExitAnimationBuilder,
 } from '../animationBuilder/commonTypes';
 
+/**
+ * Entry from right animation with change in skew and opacity. 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#lightspeed
+ */
 export class LightSpeedInRight
   extends ComplexAnimationBuilder
   implements IEntryExitAnimationBuilder
@@ -61,6 +68,13 @@ export class LightSpeedInRight
   };
 }
 
+/**
+ * Entry from left animation with change in skew and opacity. 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#lightspeed
+ */
 export class LightSpeedInLeft
   extends ComplexAnimationBuilder
   implements IEntryExitAnimationBuilder
@@ -114,6 +128,13 @@ export class LightSpeedInLeft
   };
 }
 
+/**
+ * Exit to right animation with change in skew and opacity. 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#lightspeed
+ */
 export class LightSpeedOutRight
   extends ComplexAnimationBuilder
   implements IEntryExitAnimationBuilder
@@ -159,6 +180,13 @@ export class LightSpeedOutRight
   };
 }
 
+/**
+ * Exit to left animation with change in skew and opacity. 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/#lightspeed
+ */
 export class LightSpeedOutLeft
   extends ComplexAnimationBuilder
   implements IEntryExitAnimationBuilder

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

@@ -6,6 +6,13 @@ import type {
   IEntryExitAnimationBuilder,
 } from '../animationBuilder/commonTypes';
 
+/**
+ * Entry with change in rotation, scale, and opacity. 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#pinwheel
+ */
 export class PinwheelIn
   extends ComplexAnimationBuilder
   implements IEntryExitAnimationBuilder
@@ -55,6 +62,13 @@ export class PinwheelIn
   };
 }
 
+/**
+ * Exit with change in rotation, scale, and opacity. 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#pinwheel
+ */
 export class PinwheelOut
   extends ComplexAnimationBuilder
   implements IEntryExitAnimationBuilder

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

@@ -7,6 +7,13 @@ import type {
   IEntryExitAnimationBuilder,
 } from '../animationBuilder/commonTypes';
 
+/**
+ * Roll 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#roll
+ */
 export class RollInLeft
   extends ComplexAnimationBuilder
   implements IEntryExitAnimationBuilder
@@ -46,6 +53,13 @@ export class RollInLeft
   };
 }
 
+/**
+ * Roll 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#roll
+ */
 export class RollInRight
   extends ComplexAnimationBuilder
   implements IEntryExitAnimationBuilder
@@ -82,6 +96,13 @@ export class RollInRight
   };
 }
 
+/**
+ * Roll 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#roll
+ */
 export class RollOutLeft
   extends ComplexAnimationBuilder
   implements IEntryExitAnimationBuilder
@@ -123,6 +144,13 @@ export class RollOutLeft
   };
 }
 
+/**
+ * Roll 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#roll
+ */
 export class RollOutRight
   extends ComplexAnimationBuilder
   implements IEntryExitAnimationBuilder