vapor-chamber API reference - v1.16.0
    Preparing search index...

    Function defineVaporCustomElement

    • defineVaporCustomElement — create a custom element backed by Vapor rendering.

      Wraps Vue's defineVaporCustomElement() (introduced in 3.6.0-alpha.4, #14017). The generated custom element uses Vapor's compiler-optimized rendering instead of the VDOM, giving zero-overhead DOM updates inside shadow DOM. Safe to call with a reused options object, and children re-render on reactive prop changes (beta.14+; per-beta detail: CHANGELOG / whitepaper alignment log).

      Returns null if the Vapor runtime (Vue 3.6+) is not detected — check before calling customElements.define().

      Type Parameters

      • T = any

      Parameters

      • options: object
      • OptionalextraOptions: object

      Returns T | null

      import { defineVaporCustomElement } from 'vapor-chamber';
      const MyEl = defineVaporCustomElement({
      props: { label: String },
      setup(props) { return () => h('span', props.label); }
      });
      if (MyEl) customElements.define('vc-greeting', MyEl);