Ark Logo

Presence

Helps control the rendering and unmounting of your content based on a given state.

Examples

By default the child component starts out as hidden and remains hidden after the present state is toggled off. This is useful for situations where the element needs to be hidden initially and continue to stay hidden after its presence is no longer required.

<script setup lang="ts">
import { ref } from 'vue'
import { Presence } from '@ark-ui/vue'

const isPresent = ref(false)
</script>

<template>
  <div>
    <button @click="isPresent = !isPresent">Toggle</button>
    <Presence :present="isPresent">Hidden and Hidden</Presence>
  </div>
</template>

Lazy Mount

To delay the mounting of a child component until the present prop is set to true, use the lazyMount prop:

<script setup lang="ts">
import { ref } from 'vue'
import { Presence } from '@ark-ui/vue'

const isPresent = ref(false)
</script>

<template>
  <div>
    <button @click="isPresent = !isPresent">Toggle</button>
    <Presence :present="isPresent" lazyMount>Hidden and Hidden</Presence>
  </div>
</template>

Unmount on Exit

To remove the child component from the DOM when it's not present, use the unmountOnExit prop:

<script setup lang="ts">
import { ref } from 'vue'
import { Presence } from '@ark-ui/vue'

const isPresent = ref(false)
</script>

<template>
  <div>
    <button @click="isPresent = !isPresent">Toggle</button>
    <Presence :present="isPresent" unmountOnExit>Hidden and Unmounted on Exit</Presence>
  </div>
</template>

Combining Lazy Mount and Unmount on Exit

Both lazyMount and unmountOnExit can be combined for a component to be mounted only when it's present and to be unmounted when it's no longer present:

<script setup lang="ts">
import { ref } from 'vue'
import { Presence } from '@ark-ui/vue'

const isPresent = ref(false)
</script>

<template>
  <div>
    <button @click="isPresent = !isPresent">Toggle</button>
    <Presence :present="isPresent" lazyMount unmountOnExit>
      Lazy Mount and Unmounted on Exit
    </Presence>
  </div>
</template>

API Reference

Presence

PropDefaultType
asChildfalse
boolean

lazyMountfalse
boolean

Whether to enable lazy mounting

present
boolean

Whether the node is present (controlled by the user)

unmountOnExitfalse
boolean

Whether to unmount on exit.

EmitEvent
exitComplete
[]

Function called when the animation ends in the closed state.