@openelement/element 0.41.0-alpha.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +21 -0
- package/README.md +60 -0
- package/package.json +30 -0
- package/src/define-element.d.ts +9 -0
- package/src/define-element.js +43 -0
- package/src/error-boundary.d.ts +54 -0
- package/src/error-boundary.js +125 -0
- package/src/index.d.ts +33 -0
- package/src/index.js +29 -0
- package/src/open-element-hydration.js +120 -0
- package/src/open-element-render.js +91 -0
- package/src/open-element.d.ts +176 -0
- package/src/open-element.js +419 -0
- package/src/types.d.ts +8 -0
- package/src/types.js +4 -0
|
@@ -0,0 +1,91 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Internal rendering helpers for OpenElement.
|
|
3
|
+
*
|
|
4
|
+
* Extracted from open-element.ts to keep the base class focused on its
|
|
5
|
+
* public lifecycle API. These functions are NOT part of the public package
|
|
6
|
+
* surface and should only be consumed by OpenElement itself.
|
|
7
|
+
*
|
|
8
|
+
* @internal
|
|
9
|
+
* @module @openelement/element/open-element-render
|
|
10
|
+
*/ import { renderToDom } from '@openelement/core';
|
|
11
|
+
import { formatError } from '@openelement/core/errors';
|
|
12
|
+
import { createLogger } from '@openelement/core/logger';
|
|
13
|
+
/**
|
|
14
|
+
* Dispose all reactive effects and declarative event listeners created by
|
|
15
|
+
* previous renders or hydration passes.
|
|
16
|
+
*
|
|
17
|
+
* Returns a fresh, empty event-cleanup array so callers can replace their
|
|
18
|
+
* existing bag and avoid retaining stale closures.
|
|
19
|
+
*/ export function disposeRenderBindings(effectDisposers, eventCleanups) {
|
|
20
|
+
for (const d of effectDisposers)d();
|
|
21
|
+
effectDisposers.clear();
|
|
22
|
+
for (const f of eventCleanups)f();
|
|
23
|
+
return [];
|
|
24
|
+
}
|
|
25
|
+
/**
|
|
26
|
+
* CSR render path for light-DOM components.
|
|
27
|
+
*
|
|
28
|
+
* Clears previous bindings, calls render(), caches the result, and mounts the
|
|
29
|
+
* produced DOM into the element itself.
|
|
30
|
+
*/ export function renderIntoLightDom(instance, effectDisposers, eventCleanups, cache) {
|
|
31
|
+
const newEventCleanups = disposeRenderBindings(effectDisposers, eventCleanups);
|
|
32
|
+
const result = instance.render();
|
|
33
|
+
cache.set(result);
|
|
34
|
+
const self = instance;
|
|
35
|
+
while(self.firstChild){
|
|
36
|
+
self.removeChild(self.firstChild);
|
|
37
|
+
}
|
|
38
|
+
if (result != null) {
|
|
39
|
+
self.appendChild(renderToDom(result, undefined, effectDisposers, instance.signalRegistry));
|
|
40
|
+
}
|
|
41
|
+
return newEventCleanups;
|
|
42
|
+
}
|
|
43
|
+
/**
|
|
44
|
+
* CSR render path for shadow-DOM components.
|
|
45
|
+
*
|
|
46
|
+
* Clears previous bindings, calls render(), caches the result, and mounts the
|
|
47
|
+
* produced DOM into the shadow root.
|
|
48
|
+
*/ export function renderIntoShadowRoot(instance, effectDisposers, eventCleanups, cache) {
|
|
49
|
+
const root = instance.shadowRoot;
|
|
50
|
+
if (!root) return eventCleanups;
|
|
51
|
+
const newEventCleanups = disposeRenderBindings(effectDisposers, eventCleanups);
|
|
52
|
+
const result = instance.render();
|
|
53
|
+
cache.set(result);
|
|
54
|
+
if (result != null) {
|
|
55
|
+
while(root.firstChild){
|
|
56
|
+
root.removeChild(root.firstChild);
|
|
57
|
+
}
|
|
58
|
+
root.appendChild(renderToDom(result, undefined, effectDisposers, instance.signalRegistry));
|
|
59
|
+
}
|
|
60
|
+
return newEventCleanups;
|
|
61
|
+
}
|
|
62
|
+
/**
|
|
63
|
+
* Render a fallback VNode when the unified render/hydrate path throws.
|
|
64
|
+
*
|
|
65
|
+
* Ensures the render root exists, invokes onRenderError(), disposes any
|
|
66
|
+
* previous bindings, and mounts the fallback content.
|
|
67
|
+
*/ export function renderErrorFallback(instance, error, effectDisposers, eventCleanups, onRenderError) {
|
|
68
|
+
const ctor = instance.constructor;
|
|
69
|
+
const isLightDom = ctor.renderMode === 'light';
|
|
70
|
+
if (!instance.shadowRoot && !isLightDom) {
|
|
71
|
+
instance.createRenderRoot();
|
|
72
|
+
}
|
|
73
|
+
const target = isLightDom ? instance : instance.shadowRoot;
|
|
74
|
+
if (!target) return [];
|
|
75
|
+
let fallback;
|
|
76
|
+
try {
|
|
77
|
+
fallback = onRenderError(error);
|
|
78
|
+
} catch (fallbackError) {
|
|
79
|
+
createLogger('dsd').error(`<${instance.tagName.toLowerCase()}> onRenderError failed: ${formatError(fallbackError)}`);
|
|
80
|
+
fallback = null;
|
|
81
|
+
}
|
|
82
|
+
const newEventCleanups = disposeRenderBindings(effectDisposers, eventCleanups);
|
|
83
|
+
if (fallback != null) {
|
|
84
|
+
while(target.firstChild){
|
|
85
|
+
target.removeChild(target.firstChild);
|
|
86
|
+
}
|
|
87
|
+
target.appendChild(renderToDom(fallback, undefined, effectDisposers, instance.signalRegistry));
|
|
88
|
+
}
|
|
89
|
+
return newEventCleanups;
|
|
90
|
+
}
|
|
91
|
+
//# sourceMappingURL=data:application/json;base64,{"version":3,"sources":["file:///home/runner/work/openelement/openelement/packages/element/src/open-element-render.ts"],"sourcesContent":["/**\n * Internal rendering helpers for OpenElement.\n *\n * Extracted from open-element.ts to keep the base class focused on its\n * public lifecycle API. These functions are NOT part of the public package\n * surface and should only be consumed by OpenElement itself.\n *\n * @internal\n * @module @openelement/element/open-element-render\n */\n\nimport type { VNode } from '@openelement/protocol/vnode';\nimport { renderToDom } from '@openelement/core';\nimport { formatError } from '@openelement/core/errors';\nimport { createLogger } from '@openelement/core/logger';\nimport type { OpenElement } from './open-element.js';\n\n/**\n * Minimal accessor for the VNode cache stored on an OpenElement instance.\n *\n * The cache lives as true private fields on the class, so helpers interact\n * with it through this small facade instead of trying to access #private\n * state from outside the class body.\n */\nexport interface VNodeCacheAccess {\n  /** Read the current cached VNode and whether it is valid. */\n  get(): { vnode: unknown; valid: boolean };\n  /** Store a VNode and mark the cache valid. */\n  set(vnode: unknown): void;\n}\n\n/**\n * Dispose all reactive effects and declarative event listeners created by\n * previous renders or hydration passes.\n *\n * Returns a fresh, empty event-cleanup array so callers can replace their\n * existing bag and avoid retaining stale closures.\n */\nexport function disposeRenderBindings(\n  effectDisposers: Set<() => void>,\n  eventCleanups: Array<() => void>,\n): Array<() => void> {\n  for (const d of effectDisposers) d();\n  effectDisposers.clear();\n  for (const f of eventCleanups) f();\n  return [];\n}\n\n/**\n * CSR render path for light-DOM components.\n *\n * Clears previous bindings, calls render(), caches the result, and mounts the\n * produced DOM into the element itself.\n */\nexport function renderIntoLightDom(\n  instance: OpenElement,\n  effectDisposers: Set<() => void>,\n  eventCleanups: Array<() => void>,\n  cache: VNodeCacheAccess,\n): Array<() => void> {\n  const newEventCleanups = disposeRenderBindings(effectDisposers, eventCleanups);\n\n  const result = instance.render();\n  cache.set(result);\n\n  const self = instance as HTMLElement;\n  while (self.firstChild) {\n    self.removeChild(self.firstChild);\n  }\n\n  if (result != null) {\n    self.appendChild(renderToDom(result, undefined, effectDisposers, instance.signalRegistry));\n  }\n\n  return newEventCleanups;\n}\n\n/**\n * CSR render path for shadow-DOM components.\n *\n * Clears previous bindings, calls render(), caches the result, and mounts the\n * produced DOM into the shadow root.\n */\nexport function renderIntoShadowRoot(\n  instance: OpenElement,\n  effectDisposers: Set<() => void>,\n  eventCleanups: Array<() => void>,\n  cache: VNodeCacheAccess,\n): Array<() => void> {\n  const root = instance.shadowRoot;\n  if (!root) return eventCleanups;\n\n  const newEventCleanups = disposeRenderBindings(effectDisposers, eventCleanups);\n\n  const result = instance.render();\n  cache.set(result);\n\n  if (result != null) {\n    while (root.firstChild) {\n      root.removeChild(root.firstChild);\n    }\n    root.appendChild(renderToDom(result, undefined, effectDisposers, instance.signalRegistry));\n  }\n\n  return newEventCleanups;\n}\n\n/**\n * Render a fallback VNode when the unified render/hydrate path throws.\n *\n * Ensures the render root exists, invokes onRenderError(), disposes any\n * previous bindings, and mounts the fallback content.\n */\nexport function renderErrorFallback(\n  instance: OpenElement,\n  error: unknown,\n  effectDisposers: Set<() => void>,\n  eventCleanups: Array<() => void>,\n  onRenderError: (error: unknown) => VNode | null,\n): Array<() => void> {\n  const ctor = instance.constructor as typeof OpenElement;\n  const isLightDom = ctor.renderMode === 'light';\n\n  if (!instance.shadowRoot && !isLightDom) {\n    instance.createRenderRoot();\n  }\n\n  const target = isLightDom ? (instance as HTMLElement) : instance.shadowRoot;\n  if (!target) return [];\n\n  let fallback: VNode | null;\n  try {\n    fallback = onRenderError(error);\n  } catch (fallbackError) {\n    createLogger('dsd').error(\n      `<${instance.tagName.toLowerCase()}> onRenderError failed: ${formatError(fallbackError)}`,\n    );\n    fallback = null;\n  }\n\n  const newEventCleanups = disposeRenderBindings(effectDisposers, eventCleanups);\n\n  if (fallback != null) {\n    while (target.firstChild) {\n      target.removeChild(target.firstChild);\n    }\n    target.appendChild(renderToDom(fallback, undefined, effectDisposers, instance.signalRegistry));\n  }\n\n  return newEventCleanups;\n}\n"],"names":[],"mappings":"AAAA;;;;;;;;;CASC,GAGD,SAAS,WAAW,QAAQ,oBAAoB;AAChD,SAAS,WAAW,QAAQ,2BAA2B;AACvD,SAAS,YAAY,QAAQ,2BAA2B;AAiBxD;;;;;;CAMC,GACD,OAAO,SAAS,sBACd,eAAgC,EAChC,aAAgC;EAEhC,KAAK,MAAM,KAAK,gBAAiB;EACjC,gBAAgB,KAAK;EACrB,KAAK,MAAM,KAAK,cAAe;EAC/B,OAAO,EAAE;AACX;AAEA;;;;;CAKC,GACD,OAAO,SAAS,mBACd,QAAqB,EACrB,eAAgC,EAChC,aAAgC,EAChC,KAAuB;EAEvB,MAAM,mBAAmB,sBAAsB,iBAAiB;EAEhE,MAAM,SAAS,SAAS,MAAM;EAC9B,MAAM,GAAG,CAAC;EAEV,MAAM,OAAO;EACb,MAAO,KAAK,UAAU,CAAE;IACtB,KAAK,WAAW,CAAC,KAAK,UAAU;EAClC;EAEA,IAAI,UAAU,MAAM;IAClB,KAAK,WAAW,CAAC,YAAY,QAAQ,WAAW,iBAAiB,SAAS,cAAc;EAC1F;EAEA,OAAO;AACT;AAEA;;;;;CAKC,GACD,OAAO,SAAS,qBACd,QAAqB,EACrB,eAAgC,EAChC,aAAgC,EAChC,KAAuB;EAEvB,MAAM,OAAO,SAAS,UAAU;EAChC,IAAI,CAAC,MAAM,OAAO;EAElB,MAAM,mBAAmB,sBAAsB,iBAAiB;EAEhE,MAAM,SAAS,SAAS,MAAM;EAC9B,MAAM,GAAG,CAAC;EAEV,IAAI,UAAU,MAAM;IAClB,MAAO,KAAK,UAAU,CAAE;MACtB,KAAK,WAAW,CAAC,KAAK,UAAU;IAClC;IACA,KAAK,WAAW,CAAC,YAAY,QAAQ,WAAW,iBAAiB,SAAS,cAAc;EAC1F;EAEA,OAAO;AACT;AAEA;;;;;CAKC,GACD,OAAO,SAAS,oBACd,QAAqB,EACrB,KAAc,EACd,eAAgC,EAChC,aAAgC,EAChC,aAA+C;EAE/C,MAAM,OAAO,SAAS,WAAW;EACjC,MAAM,aAAa,KAAK,UAAU,KAAK;EAEvC,IAAI,CAAC,SAAS,UAAU,IAAI,CAAC,YAAY;IACvC,SAAS,gBAAgB;EAC3B;EAEA,MAAM,SAAS,aAAc,WAA2B,SAAS,UAAU;EAC3E,IAAI,CAAC,QAAQ,OAAO,EAAE;EAEtB,IAAI;EACJ,IAAI;IACF,WAAW,cAAc;EAC3B,EAAE,OAAO,eAAe;IACtB,aAAa,OAAO,KAAK,CACvB,CAAC,CAAC,EAAE,SAAS,OAAO,CAAC,WAAW,GAAG,wBAAwB,EAAE,YAAY,gBAAgB;IAE3F,WAAW;EACb;EAEA,MAAM,mBAAmB,sBAAsB,iBAAiB;EAEhE,IAAI,YAAY,MAAM;IACpB,MAAO,OAAO,UAAU,CAAE;MACxB,OAAO,WAAW,CAAC,OAAO,UAAU;IACtC;IACA,OAAO,WAAW,CAAC,YAAY,UAAU,WAAW,iBAAiB,SAAS,cAAc;EAC9F;EAEA,OAAO;AACT"}
|
|
@@ -0,0 +1,176 @@
|
|
|
1
|
+
import type { StyleSheetLike } from '@openelement/protocol/style-sheet';
|
|
2
|
+
import type { VNode } from '@openelement/protocol/vnode';
|
|
3
|
+
import type { Signal } from '@openelement/protocol/signal';
|
|
4
|
+
/**
|
|
5
|
+
* SSR-safe base class for OpenElement.
|
|
6
|
+
*
|
|
7
|
+
* In browser: extends HTMLElement directly.
|
|
8
|
+
* In SSR: assigns a minimal stub to globalThis.HTMLElement so the entire
|
|
9
|
+
* dependency graph shares the same base class.
|
|
10
|
+
*/ declare const _Base: any;
|
|
11
|
+
/**
|
|
12
|
+
* Zero-dependency Custom Element base class for DSD rendering.
|
|
13
|
+
*
|
|
14
|
+
* Provides DSD detection, CSR fallback, event hydration, and style management
|
|
15
|
+
* without any framework dependency (no Lit, no reactive-element).
|
|
16
|
+
*
|
|
17
|
+
* Subclasses MUST override `render(): VNode | null`.
|
|
18
|
+
*/ export declare class OpenElement extends _Base {
|
|
19
|
+
/** Component stylesheets (SSR-safe - StyleSheet delegates to native CSSStyleSheet in browser). */ static styles?: StyleSheetLike | StyleSheetLike[];
|
|
20
|
+
/** Rendering mode. Defaults to shadow/DSD; light DOM is explicit opt-in. */ static renderMode?: 'shadow' | 'light';
|
|
21
|
+
/** v0.25.0: Page head metadata. SSG reads this to inject <title> and <meta> tags. */ static head?: {
|
|
22
|
+
title?: string;
|
|
23
|
+
description?: string;
|
|
24
|
+
ogImage?: string;
|
|
25
|
+
};
|
|
26
|
+
/** @internal — use openPipeline({ island: { upgradeStrategy } }) instead */ static client?: {
|
|
27
|
+
strategy?: 'load' | 'idle' | 'visible' | 'only';
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* Attributes that trigger attributeChangedCallback.
|
|
31
|
+
* Subclasses override this to declare reactive attributes.
|
|
32
|
+
*/ static observedAttributes?: string[];
|
|
33
|
+
/**
|
|
34
|
+
* Whether to delegate focus within the shadow root.
|
|
35
|
+
* When true, attachShadow is called with `delegatesFocus: true`.
|
|
36
|
+
*/ static delegatesFocus?: boolean;
|
|
37
|
+
/**
|
|
38
|
+
* Whether this element participates in form submission.
|
|
39
|
+
* When true, ElementInternals are attached in connectedCallback.
|
|
40
|
+
*/ static formAssociated?: boolean;
|
|
41
|
+
/**
|
|
42
|
+
* Signal registry for attribute-based hydration (ADR-0065).
|
|
43
|
+
* Maps signal names → signal objects. Built by registerSignal()
|
|
44
|
+
* in component constructors, consumed during hydration.
|
|
45
|
+
*
|
|
46
|
+
* Exposed internally for render helper modules.
|
|
47
|
+
*/ signalRegistry: Map<string, Signal<unknown>>;
|
|
48
|
+
/**
|
|
49
|
+
* Register a signal for hydration by name.
|
|
50
|
+
* Call in constructor: this.registerSignal('count', this.#count);
|
|
51
|
+
*/ protected registerSignal(name: string, sig: Signal<unknown>): void;
|
|
52
|
+
/** Reactive route parameters. Updates automatically on SPA navigation. */ get params(): Record<string, string>;
|
|
53
|
+
set params(value: Record<string, string>);
|
|
54
|
+
/** ElementInternals for form-associated custom elements */ protected _internals?: ElementInternals;
|
|
55
|
+
/**
|
|
56
|
+
* Create or reuse the shadow root.
|
|
57
|
+
*
|
|
58
|
+
* DSD detection: if `this.shadowRoot` already exists and has nodes,
|
|
59
|
+
* the browser pre-populated it from a <template shadowrootmode> tag.
|
|
60
|
+
* In that case we mark `_dsdHydrated = true` and return the existing root.
|
|
61
|
+
*
|
|
62
|
+
* CSR fallback: if no shadow root exists, we call `attachShadow()`. If an
|
|
63
|
+
* empty shadow root already exists, we reuse it and let connectedCallback()
|
|
64
|
+
* populate it from render().
|
|
65
|
+
*
|
|
66
|
+
* @returns The existing or newly created ShadowRoot.
|
|
67
|
+
*/ createRenderRoot(): ShadowRoot | this;
|
|
68
|
+
private _applyStyles: any;
|
|
69
|
+
/**
|
|
70
|
+
* Lifecycle: called when the element is connected to the DOM.
|
|
71
|
+
*
|
|
72
|
+
* DSD path (_dsdHydrated = true):
|
|
73
|
+
* - Calls _hydrateEvents() to bind declarative events on existing DOM.
|
|
74
|
+
*
|
|
75
|
+
* CSR path (_dsdHydrated = false):
|
|
76
|
+
* - Calls createRenderRoot() if no shadow root exists.
|
|
77
|
+
* - Renders this.render() through the VNode DOM renderer.
|
|
78
|
+
*
|
|
79
|
+
* If formAssociated is true, ElementInternals are attached.
|
|
80
|
+
*/ connectedCallback(): void;
|
|
81
|
+
private _renderOrHydrate: any;
|
|
82
|
+
private _hydrateSignals: any;
|
|
83
|
+
private _hydrateExistingDom: any;
|
|
84
|
+
/**
|
|
85
|
+
* v0.23.0: Hook called after DSD hydration completes.
|
|
86
|
+
*
|
|
87
|
+
* Subclasses override this instead of relying on fragile
|
|
88
|
+
* `super.connectedCallback()` call order. At this point the
|
|
89
|
+
* shadow DOM is populated from DSD and declarative events
|
|
90
|
+
* (@click, @keydown) are bound.
|
|
91
|
+
*
|
|
92
|
+
* No-op by default.
|
|
93
|
+
*/ protected onDsdHydrated(): void;
|
|
94
|
+
/**
|
|
95
|
+
* v0.23.0: Hook called after CSR first render completes.
|
|
96
|
+
*
|
|
97
|
+
* Subclasses override this for post-render initialization
|
|
98
|
+
* that depends on the shadow DOM being populated. At this
|
|
99
|
+
* point render() has been called and declarative events
|
|
100
|
+
* are bound.
|
|
101
|
+
*
|
|
102
|
+
* No-op by default.
|
|
103
|
+
*/ protected onCsrRendered(): void;
|
|
104
|
+
/**
|
|
105
|
+
* v0.40.0: Client-side activation hook.
|
|
106
|
+
*
|
|
107
|
+
* Called once after the element is connected, the shadow root
|
|
108
|
+
* is ready, and any DSD hydration or CSR rendering has completed.
|
|
109
|
+
* This is the right place for framework hydration (Preact, React,
|
|
110
|
+
* Vue, Lit) to take over the shadow DOM.
|
|
111
|
+
*
|
|
112
|
+
* Default implementation is a no-op. Subclasses override this to
|
|
113
|
+
* hydrate or render framework components into the shadow root.
|
|
114
|
+
*/ protected clientActivate(): void;
|
|
115
|
+
/**
|
|
116
|
+
* Hook called when the unified client render/hydrate path throws.
|
|
117
|
+
* Subclasses may return a VNode fallback.
|
|
118
|
+
*/ protected onRenderError(error: unknown): VNode | null;
|
|
119
|
+
private _renderErrorFallback: any;
|
|
120
|
+
/**
|
|
121
|
+
* Lifecycle: called when the element is disconnected from the DOM.
|
|
122
|
+
* Aborts all hydration event listeners for cleanup.
|
|
123
|
+
*/ disconnectedCallback(): void;
|
|
124
|
+
/**
|
|
125
|
+
* Lifecycle: called when an observed attribute changes.
|
|
126
|
+
*
|
|
127
|
+
* Base implementation is a no-op. Subclasses override this to react
|
|
128
|
+
* to attribute changes, typically by calling `this.render()` to update
|
|
129
|
+
* the shadow DOM.
|
|
130
|
+
*
|
|
131
|
+
* @param name - Attribute name (lowercase).
|
|
132
|
+
* @param oldValue - Previous value, or null if the attribute was not set.
|
|
133
|
+
* @param newValue - New value, or null if the attribute was removed.
|
|
134
|
+
*/ attributeChangedCallback(_name: string, _oldValue: string | null, _newValue: string | null): void;
|
|
135
|
+
/**
|
|
136
|
+
* Re-render the shadow DOM from `render()` and re-bind declarative events.
|
|
137
|
+
*
|
|
138
|
+
* OpenElement intentionally does not include a reactive scheduler. Components
|
|
139
|
+
* with local state can call this method after state changes instead of
|
|
140
|
+
* duplicating renderToDom() and event hydration.
|
|
141
|
+
*/ update(): void;
|
|
142
|
+
/**
|
|
143
|
+
* ReactiveController-compatible update hook.
|
|
144
|
+
*
|
|
145
|
+
* Async state controllers call this method when state changes. Keeping this
|
|
146
|
+
* tiny alias lets OpenElement host controllers without inheriting Lit or a
|
|
147
|
+
* scheduler.
|
|
148
|
+
*/ requestUpdate(): void;
|
|
149
|
+
private _renderIntoLightDom: any;
|
|
150
|
+
private _renderIntoShadowRoot: any;
|
|
151
|
+
/**
|
|
152
|
+
* Read locale from JS property (set by SSR injectProps) first,
|
|
153
|
+
* then HTML attribute, then fallback to provided default.
|
|
154
|
+
*
|
|
155
|
+
* SSR injectProps() sets camelCase JS properties (e.g. this.locale = 'en')
|
|
156
|
+
* but getAttribute() only reads HTML attributes, which remain null.
|
|
157
|
+
* This method resolves the mismatch by checking JS property first.
|
|
158
|
+
*
|
|
159
|
+
* @param fallback - Default value when neither source has a value. Defaults to 'en'.
|
|
160
|
+
*/ protected _getLocale(fallback?: string): string;
|
|
161
|
+
/**
|
|
162
|
+
* Return Shadow DOM content as a VNode.
|
|
163
|
+
*
|
|
164
|
+
* Subclasses MUST override this method. During SSR, rendered content is
|
|
165
|
+
* wrapped in a <template shadowrootmode="open"> tag. During CSR, VNode values
|
|
166
|
+
* are rendered via renderToDom() with event binding and signal tracking.
|
|
167
|
+
*
|
|
168
|
+
* @returns VNode for the shadow DOM content, or null for empty content.
|
|
169
|
+
*/ render(): VNode | null;
|
|
170
|
+
}
|
|
171
|
+
/** OpenElement constructor with framework-convention static properties. */ export interface OpenElementComponentConstructor extends CustomElementConstructor {
|
|
172
|
+
styles?: StyleSheetLike | StyleSheetLike[];
|
|
173
|
+
tagName?: string;
|
|
174
|
+
renderMode?: 'shadow' | 'light';
|
|
175
|
+
observedAttributes?: string[];
|
|
176
|
+
}
|