@empathyco/x-components
Version:
Empathy X Components
82 lines (59 loc) • 2.27 kB
Markdown
---
title: CrossFade
---
# CrossFade
Renders a transition wrapping the element passed in the default slot. The transition
fades between the two toggled elements at the same time.
## Props
| Name | Description | Type | Default |
| ------------------- | ------------------------------------------------------------------------------ | -------------------- | ----------------- |
| <code>appear</code> | Indicates if the transition must be applied on the initial render of the node. | <code>boolean</code> | <code>true</code> |
## Slots
| Name | Description | Bindings<br />(name - type - description) |
| -------------------- | ------------------------------------------- | ----------------------------------------- |
| <code>default</code> | (Required) to add content to the transition | None |
## Examples
The `CrossFade` component is intended to be used as an animation to wrap an element with `v-if` or `v-show` and animate it. The animation fades the new element into the previous one.
### Basic usage with `v-if`
```vue
<template>
<CrossFade>
<ComponentOrElement v-if="open" />
</CrossFade>
</template>
<script setup>
import { ref } from "vue";
import CrossFade from "@empathyco/x-components/js/components/animations/cross-fade.vue";
const open = ref(false);
</script>
```
### Usage with `v-show`
```vue
<template>
<CrossFade>
<ComponentOrElement v-show="open" />
</CrossFade>
</template>
<script setup>
import { ref } from "vue";
import CrossFade from "@empathyco/x-components/js/components/animations/cross-fade.vue";
const open = ref(true);
</script>
```
### Example with dynamic content
```vue
<template>
<div>
<button @click="open = !open">Toggle</button>
<CrossFade>
<div v-if="open" style="background: #eee;">Expanded content</div>
<div v-else style="background: #ccc;">Collapsed content</div>
</CrossFade>
</div>
</template>
<script setup>
import { ref } from "vue";
import CrossFade from "@empathyco/x-components/js/components/animations/cross-fade.vue";
const open = ref(false);
</script>
```