Skip to content

Commit 2709046

Browse files
committed
docs(updated docs): updated docs
1 parent dcf68b0 commit 2709046

File tree

1 file changed

+1
-17
lines changed

1 file changed

+1
-17
lines changed

README.md

Lines changed: 1 addition & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
## LottiePlayer Vue Component
22

3-
This is a Vue component for the Lottie Web Player
3+
This is a Vue component for the Lottie Web Player. This library is a vue wrapper around the LottieFiles Lottie Web Player
44

55
## Documentation
66

@@ -95,22 +95,6 @@ Add the element `lottie-vue-player` and set the `src` prop to a URL pointing to
9595
| `speed` | Animation speed. | `number` | `1` |
9696
| `style` | The style for the container. | `object` | `undefined` |
9797
| `src` _(required)_ | Bodymovin JSON data or URL to JSON. | `object` | `string`| `undefined` |
98-
## Events
99-
100-
The following events are exposed and can be listened to via `addEventListener` calls.
101-
102-
| Name | Description |
103-
| ---------- | ------------------------------------------------------------------------- |
104-
| `load` | Animation data is loaded. |
105-
| `error` | An animation source cannot be parsed, fails to load or has format errors. |
106-
| `ready` | Animation data is loaded and player is ready. |
107-
| `play` | Animation starts playing. |
108-
| `pause` | Animation is paused. |
109-
| `stop` | Animation is stopped. |
110-
| `freeze` | Animation is paused due to player being invisible. |
111-
| `loop` | An animation loop is completed. |
112-
| `complete` | Animation is complete (all loops completed). |
113-
| `frame` | A new frame is entered. |
11498

11599
## Methods
116100

0 commit comments

Comments
 (0)