https://github.com/lottiefiles/lottie-vue
Lottie player wrapper for Vue.js
https://github.com/lottiefiles/lottie-vue
javascript vuejs
Last synced: about 1 year ago
JSON representation
Lottie player wrapper for Vue.js
- Host: GitHub
- URL: https://github.com/lottiefiles/lottie-vue
- Owner: LottieFiles
- Created: 2020-08-24T00:05:09.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2024-03-27T18:37:57.000Z (about 2 years ago)
- Last Synced: 2024-04-28T03:44:39.934Z (about 2 years ago)
- Topics: javascript, vuejs
- Language: Vue
- Homepage: https://github.com/lottiefiles/lottie-vue
- Size: 5.48 MB
- Stars: 103
- Watchers: 9
- Forks: 16
- Open Issues: 18
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
## LottiePlayer Vue Component
This is a Vue component for the Lottie Web Player. This library is a vue wrapper around the LottieFiles Lottie Web Player
#### In Javascript or TypeScript:
1. Install package using npm or yarn.
```shell
npm install --save @lottiefiles/vue-lottie-player
```
2. Import package in your code.
```javascript
import LottieVuePlayer from "@lottiefiles/vue-lottie-player";
```
3. Add the player as a plugin to Vue
``` javascript
Vue.use(LottieVuePlayer);
```
#### With Nuxt:
1. Install package using npm or yarn.
```shell
npm install --save @lottiefiles/vue-lottie-player
```
2. Create a folder called 'plugins' at the root of your project
3. Create a file named 'lottie-vue-player.client.js' inside the 'plugins' directory
4. Inside this file put :
```javascript
import Vue from 'vue';
import LottieVuePlayer from "@lottiefiles/vue-lottie-player";
Vue.use(LottieVuePlayer);
```
5. Add to nuxt.config.js:
```javascript
plugins: [
"~/plugins/lottie-vue-player.client.js"
]
```
---
## Example/Development
1. Clone repo
2. run yarn install
## Usage
### Player component
Add the element `lottie-vue-player` and set the `src` prop to a URL pointing to a valid Lottie JSON. Full example of an App.vue file is shown below.
```vue
export default {
name: 'App',
data() {
return {
options: {
minimizable: false,
playerSize: "standard",
backgroundColor: '#fff',
backgroundStyle: 'color',
theme: {
controlsView: "standard",
active: "light",
light: {
color: '#3D4852',
backgroundColor: '#fff',
opacity: '0.7',
},
dark: {
color: '#fff',
backgroundColor: '#202020',
opacity: '0.7',
}
}
}
}
}
}
```
## Props
| Prop | Description | Type | Default |
| -------------------- | ---------------------------------------------------------------------- | ------------------ | ----------- |
| `autoplay` | Autoplay animation on load. | `boolean` | `false` |
| `backgroundColor` | Background color. | `string` | `undefined` |
| `playerControls` | Show controls. | `boolean` | `false` |
| `showColorPicker` | Show color picker | `boolean` | `false` |
| `playerSize` | Player set size (hide, minimal, standard) | `string` | `standard` |
| `loop` | Whether to loop animation. | `boolean` | `false` |
| `speed` | Animation speed. | `number` | `1` |
| `style` | The style for the container. | `object` | `undefined` |
| `src` _(required)_ | Bodymovin JSON data or URL to JSON. | `object` | `string`| `undefined` |
## Methods
### `togglePlayPause() => void`
Toggle animation play pause.
#### Returns
Type: `void`
### `toggleFullscreen() => void`
Toggle full screen player.
#### Returns
Type: `void`
### `toggleLoop() => void`
Toggle animation loop.
#### Returns
Type: `void`
### `setPlayerSpeed(speed?: number) => void`
Sets animation play speed.
#### Parameters
| Name | Type | Description |
| ------- | -------- | --------------- |
| `value` | `number` | Playback speed. |
#### Returns
Type: `void`
### `stop() => void`
Stops animation play.
#### Returns
Type: `void`
### `setBackgroundColor(color: string) => void`
set background color.
#### Returns
Type: `void`
## Contributing
We use changesets to maintain a changelog for this repository. When making any change to the codebase that impacts functionality or performance we require a changeset to be present.
To add a changeset run:
```
yarn run changeset
```
And select the type of version bump you'd like (major, minor, path).
You can document the change in detail and format it properly using Markdown by opening the ".md" file that the "yarn changeset" command created in the ".changeset" folder. Open the file, it should look something like this:
```
---
"@lottiefiles/pkg1": minor
"@lottiefiles/pkg2": major
---
This is where you document your **changes** using Markdown.
- You can write
- However you'd like
- In as much detail as you'd like
Aim to provide enough details so that team mates and future you can understand the changes and the context of the change.
```
You can commit your changes and the changeset to your branch and then create a pull request on the develop branch.
## License
MIT License © LottieFiles.com