Преглед изворни кода

docs(motion): 添加 motion 插件文档

- 创建了 Motion 插件的 README.md 文件
- 添加了插件导出组件和类型的说明表格
- 提供了插件的基本使用示例代码
- 包含了 MotionOptions 和 MotionVariants 类型导入说明
Jin Mao пре 2 месеци
родитељ
комит
4c320346c3
1 измењених фајлова са 26 додато и 0 уклоњено
  1. 26 0
      packages/effects/plugins/src/motion/README.md

+ 26 - 0
packages/effects/plugins/src/motion/README.md

@@ -0,0 +1,26 @@
+# Motion Plugin
+
+基于 @vueuse/motion 的动画插件。
+
+## 导出
+
+| 导出 | 类型 | 说明 |
+|------|------|------|
+| `Motion` | 组件 | 动画组件 |
+| `MotionGroup` | 组件 | 动画组组件 |
+| `MotionDirective` | 指令 | 动画指令 |
+| `MotionPlugin` | 插件 | Vue 插件 |
+
+## 使用
+
+```ts
+import { MotionPlugin, Motion, MotionDirective } from '@vben/plugins/motion';
+
+app.use(MotionPlugin);
+```
+
+## 类型
+
+```ts
+import type { MotionOptions, MotionVariants } from '@vben/plugins/motion';
+```