@remotion/lottie 3.3.54 → 3.3.55

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/Lottie.d.ts CHANGED
@@ -1,3 +1,7 @@
1
1
  /// <reference types="react" />
2
2
  import type { LottieProps } from './types';
3
+ /**
4
+ * @description Part of the @remotion/lottie package.
5
+ * @see [Documentation](https://www.remotion.dev/docs/lottie/lottie)
6
+ */
3
7
  export declare const Lottie: ({ animationData, className, direction, loop, playbackRate, style, onAnimationLoaded, }: LottieProps) => JSX.Element;
package/dist/Lottie.js CHANGED
@@ -11,6 +11,10 @@ const remotion_1 = require("remotion");
11
11
  const utils_1 = require("./utils");
12
12
  const validate_loop_1 = require("./validate-loop");
13
13
  const validate_playbackrate_1 = require("./validate-playbackrate");
14
+ /**
15
+ * @description Part of the @remotion/lottie package.
16
+ * @see [Documentation](https://www.remotion.dev/docs/lottie/lottie)
17
+ */
14
18
  const Lottie = ({ animationData, className, direction, loop, playbackRate, style, onAnimationLoaded, }) => {
15
19
  if (typeof animationData !== 'object') {
16
20
  throw new Error('animationData should be provided as an object. If you only have the path to the JSON file, load it and pass it as animationData. See https://remotion.dev/docs/lottie/lottie#example for more information.');
@@ -6,5 +6,9 @@ declare type LottieMetadata = {
6
6
  width: number;
7
7
  height: number;
8
8
  };
9
+ /**
10
+ * @description Get the basic metadata such as dimensions, duration and framerate of a Lottie animation.
11
+ * @see [Documentation](https://www.remotion.dev/docs/lottie/getlottiemetadata)
12
+ */
9
13
  export declare const getLottieMetadata: (animationData: LottieAnimationData) => LottieMetadata | null;
10
14
  export {};
@@ -1,6 +1,10 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.getLottieMetadata = void 0;
4
+ /**
5
+ * @description Get the basic metadata such as dimensions, duration and framerate of a Lottie animation.
6
+ * @see [Documentation](https://www.remotion.dev/docs/lottie/getlottiemetadata)
7
+ */
4
8
  const getLottieMetadata = (animationData) => {
5
9
  const width = animationData.w;
6
10
  const height = animationData.h;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@remotion/lottie",
3
- "version": "3.3.54",
3
+ "version": "3.3.55",
4
4
  "description": "Remotion Lottie",
5
5
  "main": "dist/index.js",
6
6
  "sideEffects": false,
@@ -27,7 +27,7 @@
27
27
  ],
28
28
  "license": "SEE LICENSE IN LICENSE.md",
29
29
  "dependencies": {
30
- "remotion": "3.3.54"
30
+ "remotion": "3.3.55"
31
31
  },
32
32
  "peerDependencies": {
33
33
  "lottie-web": "^5",
@@ -58,5 +58,5 @@
58
58
  "publishConfig": {
59
59
  "access": "public"
60
60
  },
61
- "gitHead": "3a004e0b0e2a805fb276c35dd5922e3389c9f53c"
61
+ "gitHead": "4cecccc293e9c906c693f55fac65df8f1cfd2338"
62
62
  }