vue-lynx

Welcome to the API reference for vue-lynx, the package that provides the Vue 3 framework for building Lynx apps. For an introduction, see the Getting Started guide.

Vue APIs

Vue Lynx uses Vue 3's @vue/runtime-core directly — the reactivity system, component model, lifecycle hooks, and Composition API are all standard Vue. You can expect these APIs to behave consistently with the official Vue 3 documentation unless otherwise noted below.

This means ref(), reactive(), computed(), watch(), onMounted(), defineComponent(), and all other Vue Composition APIs work exactly as documented on vuejs.org. The only difference is that you import them from vue-lynx instead of vue:

import { ref, computed, onMounted, defineComponent } from 'vue-lynx';

Vue Lynx APIs

The following APIs are specific to Vue Lynx's dual-thread architecture (Background Thread renderer + Main Thread native elements):

Name	Kind
MainThreadRef	Class
createApp	Function
nextTick	Function
runOnBackground	Function
runOnMainThread	Function
transformToWorklet	Function
useMainThreadRef	Function
VueLynxApp	Interface

Built-in Components

Component	Status	Notes
`<Transition>`	Experimental	CSS class-based enter/leave animations. Requires explicit `:duration` prop — `getComputedStyle()` is unavailable from the background thread.
`<TransitionGroup>`	Experimental	Per-child enter/leave animations. Move (FLIP) animations not supported — `getBoundingClientRect()` is unavailable from the background thread.
`<Suspense>`	Supported	Re-exported from Vue. Works with `defineAsyncComponent()`.
`<KeepAlive>`	Supported	Caches inactive component instances. Supports `include`, `exclude`, and `max` props.
`<Teleport>`	Supported	Supports `to="#id"` string selectors only. Direct element refs and non-ID selectors are not yet supported.

Warning

<Transition> and <TransitionGroup> are experimental. Always pass an explicit :duration prop — getComputedStyle() is unavailable from the background thread. Move (FLIP) animations in <TransitionGroup> are not supported.

Vue Re-exports

Standard Vue 3 APIs re-exported from vue-lynx. See Vue.js API Reference for full documentation.

Name	Kind
computed	Function
createPageRoot	Function
customRef	Function
defineAsyncComponent	Function
defineComponent	Function
defineEmits	Function
defineExpose	Function
defineModel	Function
defineOptions	Function
defineProps	Function
defineSlots	Function
effectScope	Function
getCurrentInstance	Function
getCurrentScope	Function
guardReactiveProps	Function
h	Function
hasInjectionContext	Function
inject	Function
isMemoSame	Function
isProxy	Function
isReactive	Function
isReadonly	Function
isRef	Function
isShallow	Function
markRaw	Function
mergeProps	Function
onActivated	Function
onBeforeMount	Function
onBeforeUnmount	Function
onBeforeUpdate	Function
onDeactivated	Function
onErrorCaptured	Function
onMounted	Function
onRenderTracked	Function
onRenderTriggered	Function
onScopeDispose	Function
onUnmounted	Function
onUpdated	Function
onWatcherCleanup	Function
provide	Function
reactive	Function
readonly	Function
ref	Function
shallowReactive	Function
shallowReadonly	Function
shallowRef	Function
toRaw	Function
toRef	Function
toRefs	Function
toValue	Function
Transition	Function
triggerRef	Function
unref	Function
useAttrs	Function
useId	Function
useModel	Function
useSlots	Function
useTemplateRef	Function
watch	Function
watchEffect	Function
watchPostEffect	Function
watchSyncEffect	Function
withDefaults	Function
withModifiers	Function
App	Interface
Component	TypeAlias
ComponentPublicInstance	TypeAlias
Fragment	Variable
KeepAlive	Variable
Suspense	Variable
Teleport	Variable
TransitionGroup	Variable
version	Variable
vModelCheckbox	Variable
vModelRadio	Variable
vModelSelect	Variable
vModelText	Variable
withAsyncContext	Variable

#vue-lynx

#Vue APIs

#Vue Lynx APIs

#Built-in Components

#Vue Re-exports

vue-lynx

Vue APIs

Vue Lynx APIs

Built-in Components

Vue Re-exports