@morev/vue-transitions
无需 CSS 的 Vue 2
和 Vue 3
可复用界面过渡动画 ❤️
✔️ 通过 props 高度可定制;
✔️ 在 group
模式下与网格/弹性布局正确配合;
✔️ 考虑动画元素的初始样式,如 transform
或 opacity
;
✔️ 使用通用的 Nuxt 2
和 Nuxt 3
模块更加易用。
目录
安装
❗ 要求
- Node 版本:
>= 18.0.0
- Nuxt 版本(如果使用):
>= 2.17.0 || >= 3.5.0
如果您使用的 Node 或 Nuxt 版本低于指定版本,则插件将无法工作。
使用 yarn
yarn add @morev/vue-transitions
使用 npm
npm install @morev/vue-transitions
使用 pnpm
pnpm add @morev/vue-transitions
使用 bun
bun add @morev/vue-transitions
❗ **对于 Bun
用户的重要说明**
该软件包依赖于 postinstall
钩子来确定 Vue 版本并提供正确的组件。
默认情况下,Bun 不会执行生命周期钩子,因此要使其工作,您需要在安装后手动将软件包添加到 trustedDependencies
中,然后再次运行 bun install
。
{
"trustedDependencies": ["@morev/vue-transitions"]
}
用法
如果您打算将库与 Nuxt 一起使用,则可以跳过以下段落。
转到“与 Nuxt 配合使用”部分.
软件包导出两个版本的组件
Vue2
的版本可通过命名导出/vue2
获取Vue3
的版本可通过命名导出/vue3
获取
但是,还有一个默认导出映射到正在使用的 Vue 的本地版本。
在底层,它利用了 postinstall npm 钩子。
安装软件包后,脚本将开始检查已安装的 Vue 版本,并根据本地 Vue 版本重定向导出。
感觉非常可靠,但如果您担心,请根据您使用的版本明确使用命名导入。
顺便说一句,您可以在安装后更改默认导出:只需运行命令
vue-transitions-version-switch <version>
- 使用
yarn
的示例:yarn vue-transitions-version-switch 2
- 使用
npx
的示例:npx vue-transitions-version-switch 3
全局注册
使用 Vue3
import { createApp } from 'vue';
import { plugin as vueTransitionsPlugin } from '@morev/vue-transitions';
import '@morev/vue-transitions/styles';
const app = createApp(App);
app.use(vueTransitionsPlugin({
// Plugin options (optional, described below)
}));
使用 Vue2
import Vue from 'vue';
import { plugin as vueTransitionsPlugin } from '@morev/vue-transitions';
import '@morev/vue-transitions/styles';
Vue.use(vueTransitionsPlugin, {
// Plugin options (optional, described below)
});
😥 我收到错误“未找到此依赖项”
对于无法解析 exports
字段的环境(例如 Nuxt 2),只需将样式导入替换为文件的直接路径
- import '@morev/vue-transitions/styles';
+ import '@morev/vue-transitions/dist/index.css';
自定义选项
建议在设置自定义选项时使用命名导出
plugin
而不是默认导出,以获取正确的类型信息。
自定义选项允许更改默认属性值。
要更改默认值,请将 defaultProps
键传递给插件设置,并列出所需属性的键值对。
您也可以按组件更改默认属性,为此,只需将 componentDefaultProps
键传递给插件设置即可。
**重要提示**:这些属性未经过验证,因此请确保使用正确的属性值定义它们。
import { createApp } from 'vue';
import { plugin as vueTransitionsPlugin } from '@morev/vue-transitions';
import '@morev/vue-transitions/styles';
const app = createApp(App);
app.use(vueTransitionsPlugin({
// Default duration for all transitions now is `200`
defaultProps: {
duration: 200,
},
// But for `<transition-expand>` default duration is `500`
componentDefaultProps: {
TransitionExpand: {
duration: 500,
}
}
}));
组件的直接导入
<template>
<transition-fade>
<div v-if="isVisible" class="box">
Fade transition
</div>
</transition-fade>
</template>
<script>
import { TransitionFade } from '@morev/vue-transitions';
export default {
components: { TransitionFade },
};
</script>
与 Nuxt 配合使用
该库通过命名导出 /nuxt
为 Nuxt 2 和 3 导出一个现成的通用模块。
使用 Nuxt 时,建议使用模块而不是手动安装,因为
- Nuxt 允许按需自动导入组件,而不是全局注册,这是一种性能更高的选项。
- 这样做更快 :)
要使用,请将 @morev/vue-transitions/nuxt
添加到 nuxt.config.ts
/ nuxt.config.js
的 modules
部分
export default defineNuxtConfig({
modules: [
'@morev/vue-transitions/nuxt',
],
vueTransitions: {
// The same options as in the plugin itself.
// You will get an autocomplete using Nuxt 3.
}
});
享受您的过渡组件!🎉
智能提示
您可以跳过使用 Nuxt 模块的这一部分 - 它会为您完成。
此部分仅适用于 VSCode 设置和组件的全局注册。
使用 Vue 2
使用安装了 Vetur 扩展的 Vue 2,所有组件都应提供提示,无需任何操作
使用 Vue 3
使用安装了 Volar 扩展的 Vue 3,所有组件都应提供提示,无需任何操作
过渡动画列表
TransitionFade
更改元素 opacity
的基本过渡动画。非常简单。
显示代码
<template>
<transition-fade>
<div v-if="isVisible">...</div>
</transition-fade>
</template>
<script>
import { TransitionFade } from '@morev/vue-transitions';
export default {
components: { TransitionFade },
};
</script>
TransitionExpand
操纵实际元素大小的过渡动画。
如果您年龄足够大,您可能知道此过渡动画,就像 jQuery slideUp/slideDown
。
它也可以与 X
轴一起使用,如 slideLeft
和 slideRight
(尽管我很难想到一个真正需要它的场景)。
具有 唯一属性:axis
TransitionSlide
通过 transform: translate()
操纵元素位置的过渡动画。
它需要 offset
属性来计算所需的元素位置,并且可以与百分比值一起使用。
如何使用 offset
属性的示例
<template>
<!--
Element will fade in and fade out to top.
Initial transform is `transform: translate(0, -16px)`
-->
<transition-slide :offset="[0, -16]"></transition-slide>
<!--
Element will fade in and fade out to bottom left side.
Initial transform is `transform: translate(-16px, 16px)`
-->
<transition-slide :offset="[-16, 16]"></transition-slide>
<!--
Element will fade in and fade out to right,
and the offset will be relative to the element width itself.
Initial transform is `transform: translate(100%, 0)`
-->
<transition-slide :offset="['100%', 0]"></transition-slide>
<!--
Element will fade in from top and fade out to bottom,
and the offset will be relative to the element height itself.
Transform before element appears: `transform: translate(0, -100%)`
Transform when element disappears: `transform: translate(0, 100%)`
-->
<transition-slide
:offset="{
enter: [0, '-100%'],
leave: [0, '100%']
}"
></transition-slide>
</template>
它尊重通过 CSS 应用于元素本身的转换,并将其与定义的偏移量合并。
例如,当您尝试制作居中的下拉菜单时,它非常有用。
👀 显示 `transform` 合并的示例
<template>
<div class="block">
<!--
In this case, given the CSS styles,
initial transform will be calculated to `translate(-50%, -16px)`
-->
<transition-slide :offset="[0, -16]">
<div class="block__dropdown" v-if="isVisible">
...
</div>
</transition-slide>
</div>
</template>
<style>
.block {
position: relative;
}
.block__dropdown {
position: absolute;
top: 100%;
left: 50%;
transform: translateX(-50%);
}
</style>
具有 唯一属性:offset
TransitionScale
操纵元素 transform: scale()
的过渡动画。
默认情况下,它将元素从 scale(1)
缩放至 scale(0)
,但此行为可以通过 :scale
属性进行自定义。
它可以通过 axis 属性与不同的轴一起使用。
具有 唯一属性:scale
、axis
、origin
显示代码示例
<template>
<!--
This element appears in `x` axis and disappears in `y`
-->
<transition-scale :axis="{ enter: 'x', leave: 'y' }"></transition-scale>
<!--
This element behaves like the `transition-expand`,
but touches only `transform` property
-->
<transition-scale transform-origin="50% 0%"></transition-scale>
<!--
This element scales just a little when fading in/out.
-->
<transition-scale :scale=".8"></transition-scale>
</template>
属性
通用属性
这些属性与每个过渡动画相关
group
组件是否应为 transition-group
组件。
export type TransitionGroup = boolean; // Default: false
示例
<template>
<div>
<!--
To animate a list of items, use `group` prop.
⚠️ Don't forget you should pass the `:key` to each item in this case.
-->
<transition-fade group>
<div v-for="item in items" :key="item.id">...</div>
</transition-fade>
</div>
</template>
tag
过渡标签,在使用 transition-group
组件的情况下。
export type TransitionTag = string; // Default: 'span'
示例
<template>
<div>
<!--
Passing the tag renders transition component with it.
It's suitable, for example, for rendering semantic lists:
-->
<transition-fade group tag="ul">
<li v-for="item in items" :key="item.id">...</li>
</transition-fade>
<!-- ✨ Rendered HTML: -->
<ul>
<li>...</li>
<li>...</li>
</ul>
</div>
</template>
appear
是否在节点的初始渲染时应用过渡动画。作用与原始 Vue 过渡 appear 属性 完全相同
export type TransitionAppear = boolean; // Default: undefined
示例
<template>
<div>
<!--
This element appears when mounted if `isVisible` is `true` by default.
-->
<transition-fade appear>
<div v-if="isVisible">...</div>
</transition-fade>
</div>
</template>
mode
过渡模式.
export type TransitionMode = 'in-out' | 'out-in' | undefined; // Default: undefined
示例
<template>
<div>
<!--
Current element transitions out first, then when complete,
the new element transitions in.
-->
<transition-slide mode="out-in">
<component :is="currentComponent">...</component>
</transition-slide>
</div>
</template>
duration
过渡动画持续时间,毫秒。
如果给出对象,则 enter
和 leave
值将分别用于进入和离开过渡动画。
// Default: 300
export type TransitionDuration = number | { enter: number, leave: number }
示例
<template>
<div>
<!--
If single value provided, the passed amount of milliseconds
applied to enter and leave animations both.
This element will appear and disappear within 500ms:
-->
<transition-fade :duration="500">
<div v-if="isVisible">...</div>
</transition-fade>
<!--
If an object given, it SHOULD have `enter` and `leave` keys.
This element appears in 200ms and disappears within 500ms:
-->
<transition-fade :duration="{ enter: 200, leave: 500 }">
<div v-if="isVisible">...</div>
</transition-fade>
</div>
</template>
move-duration
在使用 transition-group
的情况下,元素位置更改的动画持续时间。
尽管 Vue 没有通过属性设置移动动画持续时间的原生方法,但可以使用 CSS 自定义属性 完成此任务。
👀 显示说明
<!-- This way it can be set dynamically -->
<div style="--move-duration: 300ms;">
<div class="scale-move"></div>
<div class="scale-move"></div>
</div>
```
```css
.scale-move {
transition-duration: var(--move-duration, 300ms);
}
```
</details>
```ts
// Default: 300
export type TransitionMoveDuration = number;
delay
过渡动画延迟,毫秒。
如果给出对象,则 enter
和 leave
值将分别用于进入和离开过渡动画。
// Default: 300
export type TransitionDelay = number | { enter: number, leave: number };
示例
<template>
<div>
<!--
If single value provided, then enter and leave animations will wait
for given amount of milliseconds before run.
This element will appear and disappear 100ms after
`isVisible` property changes:
-->
<transition-fade :delay="100">
<div v-if="isVisible">...</div>
</transition-fade>
<!--
If an object given, it SHOULD have `enter` and `leave` keys.
This element appears immediately and disappears 200ms after
`isVisible` property changes:
-->
<transition-fade :duration="{ enter: 0, leave: 300 }">
<div v-if="isVisible">...</div>
</transition-fade>
</div>
</template>
easing
过渡动画缓动函数。应为有效的 CSS 过渡时序函数。
如果给出对象,则 enter
和 leave
值将分别用于进入和离开过渡动画。
export type TransitionEasing = string; // Default: 'cubic-bezier(.25, .8, .5, 1)'
示例
<template>
<div>
<!--
If single value provided, then enter and leave animations will use it:
-->
<transition-fade easing="ease-out">
<div v-if="isVisible">...</div>
</transition-fade>
<!--
If an object given, it SHOULD have `enter` and `leave` keys.
This element uses custom animation known as `bounce-in` for entering
and simple `ease-out` curve for leaving:
-->
<transition-fade
:easing="{
enter: 'cubic-bezier(0.6, 0, 0.4, 2)',
leave: 'ease-out'
}"
>
<div v-if="isVisible">...</div>
</transition-fade>
</div>
</template>
no-opacity
是否**不**动画元素的 opacity
。
默认情况下,每个过渡动画除了主要属性外还会操作 opacity
。
但是,有时不需要这样做 - 例如,在实现从屏幕边缘出现的模态面板时。
此属性显然不适用于
transition-fade
组件。
export type TransitionNoOpacity = boolean; // Default: false
示例
<template>
<div>
<!--
This panel appears from the right edge of the screen,
while its transparency remains unchanged.
-->
<transition-slide :offset="['100%', 0]" no-opacity>
<div class="panel" v-if="isVisible">...</div>
</transition-slide>
</div>
</template>
<style>
.panel {
position: fixed;
top: 0;
right: 0;
bottom: 0;
background: #ffffff;
width: 400px;
}
</style>
no-move
是否**不**动画元素位置更改,在使用 transition-group
的情况下。
默认情况下,在使用 group
模式时,当删除元素时,其余元素会平滑地更改其位置。
它们被赋予绝对定位并从流中删除,因此父容器的高度会折叠。
通常这不是问题,但有时 - 例如,当使用 transition-expand
并将元素依次放置在彼此下方时,它看起来很粗糙。
使用此选项,您可以在这种情况下获得更愉悦的元素行为。
export type TransitionNoMove = boolean; // Default: false
示例
<template>
<div>
<!--
In this case, the height of the parent element (`ul`) changes smoothly.
-->
<transition-expand group no-move tag="ul">
<li v-for="item in items" :key="item.id">...</li>
</transition-expand>
</div>
</template>
TransitionExpand
的唯一属性
axis
元素应扩展的方向。
如果给出对象,则 enter
和 leave
值将分别用于进入和离开过渡动画。
type ExpandAxisValue = 'x' | 'y'; // Default: 'y'
export type TransitionExpandAxis = ExpandAxisValue | { enter: ExpandAxisValue, leave: ExpandAxisValue }
TransitionSlide
的唯一属性
offset
过渡前后元素在 x
和 y
轴上的偏移量。
应为整数或百分比值的字符串表示形式(例如 '100%'
)。
数字值视为 px
偏移量,以 %
符号结尾的字符串值视为 元素宽度/高度的百分比
。
示例和说明
如果给出对象,则 enter
和 leave
值将分别用于进入和离开过渡动画。
type SlideOffsetValue = [number | string, number | string];
// Default: [0, -16]
export type TransitionSlideOffset = SlideOffsetValue | { enter: SlideOffsetValue, leave: SlideOffsetValue }
TransitionScale
的唯一属性
axis
要动画化的缩放轴。
* `both` (uses `transform: scale()`)
* `x` (uses `transform: scaleX()`)
* `y` (uses `transform: scaleY()`)
如果给出对象,则 enter
和 leave
值将分别用于进入和离开过渡动画。
type ScaleAxisValue = 'x' | 'y' | 'both';
// Default: 'both'
export type TransitionScaleAxis = ScaleAxisValue | { enter: ScaleAxisValue, leave: ScaleAxisValue }
origin
transform-origin
应用于元素的 CSS 属性。\
如果给出对象,则 enter
和 leave
值将分别用于进入和离开过渡动画。
如果给出对象,则 enter
和 leave
值将分别用于进入和离开过渡动画。
// Default: '50% 50%'
export type TransitionScaleAxis = string | { enter: string, leave: string }
scale
过渡前后元素的缩放值。应为 0
和 1
之间的数字。
如果给出对象,则 enter
和 leave
值将分别用于进入和离开过渡动画。
如果给出对象,则 enter
和 leave
值将分别用于进入和离开过渡动画。
// Default: 0
export type TransitionScaleScale = number | { enter: number, leave: number }
事件
组件不提供任何特殊事件,但会触发 所有标准过渡事件
before-enter
enter
after-enter
enter-cancelled
before-leave
leave
after-leave
enter-leave