@lottiefiles/lottie-player 1.3.1 → 1.4.3

Sign up to get free protection for your applications and to get access to all the features.
package/CHANGELOG.md CHANGED
@@ -3,6 +3,27 @@ All notable changes to this project will be documented in this file.
3
3
  The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/) and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html), enforced with [semantic-release](https://github.com/semantic-release/semantic-release).
4
4
 
5
5
 
6
+ ## [1.2.1](https://github.com/LottieFiles/lottie-player/compare/v1.2.0...v1.2.1) (2021-09-30)
7
+
8
+
9
+ ### Bug Fixes
10
+
11
+ * **safari fix:** safari height width inherit to container, eslint error fixes ([8c96be5](https://github.com/LottieFiles/lottie-player/commit/8c96be586d3128833d264f2c75511b4d03e95289))
12
+
13
+ # [1.2.0](https://github.com/LottieFiles/lottie-player/compare/v1.1.4...v1.2.0) (2021-09-21)
14
+
15
+
16
+ ### Features
17
+
18
+ * **events and cleanup:** added event listeners before json error check and added a destroy method for cleanup ([646d63b](https://github.com/LottieFiles/lottie-player/commit/646d63b14e89a2c0079ddc9224fc8d8e97d84806))
19
+
20
+ ## [1.1.4](https://github.com/LottieFiles/lottie-player/compare/v1.1.3...v1.1.4) (2021-09-02)
21
+
22
+
23
+ ### Bug Fixes
24
+
25
+ * **rollback:** rollback due to race condition issues ([556307f](https://github.com/LottieFiles/lottie-player/commit/556307fc57a807c03ad1b3639c3e464d73cd87be))
26
+
6
27
  ## [1.1.3](https://github.com/LottieFiles/lottie-player/compare/v1.1.2...v1.1.3) (2021-09-02)
7
28
 
8
29
 
package/README.md CHANGED
@@ -254,7 +254,7 @@ declare namespace JSX {
254
254
  | `loop` | `loop` | Whether to loop animation. | `boolean` | `false` |
255
255
  | `mode` | `mode` | Play mode. | `PlayMode.Bounce \| PlayMode.Normal` | `PlayMode.Normal` |
256
256
  | `preserveAspectRatio` | `preserveAspectRatio` | Valid preserve aspect ratio value. | `string` | `'xMidYMid meet'` |
257
- | `renderer` | `renderer` | Renderer to use. | `"svg" | "canvas"` |
257
+ | `renderer` | `renderer` | Renderer to use. | `"svg" \| "canvas"` | `"svg"` |
258
258
  | `speed` | `speed` | Animation speed. | `number` | `1` |
259
259
  | `src` _(required)_ | `src` | Bodymovin JSON data or URL to JSON. | `string` | `undefined` |
260
260
 
@@ -1,5 +1,6 @@
1
1
  import { LitElement, TemplateResult } from "lit-element";
2
2
  export declare enum PlayerState {
3
+ Destroyed = "destroyed",
3
4
  Error = "error",
4
5
  Frozen = "frozen",
5
6
  Loading = "loading",
@@ -13,6 +14,7 @@ export declare enum PlayMode {
13
14
  }
14
15
  export declare enum PlayerEvents {
15
16
  Complete = "complete",
17
+ Destroyed = "destroyed",
16
18
  Error = "error",
17
19
  Frame = "frame",
18
20
  Freeze = "freeze",
@@ -36,14 +38,6 @@ export declare function parseSrc(src: string | object): string | object;
36
38
  * @extends {LitElement}
37
39
  */
38
40
  export declare class LottiePlayer extends LitElement {
39
- /**
40
- * Animation container.
41
- */
42
- protected container: HTMLElement;
43
- /**
44
- * Play mode.
45
- */
46
- mode: PlayMode;
47
41
  /**
48
42
  * Autoplay animation on load.
49
43
  */
@@ -60,6 +54,14 @@ export declare class LottiePlayer extends LitElement {
60
54
  * Number of times to loop animation.
61
55
  */
62
56
  count?: number;
57
+ /**
58
+ * Player state.
59
+ */
60
+ currentState: PlayerState;
61
+ /**
62
+ * Animation speed.
63
+ */
64
+ description: string;
63
65
  /**
64
66
  * Direction of animation.
65
67
  */
@@ -68,10 +70,18 @@ export declare class LottiePlayer extends LitElement {
68
70
  * Whether to play on mouse hover
69
71
  */
70
72
  hover: boolean;
73
+ /**
74
+ * Intermission
75
+ */
76
+ intermission: number;
71
77
  /**
72
78
  * Whether to loop animation.
73
79
  */
74
80
  loop: boolean;
81
+ /**
82
+ * Play mode.
83
+ */
84
+ mode: PlayMode;
75
85
  /**
76
86
  * Aspect ratio to pass to lottie-web.
77
87
  */
@@ -80,6 +90,10 @@ export declare class LottiePlayer extends LitElement {
80
90
  * Renderer to use.
81
91
  */
82
92
  renderer: "svg";
93
+ /**
94
+ * seeker
95
+ */
96
+ seeker: any;
83
97
  /**
84
98
  * Animation speed.
85
99
  */
@@ -89,27 +103,13 @@ export declare class LottiePlayer extends LitElement {
89
103
  */
90
104
  src?: string;
91
105
  /**
92
- * Player state.
93
- */
94
- currentState: PlayerState;
95
- seeker: any;
96
- intermission: number;
97
- /**
98
- * Animation speed.
106
+ * Animation container.
99
107
  */
100
- description: string;
108
+ protected container: HTMLElement;
101
109
  private _io;
102
110
  private _lottie?;
103
111
  private _prevState?;
104
112
  private _counter;
105
- /**
106
- * Handle visibility change events.
107
- */
108
- private _onVisibilityChange;
109
- /**
110
- * Handles click and drag actions on the progress track.
111
- */
112
- private _handleSeekChange;
113
113
  /**
114
114
  * Configure and initialize lottie-web player instance.
115
115
  */
@@ -130,6 +130,10 @@ export declare class LottiePlayer extends LitElement {
130
130
  * Stops animation play.
131
131
  */
132
132
  stop(): void;
133
+ /**
134
+ * Destroy animation and lottie-player element.
135
+ */
136
+ destroy(): void;
133
137
  /**
134
138
  * Seek to a given frame.
135
139
  */
@@ -140,12 +144,6 @@ export declare class LottiePlayer extends LitElement {
140
144
  * If 'download' argument is boolean true, then a download is triggered in browser.
141
145
  */
142
146
  snapshot(download?: boolean): string | void;
143
- /**
144
- * Freeze animation play.
145
- * This internal state pauses animation and is used to differentiate between
146
- * user requested pauses and component instigated pauses.
147
- */
148
- private freeze;
149
147
  /**
150
148
  * Sets animation play speed.
151
149
  *
@@ -180,15 +178,30 @@ export declare class LottiePlayer extends LitElement {
180
178
  * Returns the styles for the component.
181
179
  */
182
180
  static get styles(): import("lit-element").CSSResult;
181
+ /**
182
+ * Cleanup on component destroy.
183
+ */
184
+ disconnectedCallback(): void;
185
+ render(): TemplateResult | void;
183
186
  /**
184
187
  * Initialize everything on component first render.
185
188
  */
186
189
  protected firstUpdated(): void;
190
+ protected renderControls(): TemplateResult;
187
191
  /**
188
- * Cleanup on component destroy.
192
+ * Handle visibility change events.
189
193
  */
190
- disconnectedCallback(): void;
191
- protected renderControls(): TemplateResult;
192
- render(): TemplateResult | void;
194
+ private _onVisibilityChange;
195
+ /**
196
+ * Handles click and drag actions on the progress track.
197
+ */
198
+ private _handleSeekChange;
199
+ private _attachEventListeners;
200
+ /**
201
+ * Freeze animation play.
202
+ * This internal state pauses animation and is used to differentiate between
203
+ * user requested pauses and component instigated pauses.
204
+ */
205
+ private freeze;
193
206
  }
194
207
  //# sourceMappingURL=lottie-player.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"lottie-player.d.ts","sourceRoot":"","sources":["src/lottie-player.ts"],"names":[],"mappings":"AACA,OAAO,EAEL,UAAU,EAIV,cAAc,EACf,MAAM,aAAa,CAAC;AAOrB,oBAAY,WAAW;IACrB,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,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;IAEH,SAAS,CAAC,SAAS,EAAG,WAAW,CAAC;IAElC;;OAEG;IAEI,IAAI,EAAE,QAAQ,CAAmB;IAExC;;OAEG;IAEI,QAAQ,UAAS;IAExB;;OAEG;IAEI,UAAU,CAAC,EAAE,MAAM,CAAiB;IAE3C;;OAEG;IAEI,QAAQ,UAAS;IAExB;;OAEG;IAEI,KAAK,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IAEI,SAAS,SAAK;IAErB;;OAEG;IAEI,KAAK,UAAS;IAErB;;OAEG;IAEI,IAAI,UAAS;IAEpB;;OAEG;IAEI,mBAAmB,EAAE,MAAM,CAAmB;IAErD;;OAEG;IAEI,QAAQ,EAAE,KAAK,CAAS;IAE/B;;OAEG;IAEI,KAAK,SAAK;IAEjB;;OAEG;IAEI,GAAG,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IAEI,YAAY,EAAE,WAAW,CAAuB;IAGhD,MAAM,EAAE,GAAG,CAAC;IAGZ,YAAY,EAAE,MAAM,CAAK;IAEhC;;OAEG;IAEI,WAAW,SAAsB;IAExC,OAAO,CAAC,GAAG,CAA+C;IAG1D,OAAO,CAAC,OAAO,CAAC,CAAM;IAEtB,OAAO,CAAC,UAAU,CAAC,CAAM;IAEzB,OAAO,CAAC,QAAQ,CAAK;IAErB;;OAEG;IACH,OAAO,CAAC,mBAAmB;IAQ3B;;OAEG;IACH,OAAO,CAAC,iBAAiB;IAUzB;;OAEG;IACU,IAAI,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM;IA0JtC;;OAEG;IACI,SAAS,IAAI,GAAG;IAIvB;;OAEG;IACI,IAAI;IAWX;;OAEG;IACI,KAAK,IAAI,IAAI;IAWpB;;OAEG;IACI,IAAI,IAAI,IAAI;IAYnB;;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;IACH,OAAO,CAAC,MAAM;IAWd;;;;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,oCAEhB;IAED;;OAEG;IACH,SAAS,CAAC,YAAY,IAAI,IAAI;IAgC9B;;OAEG;IACI,oBAAoB,IAAI,IAAI;IAmBnC,SAAS,CAAC,cAAc;IAmFxB,MAAM,IAAI,cAAc,GAAG,IAAI;CAoBhC"}
1
+ {"version":3,"file":"lottie-player.d.ts","sourceRoot":"","sources":["src/lottie-player.ts"],"names":[],"mappings":"AACA,OAAO,EAEL,UAAU,EAIV,cAAc,EACf,MAAM,aAAa,CAAC;AAOrB,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;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;IA2DtC;;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;IAWtB;;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,oCAEhB;IAED;;OAEG;IACI,oBAAoB,IAAI,IAAI;IAsB5B,MAAM,IAAI,cAAc,GAAG,IAAI;IAqBtC;;OAEG;IACH,SAAS,CAAC,YAAY,IAAI,IAAI;IAgC9B,SAAS,CAAC,cAAc,IAAI,cAAc;IAmF1C;;OAEG;IACH,OAAO,CAAC,mBAAmB;IAQ3B;;OAEG;IACH,OAAO,CAAC,iBAAiB;IAUzB,OAAO,CAAC,qBAAqB;IAiG7B;;;;OAIG;IACH,OAAO,CAAC,MAAM;CAUf"}