Please see About Vapor Mode section below for details.
on()
and off()
calls maintains correct active scope (#12641) (679cbdf)Vapor Mode is a new compilation mode for Vue Single-File Components (SFC) with the goal of reducing baseline bundle size and improved performance. It is 100% opt-in, and supports a subset of existing Vue APIs with mostly identical behavior.
Vapor Mode has demonstrated the same level of performance with Solid and Svelte 5 in 3rd party benchmarks.
General Stability NotesVapor Mode is available starting in Vue 3.6 alpha. Please note it is still incomplete and unstable during the alpha phase. The current focus is making it available for wider stability and compatibility testing. For now, we recommend using it for the following cases:
We do not recommend migrating eixsting components to Vapor Mode yet.
Pending FeaturesThings that do not work in this version yet:
Features marked with * have pending PRs which will be merged during the alpha phase.
Opting in to Vapor ModeVapor Mode only works for Single File Components using <script setup>
. To opt-in, add the vapor
attribute to <script setup>
:
<script setup vapor> // ... </script>
Vapor Mode components are usable in two scenarios:
Inside a Vapor app instance create via createVaporApp
. Apps created this way avoids pulling in the Virtual DOM runtime code and allows bundle baseline size to be drastically reduced.
To use Vapor components in a VDOM app instance created via createApp
, the vaporInteropPlugin
must be installed:
import { createApp, vaporInteropPlugin } from 'vue' import App from './App.vue' createApp(App) .use(vaporInteropPlugin) // enable vapor interop .mount('#app')
A Vapor app instance can also install vaporInteropPlugin
to allow vdom components to be used inside, but it will pull in the vdom runtime and offset the benefits of a smaller bundle.
When the interop plugin is installed, Vapor and non-Vapor components can be nested inside each other. This currently covers standard props, events, and slots usage, but does not yet account for all possible edge cases. For example, there will most likely still be rough edges when using a VDOM-based component library in Vapor Mode.
This is expected to improve over time, but in general, we recommend having distinct "regions" in your app where it's one mode or another, and avoid mixed nesting as much as possible.
In the future, we may provide support tooling to enforce Vapor usage boundaries in codebases.
Feature CompatibilityBy design, Vapor Mode supports a subset of existing Vue features. For the supported subset, we aim to deliver the exact same behavior per API specifications. At the same time, this means there are some features that are explicitly not supported in Vapor Mode:
app.config.globalProperties
getCurrentInstance()
returns null
in Vapor components$slots
and $props
are not available in Vapor template expressions@vue:xxx
per-element lifecycle eventsCustom directives in Vapor also have a different interface:
type VaporDirective = ( node: Element | VaporComponentInstance, value?: () => any, argument?: string, modifiers?: DirectiveModifiers, ) => (() => void) | void
value
is a reactive getter that returns the binding value. The user can set up reactive effects using watchEffect
(auto released when component unmounts), and can optionally return a cleanup function. Example:
const MyDirective = (el, source) => { watchEffect(() => { el.textContent = source() }) return () => console.log('cleanup') }Behavior Consistency
Vapor Mode attempts to match VDOM Mode behavior as much as possible, but there could still be minor behavior inconsistencies in edge cases due to how fundamentally different the two rendering modes are. In general, we do not consider a minor inconsistency to be breaking change unless the behavior has previously been documented.
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4