diff --git a/README.md b/README.md index 112538a..b15f967 100644 --- a/README.md +++ b/README.md @@ -135,7 +135,7 @@ this.setAttribute('my-name','hello'); Therefore, this will tell the browser that the UI needs a render if the attribute is one of the component's observed attributes we explicitly provided with `static properties = ['my-name']`; > The `props` property of `WebComponent` works like `HTMLElement.dataset`, except `dataset` is only for attributes prefixed with `data-`. A camelCase counterpart using `props` will give read/write access to any attribute, with or without the `data-` prefix. -> However, note that like `HTMLElement.dataset`, values assigned to properties using `WebComponent.props` is always converted into string. This will be improved in later versions. +> Another advantage over `HTMLElement.dataset` is that `WebComponent.props` can hold primitive types `number`, `boolean`, and `string`. ### Alternatives diff --git a/demo/BooleanPropTest.mjs b/examples/demo/BooleanPropTest.mjs similarity index 100% rename from demo/BooleanPropTest.mjs rename to examples/demo/BooleanPropTest.mjs diff --git a/demo/Counter.mjs b/examples/demo/Counter.mjs similarity index 100% rename from demo/Counter.mjs rename to examples/demo/Counter.mjs diff --git a/demo/HelloWorld.mjs b/examples/demo/HelloWorld.mjs similarity index 100% rename from demo/HelloWorld.mjs rename to examples/demo/HelloWorld.mjs diff --git a/demo/SimpleText.mjs b/examples/demo/SimpleText.mjs similarity index 100% rename from demo/SimpleText.mjs rename to examples/demo/SimpleText.mjs diff --git a/demo/index.html b/examples/demo/index.html similarity index 100% rename from demo/index.html rename to examples/demo/index.html diff --git a/examples/type-restore/Counter.mjs b/examples/type-restore/Counter.mjs new file mode 100644 index 0000000..c45d41d --- /dev/null +++ b/examples/type-restore/Counter.mjs @@ -0,0 +1,20 @@ +// @ts-check +import WebComponent from "../src/WebComponent.js"; + +export class Counter extends WebComponent { + static properties = ["count"]; + onInit() { + this.props.count = 1; + let i = 1 + this.onclick = ()=> ++this.props.count + let double = () => i * 2; + console.log(double()); + i = 3; + console.log(double()); + } + get template() { + return ``; + } +} + +customElements.define("my-counter", Counter); diff --git a/examples/type-restore/HelloWorld.mjs b/examples/type-restore/HelloWorld.mjs new file mode 100644 index 0000000..d2fe04e --- /dev/null +++ b/examples/type-restore/HelloWorld.mjs @@ -0,0 +1,14 @@ +import WebComponent from "../src/WebComponent.js"; + +export class HelloWorld extends WebComponent { + static properties = ["name"]; + onInit() { + this.props.name = 'a'; + this.onclick = ()=> this.props.name += 'a' + } + get template() { + return ``; + } +} + +customElements.define("my-hello-world", HelloWorld); diff --git a/examples/type-restore/Object.mjs b/examples/type-restore/Object.mjs new file mode 100644 index 0000000..0e2800a --- /dev/null +++ b/examples/type-restore/Object.mjs @@ -0,0 +1,15 @@ +import WebComponent from "../src/WebComponent.js"; + +export class ObjectText extends WebComponent { + static properties = ["object"]; + onInit() { + this.props.object = { + hello: 'world' + }; + } + get template() { + return ``; + } +} + +customElements.define("my-object", ObjectText); diff --git a/examples/type-restore/Toggle.mjs b/examples/type-restore/Toggle.mjs new file mode 100644 index 0000000..3468643 --- /dev/null +++ b/examples/type-restore/Toggle.mjs @@ -0,0 +1,18 @@ +// @ts-check +import WebComponent from "../src/WebComponent.js"; + +export class Toggle extends WebComponent { + static properties = ["toggle"]; + onInit() { + this.props.toggle = false; + this.onclick = ()=>this.handleToggle() + } + handleToggle() { + this.props.toggle = !this.props.toggle; + } + get template() { + return ``; + } +} + +customElements.define("my-toggle", Toggle); diff --git a/examples/type-restore/index.html b/examples/type-restore/index.html new file mode 100644 index 0000000..9d3bad5 --- /dev/null +++ b/examples/type-restore/index.html @@ -0,0 +1,31 @@ + + + + + + WC demo + + + + + + + +
+ Counter: +
+ + + diff --git a/package-lock.json b/package-lock.json index a2b0684..8745d87 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { "name": "web-component-base", - "version": "1.13.2", + "version": "1.13.3", "lockfileVersion": 3, "requires": true, "packages": { "": { "name": "web-component-base", - "version": "1.13.2", + "version": "1.13.3", "license": "MIT", "workspaces": [ "site" diff --git a/package.json b/package.json index 083ec99..ccb6a9b 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "web-component-base", - "version": "1.13.2", + "version": "1.13.3", "description": "A zero-dependency, ~600 Bytes (minified & gzipped), JS base class for creating reactive custom elements easily", "main": "WebComponent.js", "type": "module", diff --git a/site/src/components/call-to-action.html b/site/src/components/call-to-action.html index 046e081..96069d1 100644 --- a/site/src/components/call-to-action.html +++ b/site/src/components/call-to-action.html @@ -16,7 +16,7 @@ & a { border: 3px solid var(--color-fade); - padding: 0.75em; + padding: 0.5em 0.75em; border-radius: 5px; text-align: center; text-decoration: none; @@ -28,7 +28,7 @@ &#primary { background: #3054bf; color: white; - width: 40%; + min-width: 35%; } } } diff --git a/site/src/pages/index.html b/site/src/pages/index.html index bae4099..b5bd232 100644 --- a/site/src/pages/index.html +++ b/site/src/pages/index.html @@ -25,11 +25,11 @@ {{ project.description }}
-
+

- By extending our WebComponent base class, you get an easy authoring experience as you would expect in writing your components

+ By extending our base class, you get an easy authoring experience as you would expect in writing your components:

    -
  • A signals-like props API that keeps your property changes and UI in sync
    • +
  • A props API that synchronizes your components' property values and HTML attributes
  • Sensible life-cycle hooks that you understand and remember
  • Extensible templates & renderer (examples in-progress)
  • Provided out-of-the-box with McFly, a powerful no-framework framework
    • diff --git a/src/WebComponent.js b/src/WebComponent.js index 526975f..32dd0ef 100644 --- a/src/WebComponent.js +++ b/src/WebComponent.js @@ -87,74 +87,79 @@ export class WebComponent extends HTMLElement { this.onDestroy(); } - attributeChangedCallback(property, previousValue, currentValue) { + attributeChangedCallback(property, previousValue, currentValue) { const camelCaps = this.#getCamelCaps(property); if (previousValue !== currentValue) { this[property] = currentValue === "" || currentValue; this[camelCaps] = this[property]; // remove on v2 - this.props[camelCaps] = { - attributeChanged: true, - value: this[property], - } + + this.#handleUpdateProp(camelCaps, currentValue); this.render(); this.onChanges({ property, previousValue, currentValue }); } } - + + #handleUpdateProp(key, value) { + const restored = this.#restoreType(value, this.#typeMap[key]); + + if (restored !== this.props[key]) this.props[key] = value; + } + #getCamelCaps(kebab) { return kebab.replace(/-./g, (x) => x[1].toUpperCase()); } - #typeMap = {} - #handler = (setter, typeMap) => ({ - set(obj, prop, value) { - const attributeChanged = value?.attributeChanged ?? false; - let newValue = attributeChanged ? value.value : value; - const oldValue = obj[prop]; - - console.log(">>>", newValue, oldValue); + #typeMap = {}; - if (!(prop in typeMap)) { - typeMap[prop] = typeof newValue; - } + #restoreType = (value, type) => { + switch (type) { + case "string": + return value; + case "number": + case "boolean": + return JSON.parse(value); + default: + return value; + } + }; - obj[prop] = restoreType(newValue, typeMap[prop]) + #handler(setter, typeMap) { + const getKebab = (str) => { + return str.replace( + /[A-Z]+(?![a-z])|[A-Z]/g, + ($, ofs) => (ofs ? "-" : "") + $.toLowerCase() + ); + }; - if (attributeChanged && !oldValue != newValue) { - const kebab = getKebab(prop); - setter(kebab, newValue); - } + return { + set(obj, prop, value) { + const oldValue = obj[prop]; - - function getKebab(str) { - return str.replace( - /[A-Z]+(?![a-z])|[A-Z]/g, - ($, ofs) => (ofs ? "-" : "") + $.toLowerCase() - ); - } - - function restoreType(value, type) { - switch(type) { - case 'string': return value; - case 'number': return parseInt(value); - case 'boolean': return JSON.parse(value); - default: return value + if (!(prop in typeMap)) { + typeMap[prop] = typeof value; } - } + if (oldValue !== value) { + obj[prop] = value; + const kebab = getKebab(prop); + setter(kebab, value); + } - - return true; - }, - }); + return true; + }, + }; + } #initializeProps() { if (!this.#props) { this.#props = new Proxy( {}, - this.#handler((key, value) => this.setAttribute(key, value), this.#typeMap) + this.#handler( + (key, value) => this.setAttribute(key, value), + this.#typeMap + ) ); } }