vue3-useanimations

vue3-useanimations is a collection of free animated open source icons for vue.js.

Installation

Using Yarn:

1yarn add vue3-useanimations

or using NPM:

1npm install -S vue3-useanimations

Usage

Basic usage

1import CreateApp from 'vue';
2import UseAnimations from 'vue3-useanimations';
3// EVERY ANIMATION NEEDS TO BE IMPORTED FIRST -> YOUR BUNDLE WILL INCLUDE ONLY WHAT IT NEEDS
4import github from 'vue3-useanimations/dist/types/lib/github'
5
6const App = () => <UseAnimations animation={github} />;
7
8export default App;

Icons can be configured with inline props:

1<UseAnimations animation={github} size={56} wrapperStyle={{ padding: 100 }} />

These props are available:

Prop	Default	Definition
animation	/	animation file
size	24	animation size
strokeColor	'inherit'	animation stroke color
fillColor	''	animation fill color
wrapperStyle	{}	wrapper div styles
pathCss	''	css string for the animation path element
reverse	false	assing to true when eg. checkbox should be checked initally
autoplay	false*	false except in animations like loading etc.
loop	false*	false except in animations like loading etc.
options	{}	provide any other custom options which will override the default ones
speed	1	a number to determine the speed of lottie(1 is normal speed)
effectType	-	`'CLICK_PLAY_AND_SEGMENTS'

expose

1// use custom style
2ref.value.animationId

Controlled checkbox example

1<template>
2  <div style="padding: 20px ">
3    <span>radioButton</span>
4    <UseAnimations
5      :reverse="checked"
6      @click="handleClick"
7      :size="40"
8      :wrapperStyle="{ marginTop: '5px' }"
9      :animation="radioButton"
10    />
11  </div>
12</template>
13
14<script lang='ts' setup>
15import { ref } from 'vue'
16import { UseAnimations } from 'vue3-useanimations'
17import radioButton from 'vue3-useanimations/dist/types/lib/radioButton'
18
19const checked = ref(false)
20
21const handleClick = () => {
22  checked.value = !checked.value
23}
24</script>
25

Animation wrapped in element (use render prop).

1
2<template>
3
4  <UseAnimations
5    :animation={heart}
6    :size="60"
7    @click="handleClick"
8    :render="renderFunc"
9  >
10  </UseAnimations>
11</template>
12
13<script lang='ts' setup>
14import { h } from 'vue'
15import { UseAnimations } from 'vue3-useanimations'
16import heart from 'vue3-useanimations/dist/types/lib/heart'
17
18const renderFunc = (eventProps: any, animationProps: any) => {
19  return h('button', {
20    style: { padding: '20px' },
21    type: 'button',
22    ...eventProps
23  }, h('div', { ...animationProps }))
24}
25
26const handleClick = () => {
27  console.log('additional onClick cb is working');
28}
29</script>
30

Note that eventProps consists of onClick, mouseOver and other DOM events which you probably want to assign to your wrapping element (e.g. Button) and animationProps consist of an actual animation which you should spread inside a simple <div>