usePresence API

API reference for the usePresence composable.

Explore these related pages for additional context and usage patterns.

(options: UsePresenceOptions) => UsePresenceReturn

Animation-agnostic mount lifecycle management.

MaybeRefOrGetter<boolean>

Drive visibility.

boolean | undefined

Delay first mount until present is first true.

Default: false

boolean | undefined

Auto-resolve LEAVING state next tick if done() not called.

Default: true

Readonly<ShallowRef<PresenceState>>

Current lifecycle state.

Readonly<Ref<boolean, boolean>>

Should the element be in the DOM?

Readonly<Ref<boolean, boolean>>

Is it logically present?

Readonly<Ref<boolean, boolean>>

Is an exit in progress?

() => void

Call when exit animation finishes.