element-vir 26.11.2 → 26.12.0
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/package.json +12 -12
- package/src/declarative-element/declarative-element-init.ts +115 -0
- package/src/declarative-element/declarative-element.ts +372 -0
- package/src/declarative-element/define-element.ts +515 -0
- package/{dist/declarative-element/definition-options.d.ts → src/declarative-element/definition-options.ts} +7 -2
- package/src/declarative-element/directives/assign.directive.ts +89 -0
- package/{dist/declarative-element/directives/async-prop.js → src/declarative-element/directives/async-prop.ts} +42 -8
- package/src/declarative-element/directives/attributes.directive.ts +63 -0
- package/src/declarative-element/directives/create-attribute-directive.ts +47 -0
- package/src/declarative-element/directives/directive-helpers.ts +67 -0
- package/{dist/declarative-element/directives/listen-to-activate.js → src/declarative-element/directives/listen-to-activate.ts} +8 -3
- package/src/declarative-element/directives/listen.directive.ts +206 -0
- package/src/declarative-element/directives/mutate.directive.ts +78 -0
- package/src/declarative-element/directives/on-dom-created.directive.ts +68 -0
- package/src/declarative-element/directives/on-dom-rendered.directive.ts +61 -0
- package/src/declarative-element/directives/on-intersect.directive.ts +139 -0
- package/src/declarative-element/directives/on-resize.directive.ts +142 -0
- package/src/declarative-element/directives/render-async.directive.ts +111 -0
- package/{dist/declarative-element/directives/render-if.directive.js → src/declarative-element/directives/render-if.directive.ts} +12 -3
- package/{dist/declarative-element/directives/test-id.directive.js → src/declarative-element/directives/test-id.directive.ts} +7 -2
- package/{dist/declarative-element/has-declarative-element-parent.js → src/declarative-element/has-declarative-element-parent.ts} +7 -4
- package/{dist/declarative-element/is-declarative-element-definition.js → src/declarative-element/is-declarative-element-definition.ts} +28 -11
- package/{dist/declarative-element/is-declarative-element.js → src/declarative-element/is-declarative-element.ts} +11 -5
- package/src/declarative-element/properties/assign-inputs.ts +30 -0
- package/src/declarative-element/properties/css-vars.ts +24 -0
- package/src/declarative-element/properties/element-events.ts +161 -0
- package/src/declarative-element/properties/host-classes.ts +63 -0
- package/{dist/declarative-element/properties/property-proxy.js → src/declarative-element/properties/property-proxy.ts} +58 -21
- package/src/declarative-element/properties/string-names.ts +83 -0
- package/src/declarative-element/properties/styles.ts +112 -0
- package/src/declarative-element/render-callback.ts +196 -0
- package/src/declarative-element/wrap-define-element.ts +127 -0
- package/{dist/index.d.ts → src/index.ts} +2 -0
- package/{dist/lit-exports/base-lit-exports.js → src/lit-exports/base-lit-exports.ts} +10 -1
- package/{dist/lit-exports/lit-repeat-fix.d.ts → src/lit-exports/lit-repeat-fix.ts} +45 -16
- package/{dist/readme-examples/my-app.element.js → src/readme-examples/my-app.element.ts} +5 -4
- package/src/readme-examples/my-custom-action.event.ts +3 -0
- package/{dist/readme-examples/my-custom-define.js → src/readme-examples/my-custom-define.ts} +9 -4
- package/{dist/readme-examples/my-simple.element.js → src/readme-examples/my-simple.element.ts} +4 -3
- package/src/readme-examples/my-with-assignment.element.ts +16 -0
- package/{dist/readme-examples/my-with-async-prop.element.js → src/readme-examples/my-with-async-prop.element.ts} +24 -16
- package/{dist/readme-examples/my-with-cleanup-callback.element.js → src/readme-examples/my-with-cleanup-callback.element.ts} +5 -4
- package/{dist/readme-examples/my-with-css-vars.element.js → src/readme-examples/my-with-css-vars.element.ts} +5 -4
- package/src/readme-examples/my-with-custom-events.element.ts +23 -0
- package/{dist/readme-examples/my-with-event-listening.element.js → src/readme-examples/my-with-event-listening.element.ts} +10 -9
- package/src/readme-examples/my-with-events.element.ts +23 -0
- package/{dist/readme-examples/my-with-host-class-definition.element.js → src/readme-examples/my-with-host-class-definition.element.ts} +7 -6
- package/{dist/readme-examples/my-with-host-class-usage.element.js → src/readme-examples/my-with-host-class-usage.element.ts} +5 -4
- package/src/readme-examples/my-with-inputs.element.ts +13 -0
- package/{dist/readme-examples/my-with-on-dom-created.element.js → src/readme-examples/my-with-on-dom-created.element.ts} +7 -6
- package/src/readme-examples/my-with-on-resize.element.ts +19 -0
- package/src/readme-examples/my-with-render-if.element.ts +15 -0
- package/{dist/readme-examples/my-with-styles-and-interpolated-selector.element.js → src/readme-examples/my-with-styles-and-interpolated-selector.element.ts} +6 -5
- package/{dist/readme-examples/my-with-styles.element.js → src/readme-examples/my-with-styles.element.ts} +5 -4
- package/{dist/readme-examples/my-with-update-state.element.js → src/readme-examples/my-with-update-state.element.ts} +8 -7
- package/src/readme-examples/require-declarative-element.ts +3 -0
- package/{dist/require-declarative-element.js → src/require-declarative-element.ts} +1 -0
- package/{dist/template-transforms/minimal-element-definition.d.ts → src/template-transforms/minimal-element-definition.ts} +19 -7
- package/src/template-transforms/nested-mapped-templates.ts +157 -0
- package/{dist/template-transforms/template-transform-type.d.ts → src/template-transforms/template-transform-type.ts} +3 -1
- package/{dist/template-transforms/transform-template.js → src/template-transforms/transform-template.ts} +70 -22
- package/src/template-transforms/vir-css/css-transform.ts +30 -0
- package/src/template-transforms/vir-css/vir-css.ts +30 -0
- package/src/template-transforms/vir-html/html-interpolation.ts +103 -0
- package/src/template-transforms/vir-html/html-transform.ts +149 -0
- package/{dist/template-transforms/vir-html/tag-name-keys.js → src/template-transforms/vir-html/tag-name-keys.ts} +1 -1
- package/{dist/template-transforms/vir-html/vir-html.js → src/template-transforms/vir-html/vir-html.ts} +13 -5
- package/src/typed-event/typed-event.ts +90 -0
- package/{dist/util/array.js → src/util/array.ts} +18 -5
- package/{dist/util/increment.d.ts → src/util/increment.ts} +24 -5
- package/{dist/util/lit-template.js → src/util/lit-template.ts} +30 -10
- package/src/util/map-async-value.ts +33 -0
- package/dist/declarative-element/custom-tag-name.js +0 -1
- package/dist/declarative-element/declarative-element-init.d.ts +0 -56
- package/dist/declarative-element/declarative-element-init.js +0 -1
- package/dist/declarative-element/declarative-element.d.ts +0 -114
- package/dist/declarative-element/declarative-element.js +0 -36
- package/dist/declarative-element/define-element.d.ts +0 -41
- package/dist/declarative-element/define-element.js +0 -248
- package/dist/declarative-element/definition-options.js +0 -9
- package/dist/declarative-element/directives/assign.directive.d.ts +0 -24
- package/dist/declarative-element/directives/assign.directive.js +0 -34
- package/dist/declarative-element/directives/async-prop.d.ts +0 -61
- package/dist/declarative-element/directives/attributes.directive.d.ts +0 -30
- package/dist/declarative-element/directives/attributes.directive.js +0 -35
- package/dist/declarative-element/directives/create-attribute-directive.d.ts +0 -28
- package/dist/declarative-element/directives/create-attribute-directive.js +0 -41
- package/dist/declarative-element/directives/directive-helpers.d.ts +0 -27
- package/dist/declarative-element/directives/directive-helpers.js +0 -37
- package/dist/declarative-element/directives/listen-to-activate.d.ts +0 -15
- package/dist/declarative-element/directives/listen.directive.d.ts +0 -92
- package/dist/declarative-element/directives/listen.directive.js +0 -48
- package/dist/declarative-element/directives/mutate.directive.d.ts +0 -38
- package/dist/declarative-element/directives/mutate.directive.js +0 -45
- package/dist/declarative-element/directives/on-dom-created.directive.d.ts +0 -44
- package/dist/declarative-element/directives/on-dom-created.directive.js +0 -51
- package/dist/declarative-element/directives/on-dom-rendered.directive.d.ts +0 -41
- package/dist/declarative-element/directives/on-dom-rendered.directive.js +0 -45
- package/dist/declarative-element/directives/on-intersect.directive.d.ts +0 -64
- package/dist/declarative-element/directives/on-intersect.directive.js +0 -89
- package/dist/declarative-element/directives/on-resize.directive.d.ts +0 -74
- package/dist/declarative-element/directives/on-resize.directive.js +0 -106
- package/dist/declarative-element/directives/render-async.directive.d.ts +0 -45
- package/dist/declarative-element/directives/render-async.directive.js +0 -33
- package/dist/declarative-element/directives/render-if.directive.d.ts +0 -32
- package/dist/declarative-element/directives/test-id.directive.d.ts +0 -52
- package/dist/declarative-element/has-declarative-element-parent.d.ts +0 -1
- package/dist/declarative-element/is-declarative-element-definition.d.ts +0 -17
- package/dist/declarative-element/is-declarative-element.d.ts +0 -15
- package/dist/declarative-element/properties/assign-inputs.d.ts +0 -1
- package/dist/declarative-element/properties/assign-inputs.js +0 -25
- package/dist/declarative-element/properties/css-vars.d.ts +0 -16
- package/dist/declarative-element/properties/css-vars.js +0 -1
- package/dist/declarative-element/properties/element-events.d.ts +0 -65
- package/dist/declarative-element/properties/element-events.js +0 -62
- package/dist/declarative-element/properties/element-properties.js +0 -1
- package/dist/declarative-element/properties/host-classes.d.ts +0 -36
- package/dist/declarative-element/properties/host-classes.js +0 -16
- package/dist/declarative-element/properties/property-proxy.d.ts +0 -22
- package/dist/declarative-element/properties/string-names.d.ts +0 -28
- package/dist/declarative-element/properties/string-names.js +0 -40
- package/dist/declarative-element/properties/styles.d.ts +0 -51
- package/dist/declarative-element/properties/styles.js +0 -41
- package/dist/declarative-element/properties/tag-name.js +0 -1
- package/dist/declarative-element/render-callback.d.ts +0 -56
- package/dist/declarative-element/render-callback.js +0 -27
- package/dist/declarative-element/wrap-define-element.d.ts +0 -36
- package/dist/declarative-element/wrap-define-element.js +0 -25
- package/dist/index.js +0 -42
- package/dist/lit-exports/all-lit-exports.js +0 -2
- package/dist/lit-exports/base-lit-exports.d.ts +0 -25
- package/dist/lit-exports/lit-repeat-fix.js +0 -37
- package/dist/readme-examples/my-app.element.d.ts +0 -1
- package/dist/readme-examples/my-custom-action.event.d.ts +0 -1
- package/dist/readme-examples/my-custom-action.event.js +0 -2
- package/dist/readme-examples/my-custom-define.d.ts +0 -4
- package/dist/readme-examples/my-simple.element.d.ts +0 -1
- package/dist/readme-examples/my-with-assignment.element.d.ts +0 -1
- package/dist/readme-examples/my-with-assignment.element.js +0 -15
- package/dist/readme-examples/my-with-async-prop.element.d.ts +0 -10
- package/dist/readme-examples/my-with-cleanup-callback.element.d.ts +0 -3
- package/dist/readme-examples/my-with-css-vars.element.d.ts +0 -1
- package/dist/readme-examples/my-with-custom-events.element.d.ts +0 -1
- package/dist/readme-examples/my-with-custom-events.element.js +0 -22
- package/dist/readme-examples/my-with-event-listening.element.d.ts +0 -3
- package/dist/readme-examples/my-with-events.element.d.ts +0 -4
- package/dist/readme-examples/my-with-events.element.js +0 -20
- package/dist/readme-examples/my-with-host-class-definition.element.d.ts +0 -3
- package/dist/readme-examples/my-with-host-class-usage.element.d.ts +0 -1
- package/dist/readme-examples/my-with-inputs.element.d.ts +0 -4
- package/dist/readme-examples/my-with-inputs.element.js +0 -9
- package/dist/readme-examples/my-with-on-dom-created.element.d.ts +0 -1
- package/dist/readme-examples/my-with-on-resize.element.d.ts +0 -1
- package/dist/readme-examples/my-with-on-resize.element.js +0 -18
- package/dist/readme-examples/my-with-render-if.element.d.ts +0 -3
- package/dist/readme-examples/my-with-render-if.element.js +0 -11
- package/dist/readme-examples/my-with-styles-and-interpolated-selector.element.d.ts +0 -1
- package/dist/readme-examples/my-with-styles.element.d.ts +0 -1
- package/dist/readme-examples/my-with-update-state.element.d.ts +0 -8
- package/dist/readme-examples/require-declarative-element.d.ts +0 -1
- package/dist/readme-examples/require-declarative-element.js +0 -2
- package/dist/require-declarative-element.d.ts +0 -14
- package/dist/template-transforms/minimal-element-definition.js +0 -19
- package/dist/template-transforms/nested-mapped-templates.d.ts +0 -6
- package/dist/template-transforms/nested-mapped-templates.js +0 -96
- package/dist/template-transforms/template-transform-type.js +0 -1
- package/dist/template-transforms/transform-template.d.ts +0 -14
- package/dist/template-transforms/vir-css/css-transform.d.ts +0 -4
- package/dist/template-transforms/vir-css/css-transform.js +0 -15
- package/dist/template-transforms/vir-css/vir-css.d.ts +0 -12
- package/dist/template-transforms/vir-css/vir-css.js +0 -21
- package/dist/template-transforms/vir-html/html-interpolation.d.ts +0 -42
- package/dist/template-transforms/vir-html/html-interpolation.js +0 -1
- package/dist/template-transforms/vir-html/html-transform.d.ts +0 -5
- package/dist/template-transforms/vir-html/html-transform.js +0 -96
- package/dist/template-transforms/vir-html/tag-name-keys.d.ts +0 -7
- package/dist/template-transforms/vir-html/vir-html.d.ts +0 -11
- package/dist/typed-event/typed-event.d.ts +0 -55
- package/dist/typed-event/typed-event.js +0 -50
- package/dist/util/array.d.ts +0 -5
- package/dist/util/increment.js +0 -1
- package/dist/util/lit-template.d.ts +0 -9
- package/dist/util/type.js +0 -1
- /package/{dist/declarative-element/custom-tag-name.d.ts → src/declarative-element/custom-tag-name.ts} +0 -0
- /package/{dist/declarative-element/properties/element-properties.d.ts → src/declarative-element/properties/element-properties.ts} +0 -0
- /package/{dist/declarative-element/properties/tag-name.d.ts → src/declarative-element/properties/tag-name.ts} +0 -0
- /package/{dist/lit-exports/all-lit-exports.d.ts → src/lit-exports/all-lit-exports.ts} +0 -0
- /package/{dist/util/type.d.ts → src/util/type.ts} +0 -0
|
@@ -1,22 +0,0 @@
|
|
|
1
|
-
import { randomInteger } from '@augment-vir/common';
|
|
2
|
-
import { defineElement } from 'element-vir';
|
|
3
|
-
import { html, listen } from '../index.js';
|
|
4
|
-
import { MyCustomActionEvent } from './my-custom-action.event.js';
|
|
5
|
-
export const MyWithCustomEvents = defineElement()({
|
|
6
|
-
tagName: 'my-with-custom-events',
|
|
7
|
-
render({ dispatch }) {
|
|
8
|
-
return html `
|
|
9
|
-
<div
|
|
10
|
-
${listen(MyCustomActionEvent, (event) => {
|
|
11
|
-
console.info(`Got a number! ${event.detail}`);
|
|
12
|
-
})}
|
|
13
|
-
>
|
|
14
|
-
<div
|
|
15
|
-
${listen('click', () => {
|
|
16
|
-
dispatch(new MyCustomActionEvent(randomInteger({ min: 0, max: 1_000_000 })));
|
|
17
|
-
})}
|
|
18
|
-
></div>
|
|
19
|
-
</div>
|
|
20
|
-
`;
|
|
21
|
-
},
|
|
22
|
-
});
|
|
@@ -1,4 +0,0 @@
|
|
|
1
|
-
export declare const MyWithEvents: import("element-vir").DeclarativeElementDefinition<"my-with-events", {}, {}, {
|
|
2
|
-
logoutClick: import("element-vir").DefineEvent<void>;
|
|
3
|
-
randomNumber: import("element-vir").DefineEvent<number>;
|
|
4
|
-
}, "my-with-events-", "my-with-events-", readonly [], readonly []>;
|
|
@@ -1,20 +0,0 @@
|
|
|
1
|
-
import { randomInteger } from '@augment-vir/common';
|
|
2
|
-
import { defineElement } from 'element-vir';
|
|
3
|
-
import { defineElementEvent, html, listen } from '../index.js';
|
|
4
|
-
export const MyWithEvents = defineElement()({
|
|
5
|
-
tagName: 'my-with-events',
|
|
6
|
-
events: {
|
|
7
|
-
logoutClick: defineElementEvent(),
|
|
8
|
-
randomNumber: defineElementEvent(),
|
|
9
|
-
},
|
|
10
|
-
render({ dispatch, events }) {
|
|
11
|
-
return html `
|
|
12
|
-
<button ${listen('click', () => dispatch(new events.logoutClick()))}>log out</button>
|
|
13
|
-
<button
|
|
14
|
-
${listen('click', () => dispatch(new events.randomNumber(randomInteger({ min: 0, max: 1_000_000 }))))}
|
|
15
|
-
>
|
|
16
|
-
generate random number
|
|
17
|
-
</button>
|
|
18
|
-
`;
|
|
19
|
-
},
|
|
20
|
-
});
|
|
@@ -1,3 +0,0 @@
|
|
|
1
|
-
export declare const MyWithHostClassDefinition: import("element-vir").DeclarativeElementDefinition<"my-with-host-class-definition", {}, {
|
|
2
|
-
myProp: string;
|
|
3
|
-
}, {}, "my-with-host-class-definition-a" | "my-with-host-class-definition-automatic", "my-with-host-class-definition-", readonly [], readonly []>;
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
export declare const MyWithHostClassUsage: import("element-vir").DeclarativeElementDefinition<"my-with-host-class-usage", {}, {}, {}, "my-with-host-class-usage-", "my-with-host-class-usage-", readonly [], readonly []>;
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
export declare const MyWithOnDomCreated: import("element-vir").DeclarativeElementDefinition<"my-with-on-dom-created", {}, {}, {}, "my-with-on-dom-created-", "my-with-on-dom-created-", readonly [], readonly []>;
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
export declare const MyWithOnResize: import("element-vir").DeclarativeElementDefinition<"my-with-on-resize", {}, {}, {}, "my-with-on-resize-", "my-with-on-resize-", readonly [], readonly []>;
|
|
@@ -1,18 +0,0 @@
|
|
|
1
|
-
import { defineElement } from 'element-vir';
|
|
2
|
-
import { html, onResize } from '../index.js';
|
|
3
|
-
export const MyWithOnResize = defineElement()({
|
|
4
|
-
tagName: 'my-with-on-resize',
|
|
5
|
-
render() {
|
|
6
|
-
return html `
|
|
7
|
-
<span
|
|
8
|
-
${onResize((entry) => {
|
|
9
|
-
// this will track resizing of this span
|
|
10
|
-
// the entry parameter contains target and contentRect properties
|
|
11
|
-
console.info(entry);
|
|
12
|
-
})}
|
|
13
|
-
>
|
|
14
|
-
Hello there!
|
|
15
|
-
</span>
|
|
16
|
-
`;
|
|
17
|
-
},
|
|
18
|
-
});
|
|
@@ -1,11 +0,0 @@
|
|
|
1
|
-
import { defineElement, html, renderIf } from '../index.js';
|
|
2
|
-
export const MyWithRenderIf = defineElement()({
|
|
3
|
-
tagName: 'my-with-render-if',
|
|
4
|
-
render({ inputs }) {
|
|
5
|
-
return html `
|
|
6
|
-
${renderIf(inputs.shouldRender, html `
|
|
7
|
-
I'm conditionally rendered!
|
|
8
|
-
`)}
|
|
9
|
-
`;
|
|
10
|
-
},
|
|
11
|
-
});
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
export declare const MyWithStylesAndInterpolatedSelector: import("element-vir").DeclarativeElementDefinition<"my-with-styles-and-interpolated-selector", {}, {}, {}, "my-with-styles-and-interpolated-selector-", "my-with-styles-and-interpolated-selector-", readonly [], readonly []>;
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
export declare const MyWithStyles: import("element-vir").DeclarativeElementDefinition<"my-with-styles", {}, {}, {}, "my-with-styles-", "my-with-styles-", readonly [], readonly []>;
|
|
@@ -1,8 +0,0 @@
|
|
|
1
|
-
export declare const MyWithUpdateState: import("element-vir").DeclarativeElementDefinition<"my-with-update-state", {}, {
|
|
2
|
-
username: string;
|
|
3
|
-
/**
|
|
4
|
-
* Use "as" to create state properties that can be types other than the initial value's
|
|
5
|
-
* type. This is particularly useful when, as below, the initial value is undefined.
|
|
6
|
-
*/
|
|
7
|
-
email: string | undefined;
|
|
8
|
-
}, {}, "my-with-update-state-", "my-with-update-state-", readonly [], readonly []>;
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
export {};
|
|
@@ -1,14 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* Set by {@link requireAllCustomElementsToBeDeclarativeElements} and read in the HTML tagged
|
|
3
|
-
* template function.
|
|
4
|
-
*
|
|
5
|
-
* @category Internal
|
|
6
|
-
*/
|
|
7
|
-
export declare let declarativeElementRequired: boolean;
|
|
8
|
-
/**
|
|
9
|
-
* Calling this requires all custom element children to be declarative elements defined by
|
|
10
|
-
* element-vir.
|
|
11
|
-
*
|
|
12
|
-
* @category Util
|
|
13
|
-
*/
|
|
14
|
-
export declare function requireAllCustomElementsToBeDeclarativeElements(): void;
|
|
@@ -1,19 +0,0 @@
|
|
|
1
|
-
import { check } from '@augment-vir/assert';
|
|
2
|
-
/**
|
|
3
|
-
* Checks if the input is an instance of {@link MinimalDefinitionWithInputs}.
|
|
4
|
-
*
|
|
5
|
-
* @category Internal
|
|
6
|
-
*/
|
|
7
|
-
export function isMinimalDefinitionWithInputs(value) {
|
|
8
|
-
return (check.hasKey(value, '_elementVirIsMinimalDefinitionWithInputs') &&
|
|
9
|
-
!!value._elementVirIsMinimalDefinitionWithInputs);
|
|
10
|
-
}
|
|
11
|
-
/**
|
|
12
|
-
* Checks if the input is an object that has a `tagName` property. Used inside of the HTML tagged
|
|
13
|
-
* template functions for checking if interpolated values should be treated as element tags.
|
|
14
|
-
*
|
|
15
|
-
* @category Internal
|
|
16
|
-
*/
|
|
17
|
-
export function hasTagName(value) {
|
|
18
|
-
return check.hasKey(value, 'tagName') && !!value.tagName && typeof value.tagName === 'string';
|
|
19
|
-
}
|
|
@@ -1,6 +0,0 @@
|
|
|
1
|
-
import { type TemplateTransform } from './template-transform-type.js';
|
|
2
|
-
export declare function getAlreadyMappedTemplate<PossibleValues>(templateStringsKey: TemplateStringsArray, values: PossibleValues[]): TemplateTransform | undefined;
|
|
3
|
-
export declare function setMappedTemplate<PossibleValues>(templateStringsKey: TemplateStringsArray, values: PossibleValues[], valueToSet: TemplateTransform): {
|
|
4
|
-
result: boolean;
|
|
5
|
-
reason: string;
|
|
6
|
-
};
|
|
@@ -1,96 +0,0 @@
|
|
|
1
|
-
import { check } from '@augment-vir/assert';
|
|
2
|
-
import { filterMap } from '@augment-vir/common';
|
|
3
|
-
import { hasTagName, isMinimalDefinitionWithInputs } from './minimal-element-definition.js';
|
|
4
|
-
function extractElementKeys(values) {
|
|
5
|
-
return filterMap(values, (value) => {
|
|
6
|
-
if (isMinimalDefinitionWithInputs(value)) {
|
|
7
|
-
return value.definition;
|
|
8
|
-
}
|
|
9
|
-
if (hasTagName(value)) {
|
|
10
|
-
return value.tagInterpolationKey || value;
|
|
11
|
-
}
|
|
12
|
-
return undefined;
|
|
13
|
-
}, check.isTruthy);
|
|
14
|
-
}
|
|
15
|
-
/**
|
|
16
|
-
* The transformed templates are written to a map so that we can preserve reference equality between
|
|
17
|
-
* calls. Without maintaining reference equality between html`` calls, lit-element reconstructs all
|
|
18
|
-
* of its children on every render.
|
|
19
|
-
*
|
|
20
|
-
* This is a WeakMap because we only care about the transformed array value as long as the original
|
|
21
|
-
* template array key exists.
|
|
22
|
-
*/
|
|
23
|
-
const transformedTemplateStrings = new WeakMap();
|
|
24
|
-
export function getAlreadyMappedTemplate(templateStringsKey, values) {
|
|
25
|
-
const elementKeys = extractElementKeys(values);
|
|
26
|
-
const nestedValue = getNestedValues(transformedTemplateStrings, [
|
|
27
|
-
templateStringsKey,
|
|
28
|
-
...elementKeys,
|
|
29
|
-
]);
|
|
30
|
-
return nestedValue.value?.template;
|
|
31
|
-
}
|
|
32
|
-
export function setMappedTemplate(templateStringsKey, values, valueToSet) {
|
|
33
|
-
const elementKeys = extractElementKeys(values);
|
|
34
|
-
return setNestedValues(transformedTemplateStrings, [
|
|
35
|
-
templateStringsKey,
|
|
36
|
-
...elementKeys,
|
|
37
|
-
], valueToSet);
|
|
38
|
-
}
|
|
39
|
-
function getNestedValues(map, keys, index = 0) {
|
|
40
|
-
const { currentTemplateAndNested, reason } = getCurrentKeyAndValue(map, keys, index);
|
|
41
|
-
if (!currentTemplateAndNested) {
|
|
42
|
-
return { value: currentTemplateAndNested, reason };
|
|
43
|
-
}
|
|
44
|
-
if (index === keys.length - 1) {
|
|
45
|
-
return { value: currentTemplateAndNested, reason: `reached end of keys array` };
|
|
46
|
-
}
|
|
47
|
-
if (!currentTemplateAndNested.nested) {
|
|
48
|
-
return { value: undefined, reason: `map at key index ${index} did not have nested maps` };
|
|
49
|
-
}
|
|
50
|
-
return getNestedValues(currentTemplateAndNested.nested, keys, index + 1);
|
|
51
|
-
}
|
|
52
|
-
function getCurrentKeyAndValue(map, keys, index) {
|
|
53
|
-
const currentKey = keys[index];
|
|
54
|
-
if (currentKey == undefined) {
|
|
55
|
-
return {
|
|
56
|
-
currentKey: undefined,
|
|
57
|
-
currentTemplateAndNested: undefined,
|
|
58
|
-
reason: `key at index ${index} not found`,
|
|
59
|
-
};
|
|
60
|
-
}
|
|
61
|
-
if (!map.has(currentKey)) {
|
|
62
|
-
return {
|
|
63
|
-
currentKey,
|
|
64
|
-
currentTemplateAndNested: undefined,
|
|
65
|
-
reason: `key at index ${index} was not in the map`,
|
|
66
|
-
};
|
|
67
|
-
}
|
|
68
|
-
const currentTemplateAndNested = map.get(currentKey);
|
|
69
|
-
if (currentTemplateAndNested == undefined) {
|
|
70
|
-
return {
|
|
71
|
-
currentKey,
|
|
72
|
-
currentTemplateAndNested: undefined,
|
|
73
|
-
reason: `value at key at index ${index} was undefined`,
|
|
74
|
-
};
|
|
75
|
-
}
|
|
76
|
-
return { currentKey, currentTemplateAndNested, reason: `key and value exists` };
|
|
77
|
-
}
|
|
78
|
-
function setNestedValues(map, keys, valueToSet, index = 0) {
|
|
79
|
-
const { currentTemplateAndNested, currentKey, reason } = getCurrentKeyAndValue(map, keys, index);
|
|
80
|
-
if (!currentKey) {
|
|
81
|
-
return { result: false, reason };
|
|
82
|
-
}
|
|
83
|
-
const nestedAndTemplate = currentTemplateAndNested ?? { nested: undefined, template: undefined };
|
|
84
|
-
if (!currentTemplateAndNested) {
|
|
85
|
-
map.set(currentKey, nestedAndTemplate);
|
|
86
|
-
}
|
|
87
|
-
if (index === keys.length - 1) {
|
|
88
|
-
nestedAndTemplate.template = valueToSet;
|
|
89
|
-
return { result: true, reason: `set value at end of keys array` };
|
|
90
|
-
}
|
|
91
|
-
const nestedWeakMap = nestedAndTemplate.nested ?? new WeakMap();
|
|
92
|
-
if (!nestedAndTemplate.nested) {
|
|
93
|
-
nestedAndTemplate.nested = nestedWeakMap;
|
|
94
|
-
}
|
|
95
|
-
return setNestedValues(nestedWeakMap, keys, valueToSet, index + 1);
|
|
96
|
-
}
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
export {};
|
|
@@ -1,14 +0,0 @@
|
|
|
1
|
-
import { type TemplateTransform } from './template-transform-type.js';
|
|
2
|
-
export type ValueInsertion = {
|
|
3
|
-
index: number;
|
|
4
|
-
value: unknown;
|
|
5
|
-
};
|
|
6
|
-
export type ValueTransformCallback = (lastNewString: string, currentLitString: string, currentValue: unknown) => {
|
|
7
|
-
replacement: unknown;
|
|
8
|
-
getExtraValues: ((currentValue: unknown) => unknown[]) | undefined;
|
|
9
|
-
} | undefined;
|
|
10
|
-
export declare function getTransformedTemplate<PossibleValues>(templateStringsKey: TemplateStringsArray, values: PossibleValues[], fallbackTransform: () => TemplateTransform): {
|
|
11
|
-
strings: TemplateStringsArray;
|
|
12
|
-
values: PossibleValues[];
|
|
13
|
-
};
|
|
14
|
-
export declare function transformTemplate<PossibleValues>(inputTemplateStrings: TemplateStringsArray, inputValues: PossibleValues[], transformValue: ValueTransformCallback, assertValidString?: (templateStringPart: string) => void): TemplateTransform;
|
|
@@ -1,4 +0,0 @@
|
|
|
1
|
-
import { type CSSResultGroup } from '../../lit-exports/all-lit-exports.js';
|
|
2
|
-
import { type MinimalElementDefinition } from '../minimal-element-definition.js';
|
|
3
|
-
import { type TemplateTransform } from '../template-transform-type.js';
|
|
4
|
-
export declare function transformCssTemplate(inputTemplateStrings: TemplateStringsArray, inputValues: (number | CSSResultGroup | MinimalElementDefinition)[]): TemplateTransform;
|
|
@@ -1,15 +0,0 @@
|
|
|
1
|
-
/* eslint-disable @typescript-eslint/no-unused-vars */
|
|
2
|
-
import { hasTagName } from '../minimal-element-definition.js';
|
|
3
|
-
import { transformTemplate } from '../transform-template.js';
|
|
4
|
-
function transformCss(...[lastNewString, currentLitString, currentValue,]) {
|
|
5
|
-
if (!hasTagName(currentValue)) {
|
|
6
|
-
return undefined;
|
|
7
|
-
}
|
|
8
|
-
return {
|
|
9
|
-
replacement: currentValue.tagName,
|
|
10
|
-
getExtraValues: undefined,
|
|
11
|
-
};
|
|
12
|
-
}
|
|
13
|
-
export function transformCssTemplate(inputTemplateStrings, inputValues) {
|
|
14
|
-
return transformTemplate(inputTemplateStrings, inputValues, transformCss);
|
|
15
|
-
}
|
|
@@ -1,12 +0,0 @@
|
|
|
1
|
-
import { type CSSResult, type CSSResultGroup } from '../../lit-exports/all-lit-exports.js';
|
|
2
|
-
import { type MinimalElementDefinition } from '../minimal-element-definition.js';
|
|
3
|
-
/**
|
|
4
|
-
* A template literal tag used to define styles for element definitions. In particular, this is used
|
|
5
|
-
* for the `styles` property in an element definitions init object.
|
|
6
|
-
*
|
|
7
|
-
* For security reasons, only literal string or number values may be interpolated inside of this
|
|
8
|
-
* taggedTemplate. To incorporate non-literal values, wrap the value in a call to `unsafeCSS`.
|
|
9
|
-
*
|
|
10
|
-
* @category Element Definition
|
|
11
|
-
*/
|
|
12
|
-
export declare function css(inputTemplateStrings: TemplateStringsArray, ...inputValues: (number | CSSResultGroup | MinimalElementDefinition | CSSResult)[]): CSSResult;
|
|
@@ -1,21 +0,0 @@
|
|
|
1
|
-
import { css as litCss } from 'lit';
|
|
2
|
-
import { getTransformedTemplate } from '../transform-template.js';
|
|
3
|
-
import { transformCssTemplate } from './css-transform.js';
|
|
4
|
-
/**
|
|
5
|
-
* A template literal tag used to define styles for element definitions. In particular, this is used
|
|
6
|
-
* for the `styles` property in an element definitions init object.
|
|
7
|
-
*
|
|
8
|
-
* For security reasons, only literal string or number values may be interpolated inside of this
|
|
9
|
-
* taggedTemplate. To incorporate non-literal values, wrap the value in a call to `unsafeCSS`.
|
|
10
|
-
*
|
|
11
|
-
* @category Element Definition
|
|
12
|
-
*/
|
|
13
|
-
export function css(inputTemplateStrings, ...inputValues) {
|
|
14
|
-
const transformedTemplate = getTransformedTemplate(inputTemplateStrings, inputValues, () => {
|
|
15
|
-
return transformCssTemplate(inputTemplateStrings, inputValues);
|
|
16
|
-
});
|
|
17
|
-
const cssResult = litCss(transformedTemplate.strings,
|
|
18
|
-
/** The filter will remove the DeclarativeElement elements */
|
|
19
|
-
...transformedTemplate.values);
|
|
20
|
-
return cssResult;
|
|
21
|
-
}
|
|
@@ -1,42 +0,0 @@
|
|
|
1
|
-
import { type AnyFunction, type Overwrite } from '@augment-vir/common';
|
|
2
|
-
import { type CSSResult, type TemplateResult, type nothing } from 'lit';
|
|
3
|
-
import { type EmptyObject, type HasRequiredKeys, type IsNever } from 'type-fest';
|
|
4
|
-
import { type DeclarativeElementDefinition } from '../../declarative-element/declarative-element.js';
|
|
5
|
-
import { type Decrement, type Increment } from '../../util/increment.js';
|
|
6
|
-
import { type MinimalDefinitionWithInputs, type MinimalElementDefinition } from '../minimal-element-definition.js';
|
|
7
|
-
/**
|
|
8
|
-
* Unfortunately the type for `DirectiveResult` means it's just an empty object. So in order to
|
|
9
|
-
* block actual objects, we have to narrow `DirectiveResult` further to this empty object type.
|
|
10
|
-
*
|
|
11
|
-
* @category Internal
|
|
12
|
-
*/
|
|
13
|
-
export type DirectiveOutput = EmptyObject;
|
|
14
|
-
/**
|
|
15
|
-
* This is used in order to block accidental object interpolations into HTML, which get stringified
|
|
16
|
-
* into `'[object Object]'`, which nobody ever wants that.
|
|
17
|
-
*
|
|
18
|
-
* @category Internal
|
|
19
|
-
*/
|
|
20
|
-
export type HtmlInterpolation = null | undefined | string | number | boolean | bigint | CSSResult | Readonly<CSSResult> | Element | Readonly<Element> | TemplateResult | Readonly<TemplateResult> | MinimalElementDefinition | Readonly<MinimalElementDefinition> | MinimalDefinitionWithInputs | Readonly<MinimalDefinitionWithInputs> | DeclarativeElementDefinition | Readonly<DeclarativeElementDefinition> | DirectiveOutput | Readonly<DirectiveOutput> | AnyFunction | typeof nothing | HtmlInterpolation[] | ReadonlyArray<HtmlInterpolation>;
|
|
21
|
-
/**
|
|
22
|
-
* This type ensures that interpolated element definitions are not missing their inputs, when inputs
|
|
23
|
-
* are required.
|
|
24
|
-
*
|
|
25
|
-
* @category Internal
|
|
26
|
-
*/
|
|
27
|
-
export type VerifyHtmlValues<Values extends HtmlInterpolation[], WaitingForEndTags extends Record<string, number> = {}> = Values extends [
|
|
28
|
-
infer CurrentDefinition extends DeclarativeElementDefinition,
|
|
29
|
-
...infer Rest extends HtmlInterpolation[]
|
|
30
|
-
] ? CurrentDefinition extends DeclarativeElementDefinition<infer TagName, infer Inputs> ? HasRequiredKeys<Inputs> extends true ? IsNever<Decrement<WaitingForEndTags[TagName]>> extends true ? [
|
|
31
|
-
`ERROR: This element is missing its inputs.`,
|
|
32
|
-
...VerifyHtmlValues<Rest, WaitingForEndTags>
|
|
33
|
-
] : [
|
|
34
|
-
CurrentDefinition,
|
|
35
|
-
...VerifyHtmlValues<Rest, Overwrite<WaitingForEndTags, Record<TagName, Decrement<WaitingForEndTags[TagName]>>>>
|
|
36
|
-
] : [CurrentDefinition, ...VerifyHtmlValues<Rest, WaitingForEndTags>] : [CurrentDefinition, ...VerifyHtmlValues<Rest, WaitingForEndTags>] : Values extends [
|
|
37
|
-
infer CurrentDefinition extends MinimalDefinitionWithInputs,
|
|
38
|
-
...infer Rest extends HtmlInterpolation[]
|
|
39
|
-
] ? [
|
|
40
|
-
CurrentDefinition,
|
|
41
|
-
...VerifyHtmlValues<Rest, Overwrite<WaitingForEndTags, Record<CurrentDefinition['definition']['tagName'], Increment<WaitingForEndTags[CurrentDefinition['definition']['tagName']]>>>>
|
|
42
|
-
] : Values;
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
export {};
|
|
@@ -1,5 +0,0 @@
|
|
|
1
|
-
import { type HTMLTemplateResult } from '../../lit-exports/all-lit-exports.js';
|
|
2
|
-
import { type TemplateTransform } from '../template-transform-type.js';
|
|
3
|
-
import { type HtmlInterpolation } from './html-interpolation.js';
|
|
4
|
-
export declare function mapHtmlValues(inputTemplateStrings: TemplateStringsArray, inputValues: HtmlInterpolation[]): HtmlInterpolation[];
|
|
5
|
-
export declare function transformHtmlTemplate(litTemplate: HTMLTemplateResult): TemplateTransform;
|
|
@@ -1,96 +0,0 @@
|
|
|
1
|
-
/* eslint-disable @typescript-eslint/no-deprecated */
|
|
2
|
-
import { check } from '@augment-vir/assert';
|
|
3
|
-
import { collapseWhiteSpace, getOrSet, safeMatch } from '@augment-vir/common';
|
|
4
|
-
import { assign } from '../../declarative-element/directives/assign.directive.js';
|
|
5
|
-
import { declarativeElementRequired } from '../../require-declarative-element.js';
|
|
6
|
-
import { hasTagName, isMinimalDefinitionWithInputs, } from '../minimal-element-definition.js';
|
|
7
|
-
import { transformTemplate } from '../transform-template.js';
|
|
8
|
-
import { tagNameKeys } from './tag-name-keys.js';
|
|
9
|
-
export function mapHtmlValues(inputTemplateStrings, inputValues) {
|
|
10
|
-
return inputValues.map((currentValue, currentValueIndex) => {
|
|
11
|
-
const lastString = inputTemplateStrings[currentValueIndex];
|
|
12
|
-
const nextString = inputTemplateStrings[currentValueIndex + 1];
|
|
13
|
-
if (lastString && nextString) {
|
|
14
|
-
const { shouldHaveTagNameHere } = classifyValue(lastString, nextString);
|
|
15
|
-
if (shouldHaveTagNameHere && check.isString(currentValue)) {
|
|
16
|
-
const replacement = {
|
|
17
|
-
tagName: currentValue,
|
|
18
|
-
tagInterpolationKey: getOrSet(tagNameKeys, currentValue, () => {
|
|
19
|
-
return { tagName: currentValue };
|
|
20
|
-
}),
|
|
21
|
-
};
|
|
22
|
-
return replacement;
|
|
23
|
-
}
|
|
24
|
-
}
|
|
25
|
-
return currentValue;
|
|
26
|
-
});
|
|
27
|
-
}
|
|
28
|
-
function classifyValue(lastNewString, currentTemplateString) {
|
|
29
|
-
const isOpeningTag = lastNewString.trim().endsWith('<') && !!currentTemplateString.match(/^[\s>]/);
|
|
30
|
-
const isClosingTag = lastNewString.trim().endsWith('</') && currentTemplateString.trim().startsWith('>');
|
|
31
|
-
const shouldHaveTagNameHere = isOpeningTag || isClosingTag;
|
|
32
|
-
return {
|
|
33
|
-
isOpeningTag,
|
|
34
|
-
shouldHaveTagNameHere,
|
|
35
|
-
};
|
|
36
|
-
}
|
|
37
|
-
function transformHtml(...[lastNewString, currentTemplateString, rawCurrentValue,]) {
|
|
38
|
-
const currentValue = isMinimalDefinitionWithInputs(rawCurrentValue)
|
|
39
|
-
? rawCurrentValue.definition
|
|
40
|
-
: rawCurrentValue;
|
|
41
|
-
const { isOpeningTag, shouldHaveTagNameHere } = classifyValue(lastNewString, currentTemplateString);
|
|
42
|
-
const isTagNameWrapper = hasTagName(currentValue);
|
|
43
|
-
if (isTagNameWrapper && shouldHaveTagNameHere && currentValue.tagInterpolationKey) {
|
|
44
|
-
return {
|
|
45
|
-
replacement: currentValue.tagName,
|
|
46
|
-
getExtraValues: undefined,
|
|
47
|
-
};
|
|
48
|
-
}
|
|
49
|
-
if (shouldHaveTagNameHere && !isTagNameWrapper) {
|
|
50
|
-
console.error({
|
|
51
|
-
lastNewString,
|
|
52
|
-
currentTemplateString,
|
|
53
|
-
currentValue,
|
|
54
|
-
});
|
|
55
|
-
throw new Error(`Got interpolated tag name but found no tag name on the given value: '${currentValue?.tagName ||
|
|
56
|
-
currentValue?.prototype?.constructor?.name ||
|
|
57
|
-
currentValue?.constructor?.name}'`);
|
|
58
|
-
}
|
|
59
|
-
if (!shouldHaveTagNameHere || !isTagNameWrapper) {
|
|
60
|
-
return undefined;
|
|
61
|
-
}
|
|
62
|
-
const replacement = currentValue.tagName;
|
|
63
|
-
return {
|
|
64
|
-
replacement,
|
|
65
|
-
getExtraValues(extraValueCurrentValue) {
|
|
66
|
-
const assignedInputs = isMinimalDefinitionWithInputs(extraValueCurrentValue)
|
|
67
|
-
? extraValueCurrentValue.inputs
|
|
68
|
-
: undefined;
|
|
69
|
-
return [
|
|
70
|
-
isOpeningTag && assignedInputs ? assign(assignedInputs) : undefined,
|
|
71
|
-
].filter(check.isTruthy);
|
|
72
|
-
},
|
|
73
|
-
};
|
|
74
|
-
}
|
|
75
|
-
function extractCustomElementTags(input) {
|
|
76
|
-
const tagNameMatches = safeMatch(input, /<\/\s*[^\s><]+\s*>/g);
|
|
77
|
-
return tagNameMatches.reduce((accum, match) => {
|
|
78
|
-
const tagName = collapseWhiteSpace(match.replace(/\n/g, ' ')).replace(/<\/|>/g, '');
|
|
79
|
-
// custom elements always have a dash in them
|
|
80
|
-
if (tagName.includes('-')) {
|
|
81
|
-
return accum.concat(tagName);
|
|
82
|
-
}
|
|
83
|
-
return accum;
|
|
84
|
-
}, []);
|
|
85
|
-
}
|
|
86
|
-
function stringValidator(input) {
|
|
87
|
-
if (declarativeElementRequired) {
|
|
88
|
-
const customElementTagNames = extractCustomElementTags(input);
|
|
89
|
-
if (customElementTagNames.length) {
|
|
90
|
-
console.error(`Custom element tags must be interpolated from declarative elements: ${customElementTagNames.join(', ')}`);
|
|
91
|
-
}
|
|
92
|
-
}
|
|
93
|
-
}
|
|
94
|
-
export function transformHtmlTemplate(litTemplate) {
|
|
95
|
-
return transformTemplate(litTemplate.strings, litTemplate.values, transformHtml, stringValidator);
|
|
96
|
-
}
|
|
@@ -1,7 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* Used to create objects for each interpolated tag name string (tag names that aren't wrapped in a
|
|
3
|
-
* `DeclarativeElementDefinition`) so that we can use them as keys for the mapped template weakmap.
|
|
4
|
-
*/
|
|
5
|
-
export declare const tagNameKeys: Record<string, {
|
|
6
|
-
tagName: string;
|
|
7
|
-
}>;
|
|
@@ -1,11 +0,0 @@
|
|
|
1
|
-
import { type HTMLTemplateResult } from '../../lit-exports/all-lit-exports.js';
|
|
2
|
-
import { type HtmlInterpolation, type VerifyHtmlValues } from './html-interpolation.js';
|
|
3
|
-
/**
|
|
4
|
-
* Interprets a template literal as an HTML template which is lazily rendered to the DOM.
|
|
5
|
-
*
|
|
6
|
-
* Wraps lit-html's html tagged template and enables interpolations of
|
|
7
|
-
* `DeclarativeElementDefinition` for tag names.
|
|
8
|
-
*
|
|
9
|
-
* @category Element Definition
|
|
10
|
-
*/
|
|
11
|
-
export declare function html<const Values extends HtmlInterpolation[]>(inputTemplateStrings: TemplateStringsArray, ...inputValues: VerifyHtmlValues<Values>): HTMLTemplateResult;
|
|
@@ -1,55 +0,0 @@
|
|
|
1
|
-
import { type NonEmptyString } from '../util/type.js';
|
|
2
|
-
/**
|
|
3
|
-
* A custom event with strict types for details and the event's `type` property.
|
|
4
|
-
*
|
|
5
|
-
* @category Internal
|
|
6
|
-
*/
|
|
7
|
-
export declare class TypedEvent<EventTypeNameGeneric extends string = '', EventDetailGeneric = undefined> extends CustomEvent<EventDetailGeneric> {
|
|
8
|
-
readonly _type: EventTypeNameGeneric;
|
|
9
|
-
get type(): EventTypeNameGeneric;
|
|
10
|
-
constructor(type: EventTypeNameGeneric | {
|
|
11
|
-
type: EventTypeNameGeneric;
|
|
12
|
-
}, value: EventDetailGeneric);
|
|
13
|
-
}
|
|
14
|
-
/**
|
|
15
|
-
* A function that defines a typed event, used for defining element events in an element's
|
|
16
|
-
* definition.
|
|
17
|
-
*
|
|
18
|
-
* @category Internal
|
|
19
|
-
*/
|
|
20
|
-
export type DefineEvent<EventDetailGeneric> = <EventTypeNameGeneric extends string>(eventType: NonEmptyString<EventTypeNameGeneric>) => DefinedTypedEvent<EventTypeNameGeneric, EventDetailGeneric>;
|
|
21
|
-
/**
|
|
22
|
-
* A concrete typed event definition.
|
|
23
|
-
*
|
|
24
|
-
* @category Internal
|
|
25
|
-
*/
|
|
26
|
-
export type DefinedTypedEvent<EventTypeNameGeneric extends string, EventDetailGeneric> = (new (eventValue: EventDetailGeneric) => TypedEvent<EventTypeNameGeneric, EventDetailGeneric>) & {
|
|
27
|
-
type: EventTypeNameGeneric;
|
|
28
|
-
};
|
|
29
|
-
/**
|
|
30
|
-
* Define a stand-alone typed event that can be emitted and listened to inside of HTML templates.
|
|
31
|
-
*
|
|
32
|
-
* Make sure to use currying and call this function twice! (This is required by TypeScript's type
|
|
33
|
-
* parameter inference system.)
|
|
34
|
-
*
|
|
35
|
-
* @category Element Definition
|
|
36
|
-
* @example
|
|
37
|
-
*
|
|
38
|
-
* ```ts
|
|
39
|
-
* import {defineTypedEvent} from 'element-vir';
|
|
40
|
-
*
|
|
41
|
-
* const myCustomEvent = defineTypedEvent<number>()('my-custom-event');
|
|
42
|
-
*
|
|
43
|
-
* const myCustomEvent2 = defineTypedEvent<// the event's `.detail` type
|
|
44
|
-
* number>()(
|
|
45
|
-
* // the event's `.type` string
|
|
46
|
-
* 'my-custom-event2',
|
|
47
|
-
* );
|
|
48
|
-
* ```
|
|
49
|
-
*/
|
|
50
|
-
export declare function defineTypedEvent<EventDetailGeneric>(): <
|
|
51
|
-
/**
|
|
52
|
-
* EventTypeNameGeneric is used for the event type property but not for the event value
|
|
53
|
-
* type... so it's named "name" instead of "type" cause type is overloaded here.
|
|
54
|
-
*/
|
|
55
|
-
EventTypeNameGeneric extends string>(eventType: NonEmptyString<EventTypeNameGeneric>) => DefinedTypedEvent<EventTypeNameGeneric, EventDetailGeneric>;
|
|
@@ -1,50 +0,0 @@
|
|
|
1
|
-
/**
|
|
2
|
-
* A custom event with strict types for details and the event's `type` property.
|
|
3
|
-
*
|
|
4
|
-
* @category Internal
|
|
5
|
-
*/
|
|
6
|
-
export class TypedEvent extends CustomEvent {
|
|
7
|
-
_type = '';
|
|
8
|
-
get type() {
|
|
9
|
-
return this._type;
|
|
10
|
-
}
|
|
11
|
-
constructor(type, value) {
|
|
12
|
-
super(typeof type === 'string' ? type : type.type, {
|
|
13
|
-
detail: value,
|
|
14
|
-
bubbles: true,
|
|
15
|
-
composed: true,
|
|
16
|
-
});
|
|
17
|
-
}
|
|
18
|
-
}
|
|
19
|
-
/**
|
|
20
|
-
* Define a stand-alone typed event that can be emitted and listened to inside of HTML templates.
|
|
21
|
-
*
|
|
22
|
-
* Make sure to use currying and call this function twice! (This is required by TypeScript's type
|
|
23
|
-
* parameter inference system.)
|
|
24
|
-
*
|
|
25
|
-
* @category Element Definition
|
|
26
|
-
* @example
|
|
27
|
-
*
|
|
28
|
-
* ```ts
|
|
29
|
-
* import {defineTypedEvent} from 'element-vir';
|
|
30
|
-
*
|
|
31
|
-
* const myCustomEvent = defineTypedEvent<number>()('my-custom-event');
|
|
32
|
-
*
|
|
33
|
-
* const myCustomEvent2 = defineTypedEvent<// the event's `.detail` type
|
|
34
|
-
* number>()(
|
|
35
|
-
* // the event's `.type` string
|
|
36
|
-
* 'my-custom-event2',
|
|
37
|
-
* );
|
|
38
|
-
* ```
|
|
39
|
-
*/
|
|
40
|
-
export function defineTypedEvent() {
|
|
41
|
-
return (eventType) => {
|
|
42
|
-
return class extends TypedEvent {
|
|
43
|
-
static type = eventType;
|
|
44
|
-
_type = eventType;
|
|
45
|
-
constructor(value) {
|
|
46
|
-
super(eventType, value);
|
|
47
|
-
}
|
|
48
|
-
};
|
|
49
|
-
};
|
|
50
|
-
}
|