mirror of
https://github.com/jaandrle/deka-dom-el
synced 2024-11-21 23:39:37 +01:00
Compare commits
5 Commits
528a865d79
...
55860b99eb
Author | SHA1 | Date | |
---|---|---|---|
55860b99eb | |||
a5efbd236c | |||
0bc0e0c64d | |||
a0a104ac0b | |||
4f788459b9 |
File diff suppressed because one or more lines are too long
@ -11,7 +11,13 @@ customElementWithDDE(HTMLCustomElement);
|
|||||||
customElements.define(HTMLCustomElement.tagName, HTMLCustomElement);
|
customElements.define(HTMLCustomElement.tagName, HTMLCustomElement);
|
||||||
|
|
||||||
const instance= el(HTMLCustomElement.tagName);
|
const instance= el(HTMLCustomElement.tagName);
|
||||||
on.connected(e=> console.log("Element connected to the DOM:", e))(instance);
|
on.connected( // preffered
|
||||||
|
e=> console.log("Element connected to the DOM (v1):", e)
|
||||||
|
)(instance);
|
||||||
|
instance.addEventListener(
|
||||||
|
"dde:connected",
|
||||||
|
e=> console.log("Element connected to the DOM (v2):", e)
|
||||||
|
);
|
||||||
document.body.append(
|
document.body.append(
|
||||||
instance,
|
instance,
|
||||||
);
|
);
|
||||||
|
@ -23,7 +23,7 @@ function ddeComponent({ attr }){
|
|||||||
);
|
);
|
||||||
return el().append(
|
return el().append(
|
||||||
el("p", `Hello from Custom Element with attribute '${attr}'`)
|
el("p", `Hello from Custom Element with attribute '${attr}'`)
|
||||||
)
|
);
|
||||||
}
|
}
|
||||||
customElementWithDDE(HTMLCustomElement);
|
customElementWithDDE(HTMLCustomElement);
|
||||||
customElements.define(HTMLCustomElement.tagName, HTMLCustomElement);
|
customElements.define(HTMLCustomElement.tagName, HTMLCustomElement);
|
||||||
|
@ -4,7 +4,7 @@ import { mnemonicUl } from "../mnemonicUl.html.js";
|
|||||||
export function mnemonic(){
|
export function mnemonic(){
|
||||||
return mnemonicUl().append(
|
return mnemonicUl().append(
|
||||||
el("li").append(
|
el("li").append(
|
||||||
el("code", "customElementRender(<custom-element>, <render-function>[, <properties>])"), " — use function to render DOM structure for given <custom-element>",
|
el("code", "customElementRender(<custom-element>, <connect-target>, <render-function>[, <properties>])"), " — use function to render DOM structure for given <custom-element>",
|
||||||
),
|
),
|
||||||
el("li").append(
|
el("li").append(
|
||||||
el("code", "customElementWithDDE(<custom-element>)"), " — register <custom-element> to DDE library, see also `lifecyclesToEvents`, can be also used as decorator",
|
el("code", "customElementWithDDE(<custom-element>)"), " — register <custom-element> to DDE library, see also `lifecyclesToEvents`, can be also used as decorator",
|
||||||
|
@ -68,7 +68,19 @@ export function page({ pkg, info }){
|
|||||||
el(example, { src: fileURL("./components/examples/customElement/customElementWithDDE.js"), page_id }),
|
el(example, { src: fileURL("./components/examples/customElement/customElementWithDDE.js"), page_id }),
|
||||||
|
|
||||||
el("h3", t`Custom Elements with DDE`),
|
el("h3", t`Custom Elements with DDE`),
|
||||||
|
el("p").append(...T`
|
||||||
|
The ${el("code", "customElementWithDDE")} function is only (small) part of the inregration of the library.
|
||||||
|
More important for coexistence is render component function as a body of the Custom Element. For that, you
|
||||||
|
can use ${el("code", "customElementRender")} with arguments instance reference, target for connection,
|
||||||
|
render function and optional properties (will be passed to the render function) see later…
|
||||||
|
`),
|
||||||
el(example, { src: fileURL("./components/examples/customElement/dde.js"), page_id }),
|
el(example, { src: fileURL("./components/examples/customElement/dde.js"), page_id }),
|
||||||
|
el("p").append(...T`
|
||||||
|
…as you can see, you can use components created based on the documentation previously introduced. To unlock
|
||||||
|
full potential, use with combination ${el("code", "customElementWithDDE")} (allows to use livecycle events)
|
||||||
|
and ${el("code", "observedAttributes")} (converts attributes to render function arguments —
|
||||||
|
${el("em", "default")}) or ${el("code", "S.observedAttributes")} (converts attributes to signals).
|
||||||
|
`),
|
||||||
|
|
||||||
|
|
||||||
el(mnemonic)
|
el(mnemonic)
|
||||||
|
35
index.d.ts
vendored
35
index.d.ts
vendored
@ -1,4 +1,4 @@
|
|||||||
import { Signal } from "./signals";
|
declare global{ /* ddeSignal */ }
|
||||||
|
|
||||||
type CustomElementTagNameMap= { '#text': Text, '#comment': Comment }
|
type CustomElementTagNameMap= { '#text': Text, '#comment': Comment }
|
||||||
type SupportedElement=
|
type SupportedElement=
|
||||||
@ -15,20 +15,20 @@ type AttrsModified= {
|
|||||||
/**
|
/**
|
||||||
* Use string like in HTML (internally uses `*.setAttribute("style", *)`), or object representation (like DOM API).
|
* Use string like in HTML (internally uses `*.setAttribute("style", *)`), or object representation (like DOM API).
|
||||||
*/
|
*/
|
||||||
style: string | Partial<CSSStyleDeclaration> | Signal<string, any> | Partial<{ [K in keyof CSSStyleDeclaration]: Signal<CSSStyleDeclaration[K], any> }>
|
style: string | Partial<CSSStyleDeclaration> | ddeSignal<string> | Partial<{ [K in keyof CSSStyleDeclaration]: ddeSignal<CSSStyleDeclaration[K]> }>
|
||||||
/**
|
/**
|
||||||
* Provide option to add/remove/toggle CSS clasess (index of object) using 1/0/-1. In fact `el.classList.toggle(class_name)` for `-1` and `el.classList.toggle(class_name, Boolean(...))` for others.
|
* Provide option to add/remove/toggle CSS clasess (index of object) using 1/0/-1. In fact `el.classList.toggle(class_name)` for `-1` and `el.classList.toggle(class_name, Boolean(...))` for others.
|
||||||
*/
|
*/
|
||||||
classList: Record<string,-1|0|1|boolean|Signal<-1|0|1|boolean, any>>,
|
classList: Record<string,-1|0|1|boolean|ddeSignal<-1|0|1|boolean>>,
|
||||||
/**
|
/**
|
||||||
* By default simiral to `className`, but also supports `string[]`
|
* By default simiral to `className`, but also supports `string[]`
|
||||||
* */
|
* */
|
||||||
className: string | (string|boolean|undefined|Signal<string|boolean|undefined, any>)[];
|
className: string | (string|boolean|undefined|ddeSignal<string|boolean|undefined>)[];
|
||||||
/**
|
/**
|
||||||
* Sets `aria-*` simiraly to `dataset`
|
* Sets `aria-*` simiraly to `dataset`
|
||||||
* */
|
* */
|
||||||
ariaset: Record<string,string|Signal<string, any>>,
|
ariaset: Record<string,string|ddeSignal<string>>,
|
||||||
} & Record<`=${string}` | `data${PascalCase}` | `aria${PascalCase}`, string|Signal<string, any>> & Record<`.${string}`, any>
|
} & Record<`=${string}` | `data${PascalCase}` | `aria${PascalCase}`, string|ddeSignal<string>> & Record<`.${string}`, any>
|
||||||
type _fromElsInterfaces<EL extends SupportedElement>= Omit<EL, keyof AttrsModified>;
|
type _fromElsInterfaces<EL extends SupportedElement>= Omit<EL, keyof AttrsModified>;
|
||||||
/**
|
/**
|
||||||
* Just element attributtes
|
* Just element attributtes
|
||||||
@ -38,15 +38,15 @@ type _fromElsInterfaces<EL extends SupportedElement>= Omit<EL, keyof AttrsModifi
|
|||||||
* There is added support for `data[A-Z].*`/`aria[A-Z].*` to be converted to the kebab-case alternatives.
|
* There is added support for `data[A-Z].*`/`aria[A-Z].*` to be converted to the kebab-case alternatives.
|
||||||
* @private
|
* @private
|
||||||
*/
|
*/
|
||||||
type ElementAttributes<T extends SupportedElement>= Partial<_fromElsInterfaces<T> & { [K in keyof _fromElsInterfaces<T>]: Signal<_fromElsInterfaces<T>[K], any> } & AttrsModified> & Record<string, any>;
|
type ElementAttributes<T extends SupportedElement>= Partial<{ [K in keyof _fromElsInterfaces<T>]: _fromElsInterfaces<T>[K] | ddeSignal<_fromElsInterfaces<T>[K]> } & AttrsModified> & Record<string, any>;
|
||||||
export function classListDeclarative<El extends SupportedElement>(element: El, classList: AttrsModified["classList"]): El
|
export function classListDeclarative<El extends SupportedElement>(element: El, classList: AttrsModified["classList"]): El
|
||||||
export function assign<El extends SupportedElement>(element: El, ...attrs_array: ElementAttributes<El>[]): El
|
export function assign<El extends SupportedElement>(element: El, ...attrs_array: ElementAttributes<El>[]): El
|
||||||
export function assignAttribute<El extends SupportedElement, ATT extends keyof ElementAttributes<El>>(element: El, attr: ATT, value: ElementAttributes<El>[ATT]): ElementAttributes<El>[ATT]
|
export function assignAttribute<El extends SupportedElement, ATT extends keyof ElementAttributes<El>>(element: El, attr: ATT, value: ElementAttributes<El>[ATT]): ElementAttributes<El>[ATT]
|
||||||
|
|
||||||
type ExtendedHTMLElementTagNameMap= HTMLElementTagNameMap & CustomElementTagNameMap;
|
type ExtendedHTMLElementTagNameMap= HTMLElementTagNameMap & CustomElementTagNameMap;
|
||||||
type textContent= string | ( (set?: string)=> string ); // TODO: for some reason `Signal<string, any>` leads to `attrs?: any`
|
type textContent= string | ddeSignal<string>;
|
||||||
export function el<
|
export function el<
|
||||||
TAG extends keyof ExtendedHTMLElementTagNameMap & string,
|
TAG extends keyof ExtendedHTMLElementTagNameMap,
|
||||||
EL extends (TAG extends keyof ExtendedHTMLElementTagNameMap ? ExtendedHTMLElementTagNameMap[TAG] : HTMLElement)
|
EL extends (TAG extends keyof ExtendedHTMLElementTagNameMap ? ExtendedHTMLElementTagNameMap[TAG] : HTMLElement)
|
||||||
>(
|
>(
|
||||||
tag_name: TAG,
|
tag_name: TAG,
|
||||||
@ -56,6 +56,11 @@ export function el<
|
|||||||
export function el(
|
export function el(
|
||||||
tag_name?: "<>",
|
tag_name?: "<>",
|
||||||
): ddeDocumentFragment
|
): ddeDocumentFragment
|
||||||
|
export function el(
|
||||||
|
tag_name: string,
|
||||||
|
attrs?: ElementAttributes<HTMLElement>,
|
||||||
|
...addons: ddeElementAddon<HTMLElement>[]
|
||||||
|
): ddeHTMLElement
|
||||||
|
|
||||||
export function el<
|
export function el<
|
||||||
C extends (attr: ddeComponentAttributes)=> SupportedElement | ddeDocumentFragment
|
C extends (attr: ddeComponentAttributes)=> SupportedElement | ddeDocumentFragment
|
||||||
@ -83,7 +88,7 @@ export function elNS(
|
|||||||
EL extends ( TAG extends keyof MathMLElementTagNameMap ? MathMLElementTagNameMap[TAG] : MathMLElement ),
|
EL extends ( TAG extends keyof MathMLElementTagNameMap ? MathMLElementTagNameMap[TAG] : MathMLElement ),
|
||||||
>(
|
>(
|
||||||
tag_name: TAG,
|
tag_name: TAG,
|
||||||
attrs?: string | textContent | Partial<{ [key in keyof EL]: EL[key] | Signal<EL[key], any> | string | number | boolean }>,
|
attrs?: string | textContent | Partial<{ [key in keyof EL]: EL[key] | ddeSignal<EL[key]> | string | number | boolean }>,
|
||||||
...addons: ddeElementAddon<EL>[]
|
...addons: ddeElementAddon<EL>[]
|
||||||
)=> ddeMathMLElement
|
)=> ddeMathMLElement
|
||||||
export function elNS(
|
export function elNS(
|
||||||
@ -124,7 +129,7 @@ interface On{
|
|||||||
EE extends ddeElementAddon<SupportedElement>,
|
EE extends ddeElementAddon<SupportedElement>,
|
||||||
El extends ( EE extends ddeElementAddon<infer El> ? El : never )
|
El extends ( EE extends ddeElementAddon<infer El> ? El : never )
|
||||||
>(
|
>(
|
||||||
listener: (this: El, event: CustomEvent<void>) => any,
|
listener: (this: El, event: CustomEvent<El>) => any,
|
||||||
options?: AddEventListenerOptions
|
options?: AddEventListenerOptions
|
||||||
) : EE;
|
) : EE;
|
||||||
/** Listens to the element is disconnected from the live DOM. In case of custom elements uses [`disconnectedCallback`](https://developer.mozilla.org/en-US/docs/Web/API/Web_components/Using_custom_elements#custom_element_lifecycle_callbacks), or {@link MutationObserver} else where */
|
/** Listens to the element is disconnected from the live DOM. In case of custom elements uses [`disconnectedCallback`](https://developer.mozilla.org/en-US/docs/Web/API/Web_components/Using_custom_elements#custom_element_lifecycle_callbacks), or {@link MutationObserver} else where */
|
||||||
@ -159,7 +164,7 @@ export const scope: {
|
|||||||
* It can be also used to register Addon(s) (functions to be called when component is initized)
|
* It can be also used to register Addon(s) (functions to be called when component is initized)
|
||||||
* — `scope.host(on.connected(console.log))`.
|
* — `scope.host(on.connected(console.log))`.
|
||||||
* */
|
* */
|
||||||
host: (...addons: ddeElementAddon<any>[])=> HTMLElement,
|
host: (...addons: ddeElementAddon<SupportedElement>[])=> HTMLElement,
|
||||||
|
|
||||||
state: Scope[],
|
state: Scope[],
|
||||||
/** Adds new child scope. All attributes are inherited by default. */
|
/** Adds new child scope. All attributes are inherited by default. */
|
||||||
@ -176,11 +181,11 @@ export function customElementRender<
|
|||||||
>(
|
>(
|
||||||
custom_element: EL,
|
custom_element: EL,
|
||||||
target: ShadowRoot | EL,
|
target: ShadowRoot | EL,
|
||||||
render: (props: P)=> SupportedElement,
|
render: (props: P)=> SupportedElement | DocumentFragment,
|
||||||
props?: P | ((...args: any[])=> P)
|
props?: P | ((...args: any[])=> P)
|
||||||
): EL
|
): EL
|
||||||
export function customElementWithDDE<EL extends HTMLElement>(custom_element: EL): EL
|
export function customElementWithDDE<EL extends (new ()=> HTMLElement)>(custom_element: EL): EL
|
||||||
export function lifecyclesToEvents<EL extends HTMLElement>(custom_element: EL): EL
|
export function lifecyclesToEvents<EL extends (new ()=> HTMLElement)>(custom_element: EL): EL
|
||||||
export function observedAttributes(custom_element: HTMLElement): Record<string, string>
|
export function observedAttributes(custom_element: HTMLElement): Record<string, string>
|
||||||
|
|
||||||
/* TypeScript MEH */
|
/* TypeScript MEH */
|
||||||
|
8
signals.d.ts
vendored
8
signals.d.ts
vendored
@ -6,6 +6,10 @@ type Actions<V>= Record<string | SymbolOnclear, Action<V>>;
|
|||||||
type OnListenerOptions= Pick<AddEventListenerOptions, "signal"> & { first_time?: boolean };
|
type OnListenerOptions= Pick<AddEventListenerOptions, "signal"> & { first_time?: boolean };
|
||||||
interface signal{
|
interface signal{
|
||||||
_: Symbol
|
_: Symbol
|
||||||
|
/**
|
||||||
|
* Computations signal. This creates a signal which is computed from other signals.
|
||||||
|
* */
|
||||||
|
<V extends ()=> any>(computation: V): Signal<ReturnType<V>, {}>
|
||||||
/**
|
/**
|
||||||
* Simple example:
|
* Simple example:
|
||||||
* ```js
|
* ```js
|
||||||
@ -31,10 +35,6 @@ interface signal{
|
|||||||
* by `S.clear`.
|
* by `S.clear`.
|
||||||
* */
|
* */
|
||||||
<V, A extends Actions<V>>(value: V, actions?: A): Signal<V, A>;
|
<V, A extends Actions<V>>(value: V, actions?: A): Signal<V, A>;
|
||||||
/**
|
|
||||||
* Computations signal. This creates a signal which is computed from other signals.
|
|
||||||
* */
|
|
||||||
<V>(computation: ()=> V): Signal<V, {}>
|
|
||||||
action<S extends Signal<any, Actions<any>>, A extends (S extends Signal<any, infer A> ? A : never), N extends keyof A>(
|
action<S extends Signal<any, Actions<any>>, A extends (S extends Signal<any, infer A> ? A : never), N extends keyof A>(
|
||||||
signal: S,
|
signal: S,
|
||||||
name: N,
|
name: N,
|
||||||
|
Loading…
Reference in New Issue
Block a user