@aarsteinmedia/dotlottie-player 5.3.2 → 6.0.1

package/CHANGELOG.md

@@ -7,6 +7,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 Changelog was only added since [3.2.3], so it's not exhaustive. [Please report any missing noteable changes to us](https://github.com/aarsteinmedia/dotlottie-player/issues), and we'll add them promptly.
 
+## [6.0.1] - 22-06-2025
+
+### Changed
+
+- Refactored code to export both full and light version from this package, thereby deprecating `@aarsteinmedia/dotlottie-player-light`. To import light version use `@aarsteinmedia/dotlottie-player/light`.
+
 ## [5.3.2] - 21-06-2025
 
 ### Changed
@@ -299,6 +305,7 @@ Changelog was only added since [3.2.3], so it's not exhaustive. [Please report a
 - Removed dependencies
   - `@lit`
 
+[6.0.1]: https://www.npmjs.com/package/@aarsteinmedia/dotlottie-player/v/6.0.1
 [5.3.2]: https://www.npmjs.com/package/@aarsteinmedia/dotlottie-player/v/5.3.2
 [5.2.4]: https://www.npmjs.com/package/@aarsteinmedia/dotlottie-player/v/5.2.4
 [5.2.0]: https://www.npmjs.com/package/@aarsteinmedia/dotlottie-player/v/5.2.0

package/README.md

@@ -4,7 +4,7 @@
 
 We proudly claim this to be the most versatile, lightweight and efficient Lottie Player Web Component available. It's compatible with server side rendering, and completely framework agnostic.
 
-PS: If you only need to render animations as SVG, and don't need to convert or combine animations on the fly, we've made light version: [@aarsteinmedia/dotlottie-player-light](https://www.npmjs.com/package/@aarsteinmedia/dotlottie-player-light).
+If you only need to render animations as SVGs, don't use any SVG effects like blur or drop shadow, don't use [Expressions](https://helpx.adobe.com/after-effects/using/expression-basics.html), and don't need to be able convert or combine animations on the fly – you can access a light version of this package by importing `@aarsteinmedia/dotlottie-player/light`.
 
 ## Demo
 
@@ -15,16 +15,22 @@ Here is [a demo](https://www.aarstein.media/en/dotlottie-player), running on Nex
 ### In HTML
 
 - Import from CDN:
-
-```xml
-<script src="https://unpkg.com/@aarsteinmedia/dotlottie-player@latest/dist/index.js"></script>
-```
+  - Full version:
+  ```html
+  <script src="https://unpkg.com/@aarsteinmedia/dotlottie-player@latest/dist/unpkg-full.js"></script>
+  ```
+  - Light version:
+  ```html
+  <script src="https://unpkg.com/@aarsteinmedia/dotlottie-player@latest/dist/unpkg-light.js"></script>
+  ```
 
 - Import from node_modules directory:
-
-```xml
-<script src="/node_modules/@aarsteinmedia/dotlottie-player/dist/index.js"></script>
-```
+  - Full version:
+  ```html
+  <script src="/node_modules/@aarsteinmedia/dotlottie-player/dist/unpkg-full.js"></script>
+  ```
+  - Light Version:
+  <script src="/node_modules/@aarsteinmedia/dotlottie-player/dist/unpkg-light.js"></script>
 
 ### In JavaScript or TypeScript
 
@@ -40,6 +46,12 @@ npm install --save @aarsteinmedia/dotlottie-player
 import '@aarsteinmedia/dotlottie-player'
 ```
 
+or:
+
+```javascript
+import '@aarsteinmedia/dotlottie-player/light'
+```
+
 ## Usage
 
 Add the element `dotlottie-player` to your markup and point `src` to a Lottie animation of your choice.
@@ -272,6 +284,7 @@ export default defineNuxtPlugin(({ vueApp }) => {
 
 | Property / Attribute      | Description                                                                                                                   | Type                                     | Default           |
 | ------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------- | ----------------- |
+| `animateOnScroll`         | Animate by scrolling                                                                                                          | `boolean`                                | `false`           |
 | `autoplay`                | Play animation on load                                                                                                        | `boolean`                                | `false`           |
 | `background`              | Background color                                                                                                              | `string`                                 | `undefined`       |
 | `controls`                | Show controls                                                                                                                 | `boolean`                                | `false`           |
@@ -290,8 +303,8 @@ export default defineNuxtPlugin(({ vueApp }) => {
 
 | Method                                                          | Function
 | --------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- |
-| `addAnimation(config: Config[]) => void`                        | Add animation. Triggers download of new dotLottie file.                                                   |
-| `convert() => void`                                             | If the current animation is in JSON format – convert it to dotLottie. Triggers a download in the browser. |
+| `addAnimation(params: AddAnimationParams) => Promise<Result>`   | Add animation. Triggers download of new dotLottie file.                                                   |
+| `convert(params: ConvertParams) => Promise<Result>`             | If the current animation is in JSON format – convert it to dotLottie. Triggers a download in the browser. |
 | `destroy() => void`                                             | Nullify animation and remove element from the DOM.                                                        |
 | `getLottie() => AnimationItem \| null`                          | Returns the lottie-web instance used in the component                                                     |
 | `load(src: string) => void`                                     | Load animation by URL or JSON object                                                                      |