Skip to content

⬅️ Back to Table of Contents

📄 useElementVisibility/directive

📊 Analysis Summary

Metric Count
📦 Imports 5
🟢 Vue Composition API 3
📑 Type Aliases 3

📚 Table of Contents

🛠️ File Location:

📂 packages/core/useElementVisibility/directive.ts

📦 Imports

Name Source
UseElementVisibilityOptions @vueuse/core
UseElementVisibilityReturn @vueuse/core
useElementVisibility @vueuse/core
createDisposableDirective @vueuse/shared
watch vue

Vue Composition API

Name Type Reactive Variables Composables
watch watch none none
watch watch none none
watch watch none none

Type Aliases

BindingValueFunctionWithoutControls

/* * For backward compatibility, the directive supports two types of binding callbacks: * 1. A function that receives a boolean indicating visibility (without controls) (default). * 2. A function that receives the full state (with controls). /

type BindingValueFunctionWithoutControls = (isVisible: boolean) => void;

BindingValueFunctionWithControls

type BindingValueFunctionWithControls = (state: UseElementVisibilityReturn<true>) => void;

BindingValueArray

type BindingValueArray = [BindingValueFunctionWithoutControls, UseElementVisibilityOptions<false>]
  | [BindingValueFunctionWithControls, UseElementVisibilityOptions<true>];

Generated by Syntax Scribe