vsimani v1.0.11

这是什么？

这是一个 vue@3.x 的自定义指令。 它用于让元素进行 简单的动画。

你可以用它来做什么？

vSimani : v-simple-animate

使用指南

1. 安装和引入

   //main.ts
   import { createApp } from 'vue';
   import App from './App.vue';
   
   import { vSimani } from 'vsimani';
   const app = createApp(App);
   app.use(vSimani);
   app.mount('#app');

2. 使用

<div v-animate.moveup>
Hello vSimani
</div>

预定义动画

内置了一些常用的简单动画， 通过修饰符指定

用例：

<div
  v-animate.scaleup="{
    duration: 0.3,
    timingFunctionL: 'ease-in',
    iterationCount: 'infinite',
  }"
>
    v-animate
</div>

绑定值 Options

你可以向 v-animate 绑定一个 Options 对象， 它支持以下动画属性：

interface DirectiveBindingValue {
  duration?: number;
  timingFunction?: string;
  delay?: number;
  direction?: string;
  iterationCount?: string;
  fillMode?: string;
}

value: DirectiveBindingValue

• duration 默认值 : 0.3 ,
• fillMode 默认值: both,
• timingFunction 默认值 linear
• 其他：没有默认值

设定预设值

你也可以通过以下方式去设定全局的预设值，这样，如果你不额外绑定 Options 选项， 那么将会应用你所定义的全局默认配置：

// main.ts, 示例：定义全局动画函数预设为一个贝塞尔曲线，定义默认的动画时长为1.2s
import { createApp } from 'vue';
import './style.css';
import App from './App.vue';

import { vSimani, setDefaultOptions, registerAnimation } from 'vsimani';

setDefaultOptions({ duration:1.2, timingFunction: 'cubic-bezier(0, 0.78, 0.1, 0.95)' });

registerAnimation({
  rotate: 'v-animate-rotate',
  movedown: 'v-animate-movedown',
});
import './user/custom.css';



const app = createApp(App);
app.use(vSimani);
app.mount('#app');

定义你自己的修饰符

在实际项目使用中，更多时候你可能需要定义自己的修饰符， 本插件暴露了一个注册方法，请依照以下步骤进行。

1. 定义好你的 关键帧动画：

   /* custome.css */
   @keyframes v-animate-rotate {
     from {
       transform: rotate(0);
     }
   
     to {
       transform: rotate(360deg);
     }
   }

2. 在 main.ts 中去引入你的样式文件， 并通过 vsimani 暴露的 registerAnimation 注册方法， 通过一个对象注册你的 指令修饰符和帧动画名的对应关系。

   //main.ts
   import { createApp } from 'vue';
   import App from './App.vue';
   
   // 引入 注册方法
   import { vSimani, registerAnimation } from 'vsimani';
   // 引入你的动画样式
   import './path/to/custom.css';
   
   // 注册你的自定义动画
   // key(修饰符) ， value(自定义动画类名)
   registerAnimation({ rotate: 'v-animate-rotate' });
   
   const app = createApp(App);
   app.use(vSimani);
   app.mount('#app');

   像预定义修饰符一样使用的你自定义动画

   <div
     v-animate.rotate="{
       iterationCount: 'infinite',
       timingFunction: 'linear',
       duration: 2,
     }"
   >
       Rotate Me
   </div>

怎么让动画逆向运行？

对于反向动画， 你无需重新定义， 仅通过指定 direction: 'reverse', 选项即可。

<div
  v-animate.scaleup="{
    duration: 0.3,
    timingFunctionL: 'ease-in',
    direction: 'reverse',
  }"
>
    v-animate
</div>

注意点: :warning:

最终样式状态: 关键帧动画执行到 100% 时的样式状态

如果你没有指定你的动画为 iterationCount:'infinite' , 那么你在应用 v-animate 的时候需要注意一个 最终状态样式的问题

当动画帧从 0% => 100% ， 你所应用的元素， 的指定最终呈现的状态，应该和 100% 关键帧所指定的动画保持一直。 这样才能确保动画流畅，而不会等动画执行完，然后闪到你指定的元素最终样式。

换句话说，就是动画的执行最终

以下是一个示例：

例如，为一个图片做一个从清晰到模糊的动画效果：

有这样的基本解构，

<div
     :style="{
             backgroundImage: `url(http://192.168.0.166:11180/file${avatar})`,
             }"
     class="bg-cover bg-no-repeat h-28 rounded-md"
     >
    <div
         v-animate.cleartoblur="{ duration: 0.8 }"
         class="img-bg-filter h-full flex justify-center items-center backdrop-blur-0"
         ></div>
</div>

注意到： 我们应用 cleartoblur 修时符，

这个动画我们是这样定义的：

@keyframes v-animate-cleartoblur {
  0% {
    backdrop-filter: blur(0);
  }
  100% {
    backdrop-filter: blur(4px);
  }
}

遮罩的模糊度从 0 变到 4px

但是我们使用 tailwindcss 将透明遮罩的最终状态设定为了 backdrop-blur-0, 即 blur:0

这样会出现这样的问题：

为了解决这样的问题， 你应该将 元素的最状态 和 100% 动画关键帧处的状态保持一致：

<div
     :style="{
             backgroundImage: `url(http://192.168.0.166:11180/file${avatar})`,
             }"
     class="bg-cover bg-no-repeat h-28 rounded-md"
     >
    <div
         v-animate.cleartoblur="{ duration: 0.8 }"
         class="img-bg-filter h-full flex justify-center items-center backdrop-blur-sm"
         ></div>
</div>

backdrop-blur-sm (tailwindcss), 即 backdrop-filter: blur(4px)

额外的：怎么构建你自己的动画指令？

如果你希望自己构建一套完整的动画指令， 直接修改源代码即可。

第 1 步：

在 animate/index.ts

const animationNameList = {
  scaleup: 'v-animate-scaleup',
  cleartoblur: 'v-animate-cleartoblur',
  //  为了避免和其他元素类名冲突，这里建议使用`v-animate-`开头命名动画名
};

在 animationNameList 这个数组中添加一个键值对 ， 他们分别是 修饰符：@keyframes 动画的名称

第 2 步：

animate/style.css

添加你的关键帧动画， 注意命名需要和上面的保持一致：