@lottiefiles/lottie-player 1.5.6 → 1.5.8

package/README.md

@@ -24,7 +24,7 @@ For full documentation, visit [docs.lottiefiles.com/lottie-player](https://docs.
 - Import from CDN.
 
 ```html
-<script src="https://unpkg.com/@lottiefiles/lottie-player@0.4.0/dist/lottie-player.js"></script>
+<script src="https://unpkg.com/@lottiefiles/lottie-player@1.5.7/dist/lottie-player.js"></script>
 ```
 
 - Import from local node_modules directory.
@@ -88,12 +88,14 @@ You may set and load animations programatically as well.
 
 ```js
 const player = document.querySelector("lottie-player");
-player.load("https://assets3.lottiefiles.com/packages/lf20_UJNc2t.json");
-
-// or load via a Bodymovin JSON string/object
-player.load(
-  '{"v":"5.3.4","fr":30,"ip":0,"op":38,"w":315,"h":600,"nm":"new", ... }'
-);
+player.addEventListener("rendered", (e) => {
+  //Load via URL
+  player.load("https://assets3.lottiefiles.com/packages/lf20_UJNc2t.json");
+  // or load via a Bodymovin JSON string/object
+  player.load(
+    '{"v":"5.3.4","fr":30,"ip":0,"op":38,"w":315,"h":600,"nm":"new", ... }'
+  );
+});
 ```
 
 ### TGS-Player
@@ -169,21 +171,52 @@ declare namespace JSX {
 }
 ```
 
-### NuxtJS
+### Nuxt 2
 
-The process for NuxtJS is slightly different. Create a lottie-player.js file in project root inside a folder named 'plugins'. Add the code below to the file
+Create a `lottie-player.js` file inside the `/plugins` folder and add the below code to the file:
 
 ```js
 import * as LottiePlayer from "@lottiefiles/lottie-player";
+```  
+\
+Open `nuxt.config.js` file and add the following entry to register the newly created plugin:
+
+```js
+export default {
+  plugins: [{ src: "~/plugins/lottie-player.js", mode: "client" }]
+}
+```
+
+This is because the player script needs to be rendered on the browser/client side and we must configure Nuxt to load the script on the client side only.  
+\
+You would then be able to use the player as follows inside any component:
+
+```html
+<lottie-player
+  autoplay
+  controls
+  loop
+  style="width:400px"
+  src="https://assets3.lottiefiles.com/packages/lf20_RItkEz.json"
+  speed="1"
+  debug
+/>
 ```
 
-Open nuxt.config.js file and adjust the plugins array as shown below
+### Nuxt 3
+
+The process for Nuxt 3 is slightly different.  
+Create a `lottie-player.client.ts` file inside the `/plugins` folder and add the below code to the file:
 
 ```js
-plugins: [{ src: "~/plugins/lottie-player.js", mode: "client" }],
+import * as LottiePlayer from "@lottiefiles/lottie-player";
+
+export default LottiePlayer;
 ```
+\
+Your plugin will be automatically available throughout your Nuxt application thanks to the [plugin auto-registration](https://v3.nuxtjs.org/guide/directory-structure/plugins). Note the `client` suffix in the name of the plugin - this tells Nuxt to load it only on the client side, as the Lottie Player script can only be rendered in the browser.
 
-You would then be able to use the player as follows inside any component
+You would then be able to use the player as follows inside any component:
 
 ```html
 <lottie-player
@@ -194,14 +227,12 @@ You would then be able to use the player as follows inside any component
   src="https://assets3.lottiefiles.com/packages/lf20_RItkEz.json"
   speed="1"
   debug
-></lottie-player>
+/>
 ```
 
-This is because the player script needs to be rendered on the browser/client side and we must configure nuxtjs to load the script on the client side only.
-
 ### NextJS
 
-The process to import in NextJS is similar to NuxtJS in the sense that on SSR mode, the library must be declared as a client side module. To do this, import the library within a react useEffect hook.
+The process to import in NextJS is similar to Nuxt in the sense that on SSR mode, the library must be declared as a client side module. To do this, import the library within a react useEffect hook.
 
 ```javascript
 import React, { useRef } from "react";
@@ -242,7 +273,6 @@ declare namespace JSX {
 
 Full documentation on player properties, methods, events and styling for the Lottie-player are available [here](https://docs.lottiefiles.com/lottie-player).
 
-
 ## Community & Support
 
 - [Github issues.](https://github.com/LottieFiles/lottie-player/issues) For bugs and errors you encounter using this player.
@@ -311,7 +341,6 @@ Full documentation on player properties, methods, events and styling for the Lot
     </td>
   </tr>
 
-
 </table>
 
 ## License

package/dist/lottie-player.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"lottie-player.d.ts","sourceRoot":"","sources":["../src/lottie-player.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,UAAU,EAAQ,MAAM,KAAK,CAAC;AAEvC,OAAO,EAAE,cAAc,EAAE,MAAM,aAAa,CAAC;AAO7C,oBAAY,WAAW;IACrB,SAAS,cAAc;IACvB,KAAK,UAAU;IACf,MAAM,WAAW;IACjB,OAAO,YAAY;IACnB,MAAM,WAAW;IACjB,OAAO,YAAY;IACnB,OAAO,YAAY;CACpB;AAGD,oBAAY,QAAQ;IAClB,MAAM,WAAW;IACjB,MAAM,WAAW;CAClB;AAGD,oBAAY,YAAY;IACtB,QAAQ,aAAa;IACrB,SAAS,cAAc;IACvB,KAAK,UAAU;IACf,KAAK,UAAU;IACf,MAAM,WAAW;IACjB,IAAI,SAAS;IACb,IAAI,SAAS;IACb,KAAK,UAAU;IACf,IAAI,SAAS;IACb,KAAK,UAAU;IACf,QAAQ,aAAa;IACrB,IAAI,SAAS;CACd;AAED;;GAEG;AACH,wBAAgB,QAAQ,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG,MAAM,CAa9D;AAiCD;;;;;;GAMG;AACH,qBACa,YAAa,SAAQ,UAAU;IAC1C;;OAEG;IAEI,QAAQ,EAAE,OAAO,CAAS;IAEjC;;OAEG;IAEI,UAAU,CAAC,EAAE,MAAM,CAAiB;IAE3C;;OAEG;IAEI,QAAQ,EAAE,OAAO,CAAS;IAEjC;;OAEG;IAEI,KAAK,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IAEI,YAAY,EAAE,WAAW,CAAuB;IAEvD;;OAEG;IAEI,WAAW,EAAE,MAAM,CAAsB;IAEhD;;OAEG;IAEI,SAAS,EAAE,MAAM,CAAK;IAE7B;;OAEG;IAEI,KAAK,EAAE,OAAO,CAAS;IAE9B;;OAEG;IAEI,YAAY,EAAE,MAAM,CAAK;IAEhC;;OAEG;IAEI,IAAI,EAAE,OAAO,CAAS;IAE7B;;OAEG;IAEI,IAAI,EAAE,QAAQ,CAAmB;IAExC;;OAEG;IAEI,mBAAmB,EAAE,MAAM,CAAmB;IAErD;;OAEG;IAEI,QAAQ,EAAE,KAAK,CAAS;IAE/B;;OAEG;IAGI,MAAM,EAAE,GAAG,CAAC;IAEnB;;OAEG;IAEI,KAAK,EAAE,MAAM,CAAK;IAEzB;;OAEG;IAEI,GAAG,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IAEI,UAAU,CAAC,EAAE,OAAO,CAAC;IAE5B;;OAEG;IAEH,SAAS,CAAC,SAAS,EAAG,WAAW,CAAC;IAElC,OAAO,CAAC,GAAG,CAA+C;IAG1D,OAAO,CAAC,OAAO,CAAC,CAAM;IAEtB,OAAO,CAAC,UAAU,CAAC,CAAM;IAEzB,OAAO,CAAC,QAAQ,CAAa;IAE7B;;OAEG;IACU,IAAI,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM;IA6DtC;;OAEG;IACI,SAAS,IAAI,GAAG;IAIvB;;OAEG;IACI,IAAI;IAWX;;OAEG;IACI,KAAK,IAAI,IAAI;IAWpB;;OAEG;IACI,IAAI,IAAI,IAAI;IAYnB;;OAEG;IACI,OAAO,IAAI,IAAI;IAYtB;;OAEG;IACI,IAAI,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI;IA8BzC;;;;OAIG;IACI,QAAQ,CAAC,QAAQ,GAAE,OAAc,GAAG,MAAM,GAAG,IAAI;IAyBxD;;;;OAIG;IACI,QAAQ,CAAC,KAAK,SAAI,GAAG,IAAI;IAQhC;;;;OAIG;IACI,YAAY,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI;IAQxC;;;;OAIG;IACI,UAAU,CAAC,KAAK,EAAE,OAAO,GAAG,IAAI;IAOvC;;OAEG;IACI,UAAU,IAAI,IAAI;IAMzB;;OAEG;IACI,aAAa,IAAI,IAAI;IAI5B;;OAEG;IACI,MAAM;IAQb;;OAEG;IACH,MAAM,KAAK,MAAM,4BAEhB;IAED;;OAEG;IACI,oBAAoB,IAAI,IAAI;IAsB5B,MAAM,IAAI,cAAc,GAAG,IAAI;IA0BtC;;OAEG;IACH,SAAS,CAAC,YAAY,IAAI,IAAI;IAgC9B,SAAS,CAAC,cAAc,IAAI,cAAc;IA4F1C;;OAEG;IACH,OAAO,CAAC,mBAAmB;IAQ3B;;OAEG;IACH,OAAO,CAAC,iBAAiB;IAUzB,OAAO,CAAC,qBAAqB;IA8G7B;;;;OAIG;IACH,OAAO,CAAC,MAAM;CAUf"}
+{"version":3,"file":"lottie-player.d.ts","sourceRoot":"","sources":["../src/lottie-player.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,UAAU,EAAQ,MAAM,KAAK,CAAC;AAEvC,OAAO,EAAE,cAAc,EAAE,MAAM,aAAa,CAAC;AAO7C,oBAAY,WAAW;IACrB,SAAS,cAAc;IACvB,KAAK,UAAU;IACf,MAAM,WAAW;IACjB,OAAO,YAAY;IACnB,MAAM,WAAW;IACjB,OAAO,YAAY;IACnB,OAAO,YAAY;CACpB;AAGD,oBAAY,QAAQ;IAClB,MAAM,WAAW;IACjB,MAAM,WAAW;CAClB;AAGD,oBAAY,YAAY;IACtB,QAAQ,aAAa;IACrB,SAAS,cAAc;IACvB,KAAK,UAAU;IACf,KAAK,UAAU;IACf,MAAM,WAAW;IACjB,IAAI,SAAS;IACb,IAAI,SAAS;IACb,KAAK,UAAU;IACf,IAAI,SAAS;IACb,KAAK,UAAU;IACf,QAAQ,aAAa;IACrB,IAAI,SAAS;CACd;AAED;;GAEG;AACH,wBAAgB,QAAQ,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG,MAAM,CAa9D;AAiCD;;;;;;GAMG;AACH,qBACa,YAAa,SAAQ,UAAU;IAC1C;;OAEG;IAEI,QAAQ,EAAE,OAAO,CAAS;IAEjC;;OAEG;IAEI,UAAU,CAAC,EAAE,MAAM,CAAiB;IAE3C;;OAEG;IAEI,QAAQ,EAAE,OAAO,CAAS;IAEjC;;OAEG;IAEI,KAAK,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IAEI,YAAY,EAAE,WAAW,CAAuB;IAEvD;;OAEG;IAEI,WAAW,EAAE,MAAM,CAAsB;IAEhD;;OAEG;IAEI,SAAS,EAAE,MAAM,CAAK;IAE7B;;OAEG;IAEI,KAAK,EAAE,OAAO,CAAS;IAE9B;;OAEG;IAEI,YAAY,EAAE,MAAM,CAAK;IAEhC;;OAEG;IAEI,IAAI,EAAE,OAAO,CAAS;IAE7B;;OAEG;IAEI,IAAI,EAAE,QAAQ,CAAmB;IAExC;;OAEG;IAEI,mBAAmB,EAAE,MAAM,CAAmB;IAErD;;OAEG;IAEI,QAAQ,EAAE,KAAK,CAAS;IAE/B;;OAEG;IAGI,MAAM,EAAE,GAAG,CAAC;IAEnB;;OAEG;IAEI,KAAK,EAAE,MAAM,CAAK;IAEzB;;OAEG;IAEI,GAAG,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IAEI,UAAU,CAAC,EAAE,OAAO,CAAC;IAE5B;;OAEG;IAEH,SAAS,CAAC,SAAS,EAAG,WAAW,CAAC;IAElC,OAAO,CAAC,GAAG,CAA+C;IAG1D,OAAO,CAAC,OAAO,CAAC,CAAM;IAEtB,OAAO,CAAC,UAAU,CAAC,CAAM;IAEzB,OAAO,CAAC,QAAQ,CAAa;IAE7B;;OAEG;IACU,IAAI,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM;IA6DtC;;OAEG;IACI,SAAS,IAAI,GAAG;IAIvB;;OAEG;IACI,IAAI;IAWX;;OAEG;IACI,KAAK,IAAI,IAAI;IAWpB;;OAEG;IACI,IAAI,IAAI,IAAI;IAYnB;;OAEG;IACI,OAAO,IAAI,IAAI;IAYtB;;OAEG;IACI,IAAI,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI;IA8BzC;;;;OAIG;IACI,QAAQ,CAAC,QAAQ,GAAE,OAAc,GAAG,MAAM,GAAG,IAAI;IAyBxD;;;;OAIG;IACI,QAAQ,CAAC,KAAK,SAAI,GAAG,IAAI;IAQhC;;;;OAIG;IACI,YAAY,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI;IAQxC;;;;OAIG;IACI,UAAU,CAAC,KAAK,EAAE,OAAO,GAAG,IAAI;IAOvC;;OAEG;IACI,UAAU,IAAI,IAAI;IAMzB;;OAEG;IACI,aAAa,IAAI,IAAI;IAI5B;;OAEG;IACI,MAAM;IAQb;;OAEG;IACH,MAAM,KAAK,MAAM,4BAEhB;IAED;;OAEG;IACI,oBAAoB,IAAI,IAAI;IAyB5B,MAAM,IAAI,cAAc,GAAG,IAAI;IA0BtC;;OAEG;IACH,SAAS,CAAC,YAAY,IAAI,IAAI;IAgC9B,SAAS,CAAC,cAAc,IAAI,cAAc;IA4F1C;;OAEG;IACH,OAAO,CAAC,mBAAmB;IAQ3B;;OAEG;IACH,OAAO,CAAC,iBAAiB;IAUzB,OAAO,CAAC,qBAAqB;IA8G7B;;;;OAIG;IACH,OAAO,CAAC,MAAM;CAUf"}