Compare commits
368 commits
Author | SHA1 | Date | |
---|---|---|---|
ceda1c0efd | |||
68caacda23 | |||
c0b3350bd2 | |||
9abf7fcc6b | |||
f18acf0210 | |||
bd01d8741f | |||
58e9d14b79 | |||
21e49895cf | |||
82c2dea893 | |||
b6104ad1a1 | |||
69c2e990d6 | |||
6f11f6fe85 | |||
e0e3151727 | |||
f98119162f | |||
64113c242c | |||
fdcb837382 | |||
5aa5ee44fa | |||
fca8f06803 | |||
20c716d78d | |||
114ce87a41 | |||
0c7cc10750 | |||
c8c8eb90f3 | |||
8d46650c27 | |||
ea4cca1958 | |||
822c4d3984 | |||
fdc3b428e5 | |||
2a11ac1d77 | |||
822fdf95a3 | |||
422b7a2e06 | |||
4c8be71875 | |||
e80b157d9d | |||
73a4c18f45 | |||
d9bcb019bc | |||
a96d161e02 | |||
36a77bf477 | |||
7194eac159 | |||
9651de9cf4 | |||
30483becc5 | |||
19240d79c7 | |||
b5bd559e35 | |||
7800df29da | |||
379addc4be | |||
519573916c | |||
3358e7c805 | |||
77b53dbbda | |||
a2945c3880 | |||
facf11d294 | |||
908591b6b7 | |||
3e896ada83 | |||
6d05547ed5 | |||
6cd461ae4e | |||
583ff6e35a | |||
ca0de74f6a | |||
8a63ed56f5 | |||
ab8156a2b0 | |||
d5606cdd44 | |||
a35e1901f0 | |||
3056e84d4c | |||
35b8b5539b | |||
77a2c63c19 | |||
b1cfdb4a9f | |||
6e30abbaa0 | |||
7dda6c86d0 | |||
3e697027f3 | |||
e125586487 | |||
9ead44babe | |||
d41affd709 | |||
a281017d63 | |||
ddf9b6d360 | |||
2043893b6a | |||
9058ee63e5 | |||
d7ec75386d | |||
76320df77c | |||
1d46484ca7 | |||
a9a190c574 | |||
eb235ed96a | |||
510db20ab2 | |||
87eeed06f1 | |||
c6d9792ad2 | |||
7c2c4473d1 | |||
37fdbbc187 | |||
6cee66e26d | |||
0cfeb51554 | |||
f08391d13f | |||
2a24028043 | |||
d10a164998 | |||
ee0df6a7b0 | |||
b0738b0c37 | |||
c69cee4a36 | |||
da6c563eee | |||
e7b2a23cf4 | |||
1610683a70 | |||
f4102f17f3 | |||
ea95bf47b8 | |||
fbf311ba4f | |||
f3e4d28719 | |||
a254cdc669 | |||
a78c67fa2f | |||
833e835f65 | |||
ae2df5096d | |||
7fcbbfb28d | |||
5020713fa7 | |||
8c46683527 | |||
3ab877e869 | |||
4f6f441b3b | |||
6f0ad3e1d5 | |||
a18cf3ca22 | |||
aa59785806 | |||
eb115d25ea | |||
1443b15b4d | |||
87c1c9faca | |||
4445d04208 | |||
8723290d90 | |||
d15746a91a | |||
37ff3f9cf2 | |||
![]() |
88299332aa | ||
![]() |
da83077ec8 | ||
![]() |
ce157f9f63 | ||
![]() |
0c5d4ef15f | ||
![]() |
29dc82b0c3 | ||
![]() |
5e50df8613 | ||
![]() |
162b468d8d | ||
![]() |
1c2ad3b5e0 | ||
![]() |
e3d6b2783c | ||
![]() |
96b4c9f76b | ||
![]() |
d1a5462f4a | ||
![]() |
82cf06df62 | ||
![]() |
41b4a32673 | ||
![]() |
9d8ff3b453 | ||
![]() |
af1ef22042 | ||
![]() |
4ab63c4da0 | ||
![]() |
a2c34bdc81 | ||
![]() |
d42fbc0e40 | ||
![]() |
2f46ad3c67 | ||
![]() |
e78030ab13 | ||
![]() |
29fa864ca2 | ||
![]() |
d4dcea4503 | ||
![]() |
4cdaddf858 | ||
![]() |
879032aa1e | ||
![]() |
deda46ed9c | ||
![]() |
83f30ae2c4 | ||
9c41f2e29a | |||
264a5cf0cf | |||
![]() |
5bd5164c44 | ||
![]() |
4222257633 | ||
![]() |
64fd600435 | ||
![]() |
43b526a870 | ||
![]() |
aee0ec74aa | ||
![]() |
9eae4e5b8a | ||
![]() |
0c9df45ecc | ||
![]() |
3b1df66734 | ||
![]() |
6ce0db7e71 | ||
![]() |
aa7d5a645b | ||
![]() |
03a72b111c | ||
![]() |
006fd4ba73 | ||
![]() |
2a60e95a3d | ||
![]() |
c606857f4d | ||
![]() |
8b074a3495 | ||
![]() |
f984e6f595 | ||
![]() |
99eb2e0e26 | ||
![]() |
9268676797 | ||
![]() |
c4a5d7d6e6 | ||
![]() |
df99804bab | ||
![]() |
21bc13f40f | ||
![]() |
d1b76de35a | ||
![]() |
f0b4f8a0a7 | ||
![]() |
b4addc511d | ||
![]() |
1b0072a45d | ||
![]() |
47ee0ef2a9 | ||
![]() |
7cc1026ccb | ||
![]() |
1879c36350 | ||
![]() |
6379334335 | ||
![]() |
f82aed7f26 | ||
![]() |
fae9ed2cd3 | ||
![]() |
ad467ded5e | ||
![]() |
63c1ee6b24 | ||
![]() |
5720901d25 | ||
![]() |
ce1733c7ca | ||
![]() |
2a562a3b39 | ||
![]() |
d290fc90a0 | ||
![]() |
8aabf89208 | ||
![]() |
45180dc681 | ||
![]() |
dcb9222bf9 | ||
![]() |
a35f5a086e | ||
![]() |
a0f62d65d4 | ||
42f8b75781 | |||
fa249b53d4 | |||
![]() |
5cc52e66f4 | ||
![]() |
48bf30ea7b | ||
![]() |
dc829269a6 | ||
![]() |
041aed195e | ||
![]() |
79ce197c8a | ||
![]() |
01c9a4f170 | ||
![]() |
06d41cd78b | ||
![]() |
8418287e1d | ||
![]() |
a6c292ff68 | ||
![]() |
6d52a3bea0 | ||
![]() |
5eafd01827 | ||
![]() |
4c885ccf9d | ||
![]() |
4d4fdb3d89 | ||
![]() |
488743e011 | ||
![]() |
6eb93b5dd3 | ||
![]() |
ec50f0f86e | ||
![]() |
538aa01ecd | ||
![]() |
669fee1d49 | ||
![]() |
6844ffe9f2 | ||
![]() |
27a5fb3024 | ||
![]() |
b4f3b98ee4 | ||
![]() |
7bf37d75db | ||
![]() |
956424cbaf | ||
![]() |
26129a5934 | ||
![]() |
07bb2d850a | ||
![]() |
75f914606f | ||
![]() |
bea93f69f7 | ||
![]() |
98c89624f9 | ||
![]() |
7500f0c3fe | ||
![]() |
85284e9e42 | ||
![]() |
3c1b3b0893 | ||
![]() |
00648883fa | ||
![]() |
000e3811cd | ||
![]() |
2ac38747cb | ||
![]() |
f56068e76e | ||
![]() |
b613d8e77c | ||
![]() |
703ef9e45d | ||
![]() |
1ae5fa7535 | ||
![]() |
84c4a00fb8 | ||
![]() |
d7651b5f33 | ||
![]() |
d6755dd9e3 | ||
![]() |
d3dc78e75c | ||
![]() |
91356bde9f | ||
![]() |
b5b4243f6d | ||
![]() |
c3957862ad | ||
![]() |
6ae5961c4f | ||
![]() |
8829bd28aa | ||
![]() |
fd72c6d097 | ||
![]() |
7632f96f69 | ||
![]() |
2943aa4c37 | ||
![]() |
78ebd0058e | ||
![]() |
73dd374a3e | ||
![]() |
54a3819b83 | ||
![]() |
dd6dc96f1b | ||
![]() |
c9dd590931 | ||
![]() |
3e8334f2c1 | ||
![]() |
766cf65b4a | ||
![]() |
5cbd65090b | ||
![]() |
9480f37844 | ||
![]() |
da85a71aec | ||
![]() |
b3189e2c6e | ||
![]() |
6027f664b3 | ||
![]() |
0209095d0a | ||
![]() |
7c3c98d382 | ||
![]() |
238fd3e071 | ||
![]() |
82c11ea1d5 | ||
![]() |
f4e74474c8 | ||
![]() |
bda00b51b3 | ||
![]() |
07cacab1e9 | ||
![]() |
9fbea956e0 | ||
![]() |
80b678da27 | ||
![]() |
0140f79339 | ||
![]() |
fa506c8c0f | ||
![]() |
d392b1a0ca | ||
![]() |
15a3b1ce33 | ||
![]() |
2e87077ff6 | ||
![]() |
1b297859db | ||
![]() |
851df8da14 | ||
![]() |
44617ed999 | ||
![]() |
d0e458ff87 | ||
![]() |
a96047d680 | ||
![]() |
278f1de61d | ||
![]() |
3e87327440 | ||
![]() |
b5bb13a7d2 | ||
![]() |
98d47af7dc | ||
![]() |
eeb0b1ef59 | ||
![]() |
bce526f17e | ||
![]() |
31cd515498 | ||
![]() |
ad359a60ef | ||
![]() |
a7f3dfaf8e | ||
![]() |
d56d7593f8 | ||
![]() |
3828c0392e | ||
![]() |
51110f46ed | ||
![]() |
f8aac1420f | ||
![]() |
9cc7959609 | ||
![]() |
e33d56c1fb | ||
![]() |
e57ac4f9b3 | ||
![]() |
b0f9e11ea5 | ||
![]() |
d6c0e46649 | ||
![]() |
bdc0fb88f9 | ||
![]() |
3e79455ccb | ||
![]() |
dfd19a7484 | ||
![]() |
ad3994119c | ||
![]() |
fcc6748819 | ||
![]() |
de673e2f12 | ||
![]() |
9d539f32a3 | ||
![]() |
60a3c75df0 | ||
![]() |
4fb97836c3 | ||
![]() |
ac6827e4cb | ||
![]() |
e7b86df07b | ||
![]() |
5a71651abc | ||
![]() |
29c26be58c | ||
![]() |
7716348c9f | ||
![]() |
fce411f7f4 | ||
![]() |
b8565ef3d1 | ||
![]() |
2c285a60bb | ||
![]() |
5799f8ea4e | ||
![]() |
c4d4b3e699 | ||
![]() |
a9f5189b7f | ||
![]() |
a3845b7e7c | ||
![]() |
d54ff6fa94 | ||
![]() |
341424187b | ||
![]() |
f8ca80da72 | ||
![]() |
12acf83c8c | ||
![]() |
74e7c16335 | ||
![]() |
2affb0697c | ||
![]() |
10b2c09bac | ||
![]() |
b9c66923c9 | ||
![]() |
85944641fe | ||
![]() |
60008bf07e | ||
![]() |
307670bf11 | ||
![]() |
6869ccb3e7 | ||
![]() |
a3fcf4572f | ||
![]() |
8343fded9c | ||
![]() |
3e828912db | ||
![]() |
463136eea8 | ||
![]() |
1fb893a03f | ||
![]() |
b73a62dc35 | ||
![]() |
fad385d5b6 | ||
![]() |
53817036d9 | ||
![]() |
a388ea7dc9 | ||
![]() |
2616591315 | ||
![]() |
63175c6c9f | ||
![]() |
693c35d082 | ||
![]() |
3d31b41f53 | ||
![]() |
910a5096d0 | ||
![]() |
003b72a1f2 | ||
![]() |
aabbb09c89 | ||
![]() |
bef423fde1 | ||
![]() |
670c882e44 | ||
![]() |
d3573ec5b2 | ||
![]() |
859260f578 | ||
![]() |
bfacf84b45 | ||
![]() |
b74ee310da | ||
![]() |
2423dc6887 | ||
![]() |
157e9ed8cb | ||
![]() |
1172247693 | ||
![]() |
d0e144953a | ||
![]() |
4aaa93e57a | ||
![]() |
feed3f7005 | ||
![]() |
12ef8fe02f | ||
![]() |
4e533009df | ||
![]() |
7eb067f923 | ||
![]() |
316433b1d0 | ||
![]() |
3633b49e4d | ||
![]() |
18b34019ba | ||
![]() |
1415c82113 | ||
![]() |
3d1e92b36a | ||
![]() |
39180f45f2 | ||
![]() |
e61f033520 | ||
![]() |
61e4dadb41 | ||
![]() |
09ffc5d99c | ||
![]() |
884da7e2aa | ||
![]() |
4d266891a8 | ||
![]() |
8c06069b25 | ||
![]() |
42ad333201 | ||
![]() |
9b37dfa0de | ||
![]() |
3fff13c08a | ||
![]() |
b5cb00d26f | ||
![]() |
5ee41e9a1d | ||
![]() |
53fc70aa96 |
35
.build.yml
Normal file
|
@ -0,0 +1,35 @@
|
||||||
|
image: alpine/edge
|
||||||
|
packages:
|
||||||
|
- nodejs
|
||||||
|
- npm
|
||||||
|
- pnpm
|
||||||
|
secrets:
|
||||||
|
- 34883663-8684-41cb-9920-8e96345ef166
|
||||||
|
- bbfcb6dc-7c4a-42ee-a11a-022f0339a133
|
||||||
|
environment:
|
||||||
|
NETLIFY_SITE_ID: bfd69adf-f754-433c-9690-63426f0d2fa0
|
||||||
|
GH_USER: ayoayco
|
||||||
|
REPO: wcb
|
||||||
|
tasks:
|
||||||
|
- push-mirror: |
|
||||||
|
cd ~/"${REPO}"
|
||||||
|
git config --global credential.helper store
|
||||||
|
git push --mirror "https://github.com/${GH_USER}/${REPO}"
|
||||||
|
- install-deps: |
|
||||||
|
cd ~/"${REPO}"
|
||||||
|
pnpm i --ignore-scripts
|
||||||
|
- test: |
|
||||||
|
cd ~/"${REPO}"
|
||||||
|
npx vitest run
|
||||||
|
- build: |
|
||||||
|
cd ~/"${REPO}"
|
||||||
|
pnpm -F docs build
|
||||||
|
- deploy: |
|
||||||
|
cd wcb
|
||||||
|
{
|
||||||
|
set +x
|
||||||
|
. ~/.buildsecrets
|
||||||
|
set -x
|
||||||
|
}
|
||||||
|
export NETLIFY_AUTH_TOKEN
|
||||||
|
pnpm -F docs run deploy
|
10
.gitignore
vendored
|
@ -6,3 +6,13 @@ dist/
|
||||||
*swo
|
*swo
|
||||||
*swp
|
*swp
|
||||||
|
|
||||||
|
# nitro site
|
||||||
|
*.log*
|
||||||
|
.nitro
|
||||||
|
.cache
|
||||||
|
.output
|
||||||
|
.env
|
||||||
|
.eslintcache
|
||||||
|
|
||||||
|
# vitest
|
||||||
|
coverage
|
4
.husky/pre-commit
Executable file
|
@ -0,0 +1,4 @@
|
||||||
|
npm run lint --cache
|
||||||
|
npm run test
|
||||||
|
npm run build
|
||||||
|
npx size-limit
|
19
.npmignore
Normal file
|
@ -0,0 +1,19 @@
|
||||||
|
node_modules/
|
||||||
|
examples/
|
||||||
|
assets/
|
||||||
|
src/
|
||||||
|
.vscode/
|
||||||
|
tsconfig.json
|
||||||
|
|
||||||
|
# temporary files
|
||||||
|
*~
|
||||||
|
*swo
|
||||||
|
*swp
|
||||||
|
|
||||||
|
# nitro site
|
||||||
|
site/
|
||||||
|
*.log*
|
||||||
|
.nitro
|
||||||
|
.cache
|
||||||
|
.output
|
||||||
|
.env
|
7
.prettierignore
Normal file
|
@ -0,0 +1,7 @@
|
||||||
|
# someday let's think about formatting html
|
||||||
|
**/*.html
|
||||||
|
|
||||||
|
**/*.md
|
||||||
|
**/*.css
|
||||||
|
**/*.yml
|
||||||
|
**/*.yaml
|
3
.vscode/settings.json
vendored
|
@ -1,3 +1,4 @@
|
||||||
{
|
{
|
||||||
"editor.formatOnSave": true
|
"js/ts.implicitProjectConfig.checkJs": true,
|
||||||
|
"editor.formatOnSave": true
|
||||||
}
|
}
|
21
LICENSE
Normal file
|
@ -0,0 +1,21 @@
|
||||||
|
MIT License
|
||||||
|
|
||||||
|
Copyright (c) 2023 Ayo Ayco
|
||||||
|
|
||||||
|
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||||
|
of this software and associated documentation files (the "Software"), to deal
|
||||||
|
in the Software without restriction, including without limitation the rights
|
||||||
|
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||||
|
copies of the Software, and to permit persons to whom the Software is
|
||||||
|
furnished to do so, subject to the following conditions:
|
||||||
|
|
||||||
|
The above copyright notice and this permission notice shall be included in all
|
||||||
|
copies or substantial portions of the Software.
|
||||||
|
|
||||||
|
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||||
|
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||||
|
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||||
|
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||||
|
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||||
|
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||||
|
SOFTWARE.
|
231
README.md
|
@ -1,226 +1,39 @@
|
||||||
> **>>> TL;DR:** This provides a minimal vanilla JS base class that aims to reduce the complexity of creating reactive custom elements. See the [Quick Start Example](#quick-start-example)
|
# Web Component Base
|
||||||
|
|
||||||
Web Component Base
|
|
||||||
---
|
|
||||||
[](https://www.npmjs.com/package/web-component-base)
|
[](https://www.npmjs.com/package/web-component-base)
|
||||||
[](https://www.npmjs.com/package/web-component-base)
|
[](https://www.npmjs.com/package/web-component-base)
|
||||||
[](https://www.npmjs.com/package/web-component-base)
|
[](https://www.npmjs.com/package/web-component-base)
|
||||||
|
[](#library-size)
|
||||||
|
|
||||||
|
🤷♂️ zero-dependency, 🤏 tiny JS base class for creating reactive [custom elements](https://developer.mozilla.org/en-US/docs/Web/API/Web_Components/Using_custom_elements) easily ✨
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
When you extend the `WebComponent` class for your component, you only have to define the `template` and `properties`. Any change in any property value will automatically cause just the component UI to render.
|
When you extend the `WebComponent` class for your component, you only have to define the `template` and `properties`. Any change in any property value will automatically cause just the component UI to render.
|
||||||
|
|
||||||
The result is a reactive UI on property changes.
|
The result is a reactive UI on property changes.
|
||||||
|
|
||||||
## Table of Contents
|
## Links
|
||||||
1. [Import via unpkg](#import-via-unpkg)
|
|
||||||
1. [Installation via npm](#installation-via-npm)
|
|
||||||
1. [Usage](#usage)
|
|
||||||
1. [`template` vs `render()`](#template-vs-render)
|
|
||||||
1. [Quick Start Example](#quick-start-example)
|
|
||||||
1. [Life-Cycle Hooks](#life-cycle-hooks)
|
|
||||||
1. [`onInit`](#oninit) - the component is connected to the DOM, before view is initialized
|
|
||||||
1. [`afterViewInit`](#afterviewinit) - after the view is first initialized
|
|
||||||
1. [`onDestroy`](#ondestroy) - the component is disconnected from the DOM
|
|
||||||
1. [`onChanges`](#onchanges) - every time an attribute value changes
|
|
||||||
|
|
||||||
|
- [Documentation](https://webcomponent.io)
|
||||||
|
- [Read a blog explaining the reactivity](https://ayos.blog/reactive-custom-elements-with-html-dataset/)
|
||||||
|
- [View demo on CodePen](https://codepen.io/ayoayco-the-styleful/pen/ZEwoNOz?editors=1010)
|
||||||
|
|
||||||
## Import via unpkg
|
## Want to get in touch?
|
||||||
Import using [unpkg](https://unpkg.com/web-component-base) in your vanilla JS component. We will use this in the rest of our [usage examples](#usage).
|
|
||||||
|
|
||||||
```js
|
There are many ways to get in touch:
|
||||||
import WebComponent from "https://unpkg.com/web-component-base/index.js";
|
|
||||||
```
|
|
||||||
|
|
||||||
## Installation via npm
|
1. Open a [GitHub issue](https://github.com/ayoayco/wcb/issues/new) or [discussion](https://github.com/ayoayco/wcb/discussions)
|
||||||
Usable for projects using typescript, or with bundlers, or using import maps.
|
1. Submit a ticket via [SourceHut todo](https://todo.sr.ht/~ayoayco/wcb)
|
||||||
|
1. Email me: [ayo@ayco.io](mailto:ayo@ayco.io)
|
||||||
|
1. Chat on Discord: [Ayo's Projects](https://discord.gg/kkvW7GYNAp)
|
||||||
|
|
||||||
```bash
|
## Inspirations and thanks
|
||||||
npm i web-component-base
|
|
||||||
```
|
|
||||||
|
|
||||||
## Usage
|
1. [htm](https://github.com/developit/htm) - I use it for the `html` function for tagged templates, and take a lot of inspiration in building the rendering implementation. It is highly likely that I will go for what Preact is doing... but we'll see.
|
||||||
|
1. [fast](https://github.com/microsoft/fast) - When I found that Microsoft has their own base class I thought it was super cool!
|
||||||
|
1. [lit](https://github.com/lit/lit) - `lit-html` continues to amaze me and I worked to make `wcb` generic so I (and others) can continue to use it
|
||||||
|
|
||||||
In your component class:
|
---
|
||||||
|
*Just keep building.*<br>
|
||||||
```js
|
*A project by [Ayo](https://ayo.ayco.io)*
|
||||||
// HelloWorld.mjs
|
|
||||||
import WebComponent from "https://unpkg.com/web-component-base/index.js";
|
|
||||||
|
|
||||||
class HelloWorld extends WebComponent {
|
|
||||||
name = "World";
|
|
||||||
emotion = "excited";
|
|
||||||
|
|
||||||
static properties = ["name", "emotion"];
|
|
||||||
|
|
||||||
get template() {
|
|
||||||
return `
|
|
||||||
<h1>Hello ${this.name}${this.emotion === "sad" ? ". 😭" : "! 🙌"}</h1>`;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
customElements.define('hello-world', HelloWorld);
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
In your HTML page:
|
|
||||||
|
|
||||||
```html
|
|
||||||
<head>
|
|
||||||
<script type="module" src="HelloWorld.mjs"></script>
|
|
||||||
</head>
|
|
||||||
<body>
|
|
||||||
<hello-world name="Ayo" emotion="sad">
|
|
||||||
<script>
|
|
||||||
const helloWorld = document.querySelector('hello-world');
|
|
||||||
|
|
||||||
setTimeout(() => {
|
|
||||||
helloWorld.setAttribute('emotion', 'excited');
|
|
||||||
}, 2500)
|
|
||||||
</script>
|
|
||||||
</body>
|
|
||||||
```
|
|
||||||
|
|
||||||
The result is a reactive UI that updates on attribute changes:
|
|
||||||
|
|
||||||
<img alt="UI showing feeling toward Web Components changing from SAD to EXCITED" src="https://git.sr.ht/~ayoayco/web-component-base/blob/main/assets/wc-base-demo.gif" width="400" />
|
|
||||||
|
|
||||||
## `template` vs `render()`
|
|
||||||
|
|
||||||
This mental model attempts to reduce the cognitive complexity of authoring components:
|
|
||||||
|
|
||||||
1. The `template` is a read-only property (initialized with a `get` keyword) that represents *how* the component view is rendered.
|
|
||||||
1. There is a `render()` method that triggers a view render.
|
|
||||||
1. This `render()` method is *automatically* called under the hood every time an attribute value changed.
|
|
||||||
1. You can *optionally* call this `render()` method at any point to trigger a render if you need.
|
|
||||||
|
|
||||||
## Quick Start Example
|
|
||||||
|
|
||||||
Here is an example of using a custom element in a single .html file:
|
|
||||||
|
|
||||||
```html
|
|
||||||
<!DOCTYPE html>
|
|
||||||
<html lang="en">
|
|
||||||
<head>
|
|
||||||
<meta charset="UTF-8" />
|
|
||||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
|
||||||
<title>WC Base Test</title>
|
|
||||||
<script type="module">
|
|
||||||
|
|
||||||
// import from unpkg
|
|
||||||
import WebComponent from "https://unpkg.com/web-component-base/index.js";
|
|
||||||
|
|
||||||
class HelloWorld extends WebComponent {
|
|
||||||
static properties = ["name"];
|
|
||||||
|
|
||||||
get template() {
|
|
||||||
return `<h1>Hello ${this.name || 'World'}!</h1>`;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
customElements.define("hello-world", HelloWorld);
|
|
||||||
|
|
||||||
</script>
|
|
||||||
</head>
|
|
||||||
<body>
|
|
||||||
<hello-world name="Ayo"></hello-world>
|
|
||||||
<script>
|
|
||||||
const helloWorld = document.querySelector('hello-world');
|
|
||||||
setTimeout(() => {
|
|
||||||
helloWorld.setAttribute('name', 'Ayo zzzZzzz');
|
|
||||||
}, 2500);
|
|
||||||
</script>
|
|
||||||
</body>
|
|
||||||
</html>
|
|
||||||
```
|
|
||||||
|
|
||||||
## Life-Cycle Hooks
|
|
||||||
|
|
||||||
Define behavior when certain events in the component's life cycle is triggered by providing hook methods
|
|
||||||
|
|
||||||
### onInit()
|
|
||||||
- Triggered when the component is connected to the DOM
|
|
||||||
- Best for setting up the component
|
|
||||||
|
|
||||||
```js
|
|
||||||
import WebComponent from "https://unpkg.com/web-component-base/index.js";
|
|
||||||
|
|
||||||
class ClickableText extends WebComponent {
|
|
||||||
// gets called when the component is used in an HTML document
|
|
||||||
onInit() {
|
|
||||||
this.onclick = () => console.log(">>> click!");
|
|
||||||
}
|
|
||||||
|
|
||||||
get template() {
|
|
||||||
return `<span style="cursor:pointer">Click me!</span>`;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
### afterViewInit()
|
|
||||||
- Triggered after the view is first initialized
|
|
||||||
|
|
||||||
|
|
||||||
```js
|
|
||||||
class ClickableText extends WebComponent {
|
|
||||||
// gets called when the component's innerHTML is first filled
|
|
||||||
afterViewInit() {
|
|
||||||
const footer = this.querySelector('footer');
|
|
||||||
// do stuff to footer after view is initialized
|
|
||||||
}
|
|
||||||
|
|
||||||
get template() {
|
|
||||||
return `<footer>Awesome site © 2023</footer>`;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
### onDestroy()
|
|
||||||
- Triggered when the component is disconnected from the DOM
|
|
||||||
- best for undoing any setup done in `onInit()`
|
|
||||||
|
|
||||||
```js
|
|
||||||
import WebComponent from "https://unpkg.com/web-component-base/index.js";
|
|
||||||
|
|
||||||
class ClickableText extends WebComponent {
|
|
||||||
|
|
||||||
clickCallback() {
|
|
||||||
console.log(">>> click!");
|
|
||||||
}
|
|
||||||
|
|
||||||
onInit() {
|
|
||||||
this.onclick = this.clickCallback;
|
|
||||||
}
|
|
||||||
|
|
||||||
onDestroy() {
|
|
||||||
console.log(">>> removing event listener");
|
|
||||||
this.removeEventListener("click", this.clickCallback);
|
|
||||||
}
|
|
||||||
|
|
||||||
get template() {
|
|
||||||
return `<span style="cursor:pointer">Click me!</span>`;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
### onChanges()
|
|
||||||
- Triggered when an attribute value changed
|
|
||||||
|
|
||||||
```js
|
|
||||||
import WebComponent from "https://unpkg.com/web-component-base/index.js";
|
|
||||||
|
|
||||||
class ClickableText extends WebComponent {
|
|
||||||
// gets called when an attribute value changes
|
|
||||||
onChanges(changes) {
|
|
||||||
const {property, previousValue, currentValue} = changes;
|
|
||||||
console.log('>>> ', {property, previousValue, currentValue})
|
|
||||||
}
|
|
||||||
|
|
||||||
get template() {
|
|
||||||
return `<span style="cursor:pointer">Click me!</span>`;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
BIN
assets/IMG_0682.png
Normal file
After Width: | Height: | Size: 136 KiB |
BIN
assets/IMG_0683.png
Normal file
After Width: | Height: | Size: 102 KiB |
BIN
assets/IMG_0684.png
Normal file
After Width: | Height: | Size: 93 KiB |
BIN
assets/styling.png
Normal file
After Width: | Height: | Size: 319 KiB |
BIN
assets/todo-app.gif
Normal file
After Width: | Height: | Size: 474 KiB |
|
@ -1,32 +0,0 @@
|
||||||
import WebComponent from "../src/index.js";
|
|
||||||
|
|
||||||
export class HelloWorld extends WebComponent {
|
|
||||||
name = "World";
|
|
||||||
emotion = "excited";
|
|
||||||
|
|
||||||
static properties = ["data-name", "emotion"];
|
|
||||||
|
|
||||||
onInit() {
|
|
||||||
let count = 0;
|
|
||||||
this.onclick = () => {
|
|
||||||
this.setAttribute("data-name", `Clicked ${++count}x!`);
|
|
||||||
};
|
|
||||||
}
|
|
||||||
|
|
||||||
afterViewInit() {
|
|
||||||
console.log("afterViewInit", this.querySelector("h1"));
|
|
||||||
}
|
|
||||||
|
|
||||||
onChanges(changes) {
|
|
||||||
const { property, previousValue, currentValue } = changes;
|
|
||||||
console.log(`${property} changed`, { previousValue, currentValue });
|
|
||||||
}
|
|
||||||
|
|
||||||
get template() {
|
|
||||||
return `<button id="btn">Hello ${this.dataName}${
|
|
||||||
this.emotion === "sad" ? ". 😭" : "! 🙌"
|
|
||||||
}</button>`;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
customElements.define("hello-world", HelloWorld);
|
|
|
@ -1,23 +0,0 @@
|
||||||
// @ts-check
|
|
||||||
|
|
||||||
import { WebComponent } from "../src/WebComponent.mjs";
|
|
||||||
|
|
||||||
class SimpleText extends WebComponent {
|
|
||||||
clickCallback() {
|
|
||||||
console.log(">>> click!");
|
|
||||||
}
|
|
||||||
onInit() {
|
|
||||||
this.onclick = this.clickCallback;
|
|
||||||
}
|
|
||||||
|
|
||||||
onDestroy() {
|
|
||||||
console.log(">>> removing event listener");
|
|
||||||
this.removeEventListener("click", this.clickCallback);
|
|
||||||
}
|
|
||||||
|
|
||||||
get template() {
|
|
||||||
return `<span>Click me!</span>`;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
customElements.define("simple-text", SimpleText);
|
|
|
@ -1,28 +0,0 @@
|
||||||
<!DOCTYPE html>
|
|
||||||
<html lang="en">
|
|
||||||
<head>
|
|
||||||
<meta charset="UTF-8" />
|
|
||||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
|
||||||
<title>WC demo</title>
|
|
||||||
<script type="module" src="HelloWorld.mjs"></script>
|
|
||||||
<script type="module" src="SimpleText.mjs"></script>
|
|
||||||
</head>
|
|
||||||
<body>
|
|
||||||
<hello-world id="hey" data-name="Ayo" emotion="sad"></hello-world>
|
|
||||||
<p>
|
|
||||||
<simple-text greeting="hey"></simple-text>
|
|
||||||
</p>
|
|
||||||
|
|
||||||
<script type="module">
|
|
||||||
const helloWorld = document.querySelector("hello-world");
|
|
||||||
setTimeout(() => {
|
|
||||||
helloWorld.setAttribute("emotion", "excited");
|
|
||||||
}, 2500);
|
|
||||||
|
|
||||||
const clickableText = document.querySelector("simple-text");
|
|
||||||
setTimeout(() => {
|
|
||||||
clickableText.remove();
|
|
||||||
}, 2000);
|
|
||||||
</script>
|
|
||||||
</body>
|
|
||||||
</html>
|
|
21
docs/.gitignore
vendored
Normal file
|
@ -0,0 +1,21 @@
|
||||||
|
# build output
|
||||||
|
dist/
|
||||||
|
# generated types
|
||||||
|
.astro/
|
||||||
|
|
||||||
|
# dependencies
|
||||||
|
node_modules/
|
||||||
|
|
||||||
|
# logs
|
||||||
|
npm-debug.log*
|
||||||
|
yarn-debug.log*
|
||||||
|
yarn-error.log*
|
||||||
|
pnpm-debug.log*
|
||||||
|
|
||||||
|
|
||||||
|
# environment variables
|
||||||
|
.env
|
||||||
|
.env.production
|
||||||
|
|
||||||
|
# macOS-specific files
|
||||||
|
.DS_Store
|
4
docs/.vscode/extensions.json
vendored
Normal file
|
@ -0,0 +1,4 @@
|
||||||
|
{
|
||||||
|
"recommendations": ["astro-build.astro-vscode"],
|
||||||
|
"unwantedRecommendations": []
|
||||||
|
}
|
11
docs/.vscode/launch.json
vendored
Normal file
|
@ -0,0 +1,11 @@
|
||||||
|
{
|
||||||
|
"version": "0.2.0",
|
||||||
|
"configurations": [
|
||||||
|
{
|
||||||
|
"command": "./node_modules/.bin/astro dev",
|
||||||
|
"name": "Development server",
|
||||||
|
"request": "launch",
|
||||||
|
"type": "node-terminal"
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
54
docs/README.md
Normal file
|
@ -0,0 +1,54 @@
|
||||||
|
# Starlight Starter Kit: Basics
|
||||||
|
|
||||||
|
[](https://starlight.astro.build)
|
||||||
|
|
||||||
|
```
|
||||||
|
npm create astro@latest -- --template starlight
|
||||||
|
```
|
||||||
|
|
||||||
|
[](https://stackblitz.com/github/withastro/starlight/tree/main/examples/basics)
|
||||||
|
[](https://codesandbox.io/p/sandbox/github/withastro/starlight/tree/main/examples/basics)
|
||||||
|
[](https://app.netlify.com/start/deploy?repository=https://github.com/withastro/starlight&create_from_path=examples/basics)
|
||||||
|
[](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Fwithastro%2Fstarlight%2Ftree%2Fmain%2Fexamples%2Fbasics&project-name=my-starlight-docs&repository-name=my-starlight-docs)
|
||||||
|
|
||||||
|
> 🧑🚀 **Seasoned astronaut?** Delete this file. Have fun!
|
||||||
|
|
||||||
|
## 🚀 Project Structure
|
||||||
|
|
||||||
|
Inside of your Astro + Starlight project, you'll see the following folders and files:
|
||||||
|
|
||||||
|
```
|
||||||
|
.
|
||||||
|
├── public/
|
||||||
|
├── src/
|
||||||
|
│ ├── assets/
|
||||||
|
│ ├── content/
|
||||||
|
│ │ ├── docs/
|
||||||
|
│ └── content.config.ts
|
||||||
|
├── astro.config.mjs
|
||||||
|
├── package.json
|
||||||
|
└── tsconfig.json
|
||||||
|
```
|
||||||
|
|
||||||
|
Starlight looks for `.md` or `.mdx` files in the `src/content/docs/` directory. Each file is exposed as a route based on its file name.
|
||||||
|
|
||||||
|
Images can be added to `src/assets/` and embedded in Markdown with a relative link.
|
||||||
|
|
||||||
|
Static assets, like favicons, can be placed in the `public/` directory.
|
||||||
|
|
||||||
|
## 🧞 Commands
|
||||||
|
|
||||||
|
All commands are run from the root of the project, from a terminal:
|
||||||
|
|
||||||
|
| Command | Action |
|
||||||
|
| :------------------------ | :----------------------------------------------- |
|
||||||
|
| `npm install` | Installs dependencies |
|
||||||
|
| `npm run dev` | Starts local dev server at `localhost:4321` |
|
||||||
|
| `npm run build` | Build your production site to `./dist/` |
|
||||||
|
| `npm run preview` | Preview your build locally, before deploying |
|
||||||
|
| `npm run astro ...` | Run CLI commands like `astro add`, `astro check` |
|
||||||
|
| `npm run astro -- --help` | Get help using the Astro CLI |
|
||||||
|
|
||||||
|
## 👀 Want to learn more?
|
||||||
|
|
||||||
|
Check out [Starlight’s docs](https://starlight.astro.build/), read [the Astro documentation](https://docs.astro.build), or jump into the [Astro Discord server](https://astro.build/chat).
|
65
docs/astro.config.mjs
Normal file
|
@ -0,0 +1,65 @@
|
||||||
|
// @ts-check
|
||||||
|
import { defineConfig } from 'astro/config'
|
||||||
|
import starlight from '@astrojs/starlight'
|
||||||
|
|
||||||
|
// https://astro.build/config
|
||||||
|
export default defineConfig({
|
||||||
|
redirects: {
|
||||||
|
'/guides/': '/guides/why',
|
||||||
|
},
|
||||||
|
integrations: [
|
||||||
|
starlight({
|
||||||
|
title: 'WCB (alpha)',
|
||||||
|
social: {
|
||||||
|
npm: 'https://www.npmjs.com/package/web-component-base',
|
||||||
|
sourcehut: 'https://sr.ht/~ayoayco/wcb/',
|
||||||
|
github: 'https://github.com/ayoayco/wcb/',
|
||||||
|
discord: 'https://discord.gg/kkvW7GYNAp',
|
||||||
|
},
|
||||||
|
sidebar: [
|
||||||
|
{
|
||||||
|
label: 'Guides',
|
||||||
|
items: [
|
||||||
|
// Each item here is one entry in the navigation menu.
|
||||||
|
'getting-started',
|
||||||
|
'why',
|
||||||
|
'exports',
|
||||||
|
'usage',
|
||||||
|
'examples',
|
||||||
|
'template-vs-render',
|
||||||
|
'prop-access',
|
||||||
|
'shadow-dom',
|
||||||
|
'styling',
|
||||||
|
'just-parts',
|
||||||
|
'life-cycle-hooks',
|
||||||
|
'library-size',
|
||||||
|
],
|
||||||
|
},
|
||||||
|
// {
|
||||||
|
// label: 'Reference',
|
||||||
|
// autogenerate: { directory: 'reference' },
|
||||||
|
// },
|
||||||
|
],
|
||||||
|
components: {
|
||||||
|
Footer: './src/components/Attribution.astro',
|
||||||
|
},
|
||||||
|
head: [
|
||||||
|
{
|
||||||
|
tag: 'link',
|
||||||
|
attrs: {
|
||||||
|
rel: 'mask-icon',
|
||||||
|
href: 'mask-icon.svg',
|
||||||
|
color: '#000000',
|
||||||
|
},
|
||||||
|
},
|
||||||
|
{
|
||||||
|
tag: 'link',
|
||||||
|
attrs: {
|
||||||
|
rel: 'apple-touch-icon',
|
||||||
|
href: 'apple-touch-icon.png',
|
||||||
|
},
|
||||||
|
},
|
||||||
|
],
|
||||||
|
}),
|
||||||
|
],
|
||||||
|
})
|
6666
docs/package-lock.json
generated
Normal file
18
docs/package.json
Normal file
|
@ -0,0 +1,18 @@
|
||||||
|
{
|
||||||
|
"name": "docs",
|
||||||
|
"type": "module",
|
||||||
|
"version": "0.0.1",
|
||||||
|
"scripts": {
|
||||||
|
"dev": "astro dev",
|
||||||
|
"start": "astro dev",
|
||||||
|
"build": "astro build",
|
||||||
|
"preview": "astro preview",
|
||||||
|
"astro": "astro",
|
||||||
|
"deploy": "netlify deploy --site=$NETLIFY_SITE_ID --dir=dist --prod"
|
||||||
|
},
|
||||||
|
"dependencies": {
|
||||||
|
"@astrojs/starlight": "^0.32.5",
|
||||||
|
"astro": "^5.5.3",
|
||||||
|
"sharp": "^0.32.5"
|
||||||
|
}
|
||||||
|
}
|
BIN
docs/public/apple-touch-icon.png
Normal file
After Width: | Height: | Size: 2.8 KiB |
1
docs/public/favicon.svg
Normal file
|
@ -0,0 +1 @@
|
||||||
|
<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" width="500" zoomAndPan="magnify" viewBox="0 0 375 374.999991" height="500" preserveAspectRatio="xMidYMid meet" version="1.0"><defs><g/></defs><rect x="-37.5" width="450" fill="#ffffff" y="-37.499999" height="449.999989" fill-opacity="1"/><rect x="-37.5" width="450" fill="#ffffff" y="-37.499999" height="449.999989" fill-opacity="1"/><g fill="#000000" fill-opacity="1"><g transform="translate(73.856059, 294.776352)"><g><path d="M 218.265625 0 L 100.453125 0 C 99.492188 0 99.015625 -0.601562 99.015625 -1.8125 C 99.253906 -6.382812 99.734375 -12.582031 100.453125 -20.40625 C 101.179688 -28.238281 101.96875 -36.128906 102.8125 -44.078125 C 103.65625 -52.035156 104.316406 -58.179688 104.796875 -62.515625 C 105.035156 -62.992188 105.515625 -63.351562 106.234375 -63.59375 C 106.960938 -63.832031 107.566406 -63.953125 108.046875 -63.953125 C 108.523438 -63.710938 109.96875 -63.59375 112.375 -63.59375 C 114.789062 -63.59375 117.257812 -63.59375 119.78125 -63.59375 C 122.3125 -63.59375 123.941406 -63.59375 124.671875 -63.59375 C 124.671875 -63.59375 125.691406 -64.070312 127.734375 -65.03125 C 129.785156 -66 130.8125 -67.691406 130.8125 -70.109375 C 130.570312 -71.304688 130.03125 -74.851562 129.1875 -80.75 C 128.34375 -86.65625 127.378906 -93.398438 126.296875 -100.984375 C 125.210938 -108.578125 124.25 -115.867188 123.40625 -122.859375 C 122.5625 -129.847656 122.019531 -135.03125 121.78125 -138.40625 C 121.539062 -143.695312 120.816406 -148.148438 119.609375 -151.765625 C 118.398438 -155.378906 116.59375 -157.1875 114.1875 -157.1875 C 110.8125 -157.425781 108.460938 -155.800781 107.140625 -152.3125 C 105.816406 -148.820312 105.035156 -146.113281 104.796875 -144.1875 C 104.066406 -138.882812 102.859375 -131.414062 101.171875 -121.78125 C 99.492188 -112.144531 97.566406 -101.546875 95.390625 -89.984375 C 93.222656 -78.421875 91.175781 -66.851562 89.25 -55.28125 C 87.320312 -43.71875 85.695312 -33.175781 84.375 -23.65625 C 83.050781 -14.144531 82.269531 -6.863281 82.03125 -1.8125 C 82.03125 -0.601562 81.664062 0 80.9375 0 L 7.953125 0 C 6.984375 0 6.617188 -0.722656 6.859375 -2.171875 C 7.109375 -3.128906 7.289062 -4.148438 7.40625 -5.234375 C 7.53125 -6.316406 7.710938 -7.34375 7.953125 -8.3125 C 8.429688 -10.476562 9.394531 -15.113281 10.84375 -22.21875 C 12.289062 -29.332031 13.914062 -37.34375 15.71875 -46.25 C 17.519531 -55.164062 19.265625 -63.78125 20.953125 -72.09375 C 22.640625 -80.40625 24.085938 -86.847656 25.296875 -91.421875 C 25.773438 -94.554688 26.675781 -99.859375 28 -107.328125 C 29.332031 -114.796875 30.78125 -123.40625 32.34375 -133.15625 C 33.90625 -142.914062 35.53125 -152.914062 37.21875 -163.15625 C 38.90625 -173.394531 40.410156 -183.085938 41.734375 -192.234375 C 43.054688 -201.390625 44.195312 -208.976562 45.15625 -215 C 46.125 -221.03125 46.609375 -224.644531 46.609375 -225.84375 C 46.859375 -226.8125 47.34375 -227.296875 48.0625 -227.296875 L 179.59375 -227.296875 C 180.070312 -227.296875 180.429688 -226.8125 180.671875 -225.84375 C 181.160156 -223.4375 182.066406 -218.4375 183.390625 -210.84375 C 184.710938 -203.257812 186.15625 -194.769531 187.71875 -185.375 C 189.289062 -175.976562 190.796875 -167.003906 192.234375 -158.453125 C 193.679688 -149.898438 194.890625 -143.21875 195.859375 -138.40625 C 197.546875 -128.769531 199.109375 -119.128906 200.546875 -109.484375 C 201.992188 -99.847656 203.441406 -90.210938 204.890625 -80.578125 C 205.367188 -78.648438 206.03125 -74.976562 206.875 -69.5625 C 207.71875 -64.144531 208.800781 -58 210.125 -51.125 C 211.457031 -44.257812 212.722656 -37.332031 213.921875 -30.34375 C 215.128906 -23.363281 216.273438 -17.34375 217.359375 -12.28125 C 218.441406 -7.226562 219.101562 -3.859375 219.34375 -2.171875 C 219.820312 -0.722656 219.460938 0 218.265625 0 Z M 218.265625 0 "/></g></g></g></svg>
|
After Width: | Height: | Size: 3.8 KiB |
1
docs/public/mask-icon.svg
Normal file
|
@ -0,0 +1 @@
|
||||||
|
<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" width="500" zoomAndPan="magnify" viewBox="0 0 375 374.999991" height="500" preserveAspectRatio="xMidYMid meet" version="1.0"><defs><g/></defs><g fill="#000000" fill-opacity="1"><g transform="translate(73.856059, 294.776352)"><g><path d="M 218.265625 0 L 100.453125 0 C 99.492188 0 99.015625 -0.601562 99.015625 -1.8125 C 99.253906 -6.382812 99.734375 -12.582031 100.453125 -20.40625 C 101.179688 -28.238281 101.96875 -36.128906 102.8125 -44.078125 C 103.65625 -52.035156 104.316406 -58.179688 104.796875 -62.515625 C 105.035156 -62.992188 105.515625 -63.351562 106.234375 -63.59375 C 106.960938 -63.832031 107.566406 -63.953125 108.046875 -63.953125 C 108.523438 -63.710938 109.96875 -63.59375 112.375 -63.59375 C 114.789062 -63.59375 117.257812 -63.59375 119.78125 -63.59375 C 122.3125 -63.59375 123.941406 -63.59375 124.671875 -63.59375 C 124.671875 -63.59375 125.691406 -64.070312 127.734375 -65.03125 C 129.785156 -66 130.8125 -67.691406 130.8125 -70.109375 C 130.570312 -71.304688 130.03125 -74.851562 129.1875 -80.75 C 128.34375 -86.65625 127.378906 -93.398438 126.296875 -100.984375 C 125.210938 -108.578125 124.25 -115.867188 123.40625 -122.859375 C 122.5625 -129.847656 122.019531 -135.03125 121.78125 -138.40625 C 121.539062 -143.695312 120.816406 -148.148438 119.609375 -151.765625 C 118.398438 -155.378906 116.59375 -157.1875 114.1875 -157.1875 C 110.8125 -157.425781 108.460938 -155.800781 107.140625 -152.3125 C 105.816406 -148.820312 105.035156 -146.113281 104.796875 -144.1875 C 104.066406 -138.882812 102.859375 -131.414062 101.171875 -121.78125 C 99.492188 -112.144531 97.566406 -101.546875 95.390625 -89.984375 C 93.222656 -78.421875 91.175781 -66.851562 89.25 -55.28125 C 87.320312 -43.71875 85.695312 -33.175781 84.375 -23.65625 C 83.050781 -14.144531 82.269531 -6.863281 82.03125 -1.8125 C 82.03125 -0.601562 81.664062 0 80.9375 0 L 7.953125 0 C 6.984375 0 6.617188 -0.722656 6.859375 -2.171875 C 7.109375 -3.128906 7.289062 -4.148438 7.40625 -5.234375 C 7.53125 -6.316406 7.710938 -7.34375 7.953125 -8.3125 C 8.429688 -10.476562 9.394531 -15.113281 10.84375 -22.21875 C 12.289062 -29.332031 13.914062 -37.34375 15.71875 -46.25 C 17.519531 -55.164062 19.265625 -63.78125 20.953125 -72.09375 C 22.640625 -80.40625 24.085938 -86.847656 25.296875 -91.421875 C 25.773438 -94.554688 26.675781 -99.859375 28 -107.328125 C 29.332031 -114.796875 30.78125 -123.40625 32.34375 -133.15625 C 33.90625 -142.914062 35.53125 -152.914062 37.21875 -163.15625 C 38.90625 -173.394531 40.410156 -183.085938 41.734375 -192.234375 C 43.054688 -201.390625 44.195312 -208.976562 45.15625 -215 C 46.125 -221.03125 46.609375 -224.644531 46.609375 -225.84375 C 46.859375 -226.8125 47.34375 -227.296875 48.0625 -227.296875 L 179.59375 -227.296875 C 180.070312 -227.296875 180.429688 -226.8125 180.671875 -225.84375 C 181.160156 -223.4375 182.066406 -218.4375 183.390625 -210.84375 C 184.710938 -203.257812 186.15625 -194.769531 187.71875 -185.375 C 189.289062 -175.976562 190.796875 -167.003906 192.234375 -158.453125 C 193.679688 -149.898438 194.890625 -143.21875 195.859375 -138.40625 C 197.546875 -128.769531 199.109375 -119.128906 200.546875 -109.484375 C 201.992188 -99.847656 203.441406 -90.210938 204.890625 -80.578125 C 205.367188 -78.648438 206.03125 -74.976562 206.875 -69.5625 C 207.71875 -64.144531 208.800781 -58 210.125 -51.125 C 211.457031 -44.257812 212.722656 -37.332031 213.921875 -30.34375 C 215.128906 -23.363281 216.273438 -17.34375 217.359375 -12.28125 C 218.441406 -7.226562 219.101562 -3.859375 219.34375 -2.171875 C 219.820312 -0.722656 219.460938 0 218.265625 0 Z M 218.265625 0 "/></g></g></g></svg>
|
After Width: | Height: | Size: 3.6 KiB |
BIN
docs/public/touch-icon-large.png
Normal file
After Width: | Height: | Size: 8.8 KiB |
BIN
docs/src/assets/houston.webp
Normal file
After Width: | Height: | Size: 96 KiB |
14
docs/src/components/Attribution.astro
Normal file
|
@ -0,0 +1,14 @@
|
||||||
|
---
|
||||||
|
import Footer from '@astrojs/starlight/components/Footer.astro'
|
||||||
|
---
|
||||||
|
|
||||||
|
<Footer />
|
||||||
|
|
||||||
|
<footer style="text-align: right; font-style: italic; padding: 0.5em 1em">
|
||||||
|
<p>
|
||||||
|
<small>Released under the MIT License</small>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<small>A project by <a href="https://ayo.ayco.io">Ayo</a></small>
|
||||||
|
</p>
|
||||||
|
</footer>
|
7
docs/src/content.config.ts
Normal file
|
@ -0,0 +1,7 @@
|
||||||
|
import { defineCollection } from 'astro:content';
|
||||||
|
import { docsLoader } from '@astrojs/starlight/loaders';
|
||||||
|
import { docsSchema } from '@astrojs/starlight/schema';
|
||||||
|
|
||||||
|
export const collections = {
|
||||||
|
docs: defineCollection({ loader: docsLoader(), schema: docsSchema() }),
|
||||||
|
};
|
59
docs/src/content/docs/guides/examples.md
Normal file
|
@ -0,0 +1,59 @@
|
||||||
|
---
|
||||||
|
title: Examples
|
||||||
|
slug: examples
|
||||||
|
---
|
||||||
|
|
||||||
|
### 1. To-Do App
|
||||||
|
|
||||||
|
A simple app that allows adding / completing tasks:
|
||||||
|
[View on CodePen ↗](https://codepen.io/ayoayco-the-styleful/pen/GRegyVe?editors=1010)
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
### 2. Single HTML file Example
|
||||||
|
|
||||||
|
Here is an example of using a custom element in a single .html file.
|
||||||
|
|
||||||
|
```html
|
||||||
|
<!doctype html>
|
||||||
|
<html lang="en">
|
||||||
|
<head>
|
||||||
|
<title>WC Base Test</title>
|
||||||
|
<script type="module">
|
||||||
|
import { WebComponent } from 'https://unpkg.com/web-component-base@latest/index.js'
|
||||||
|
|
||||||
|
class HelloWorld extends WebComponent {
|
||||||
|
static props = {
|
||||||
|
myName: 'World',
|
||||||
|
}
|
||||||
|
get template() {
|
||||||
|
return `<h1>Hello ${this.props.myName}!</h1>`
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
customElements.define('hello-world', HelloWorld)
|
||||||
|
</script>
|
||||||
|
</head>
|
||||||
|
<body>
|
||||||
|
<hello-world my-name="Ayo"></hello-world>
|
||||||
|
<script>
|
||||||
|
const helloWorld = document.querySelector('hello-world')
|
||||||
|
setTimeout(() => {
|
||||||
|
helloWorld.props.myName = 'Ayo zzzZzzz'
|
||||||
|
}, 2500)
|
||||||
|
</script>
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
|
```
|
||||||
|
|
||||||
|
### 3. Feature Demos
|
||||||
|
|
||||||
|
Some feature-specific demos:
|
||||||
|
|
||||||
|
1. [Context-Aware Post-Apocalyptic Human](https://codepen.io/ayoayco-the-styleful/pen/WNqJMNG?editors=1010)
|
||||||
|
1. [Simple reactive property](https://codepen.io/ayoayco-the-styleful/pen/ZEwoNOz?editors=1010)
|
||||||
|
1. [Counter & Toggle](https://codepen.io/ayoayco-the-styleful/pen/PoVegBK?editors=1010)
|
||||||
|
1. [Using custom templating (lit-html)](https://codepen.io/ayoayco-the-styleful/pen/ZEwNJBR?editors=1010)
|
||||||
|
1. [Using dynamic style objects](https://codepen.io/ayoayco-the-styleful/pen/bGzXjwQ?editors=1010)
|
||||||
|
1. [Using the Shadow DOM](https://codepen.io/ayoayco-the-styleful/pen/VwRYVPv?editors=1010)
|
||||||
|
1. [Using tagged templates in your vanilla custom element](https://codepen.io/ayoayco-the-styleful/pen/bGzJQJg?editors=1010)
|
42
docs/src/content/docs/guides/exports.md
Normal file
|
@ -0,0 +1,42 @@
|
||||||
|
---
|
||||||
|
title: Exports
|
||||||
|
slug: exports
|
||||||
|
---
|
||||||
|
|
||||||
|
You can import everything separately, or in a single file each for the main exports and utilities.
|
||||||
|
|
||||||
|
### Main Exports
|
||||||
|
|
||||||
|
```js
|
||||||
|
// all in a single file
|
||||||
|
|
||||||
|
import { WebComponent, html } from 'web-component-base'
|
||||||
|
|
||||||
|
// in separate files
|
||||||
|
|
||||||
|
import { WebComponent } from 'web-component-base/WebComponent.js'
|
||||||
|
|
||||||
|
import { html } from 'web-component-base/html.js'
|
||||||
|
```
|
||||||
|
|
||||||
|
### Utilities
|
||||||
|
|
||||||
|
```js
|
||||||
|
// in a single file
|
||||||
|
|
||||||
|
import {
|
||||||
|
serialize,
|
||||||
|
deserialize,
|
||||||
|
getCamelCase,
|
||||||
|
getKebabCase,
|
||||||
|
createElement,
|
||||||
|
} from 'web-component-base/utils'
|
||||||
|
|
||||||
|
// or separate files
|
||||||
|
|
||||||
|
import { serialize } from 'web-component-base/utils/serialize.js'
|
||||||
|
|
||||||
|
import { createElement } from 'web-component-base/utils/create-element.js'
|
||||||
|
|
||||||
|
// etc...
|
||||||
|
```
|
49
docs/src/content/docs/guides/getting-started.mdx
Normal file
|
@ -0,0 +1,49 @@
|
||||||
|
---
|
||||||
|
title: Getting Started
|
||||||
|
slug: getting-started
|
||||||
|
---
|
||||||
|
|
||||||
|
import { Aside, Badge } from '@astrojs/starlight/components';
|
||||||
|
|
||||||
|
**Web Component Base (WCB)**
|
||||||
|
<Badge text="alpha" variant="danger" /> is a zero-dependency, tiny JS base class for creating reactive [custom elements](https://developer.mozilla.org/en-US/docs/Web/API/Web_Components/Using_custom_elements) easily.
|
||||||
|
|
||||||
|
When you extend the WebComponent class for your custom element, you only have to define the template and properties. Any change in an observed property's value will automatically cause the component UI to render.
|
||||||
|
|
||||||
|
The result is a reactive UI on property changes.
|
||||||
|
|
||||||
|
Note that there's a trade off between productivity & lightweight-ness here, and the project aims to help in writing custom elements in the same way more mature and better maintained projects already do. Please look into popular options such as [Microsoft's FASTElement](https://fast.design/) & [Google's LitElement](https://lit.dev/) as well.
|
||||||
|
|
||||||
|
## Project Status
|
||||||
|
|
||||||
|
Treat it as a **stable alpha** product. Though the public APIs are stable, most examples are only useful for simple atomic use-cases due to remaining work needed on the internals.
|
||||||
|
|
||||||
|
<Aside type="caution" title="Important">
|
||||||
|
For building advanced interactions, there is an in-progress work on smart diffing to prevent component children being wiped on interaction.
|
||||||
|
</Aside>
|
||||||
|
|
||||||
|
<Aside type="tip">
|
||||||
|
If you have some complex needs, we recommend using the `WebComponent` base class with a more mature rendering approach like `lit-html`, and here's a demo for that: [View on CodePen](https://codepen.io/ayoayco-the-styleful/pen/ZEwNJBR?editors=1010).
|
||||||
|
</Aside>
|
||||||
|
|
||||||
|
## Installation
|
||||||
|
|
||||||
|
The library is distributed as complete ECMAScript Modules (ESM) and published on [NPM](https://ayco.io/n/web-component-base). Please open a [GitHub issue](https://github.com/ayoayco/wcb/issues/new) or [discussion](https://github.com/ayoayco/wcb/discussions) for problems or requests regarding our distribution. You can also submit a ticket in [SourceHut](https://todo.sr.ht/~ayoayco/wcb).
|
||||||
|
|
||||||
|
### Import via CDN
|
||||||
|
|
||||||
|
It is possible to import directly using a CDN like [esm.sh](https://esm.sh/web-component-base) or [unpkg](https://unpkg.com/web-component-base) in your vanilla JS component or HTML files. In all examples in this document, we use `unpkg` but you can find on CodePen examples that `esm.sh` also works well.
|
||||||
|
|
||||||
|
Additionally, we use `@latest` in the rest of our [usage](/usage) and [examples](/examples) here for simplicity, but take note that this incurs additional resolution steps for CDNs to find the actual latest published version. You may replace the `@latest` in the URL with specific versions as shown in our CodePen examples, and this will typically be better for performance.
|
||||||
|
|
||||||
|
```js
|
||||||
|
import { WebComponent } from 'https://unpkg.com/web-component-base@latest/index.js'
|
||||||
|
```
|
||||||
|
|
||||||
|
### Installation via npm
|
||||||
|
|
||||||
|
Usable for projects with bundlers or using import maps pointing to the specific files downloaded in `node_modules/web-component-base`.
|
||||||
|
|
||||||
|
```bash
|
||||||
|
npm i web-component-base
|
||||||
|
```
|
24
docs/src/content/docs/guides/just-parts.md
Normal file
|
@ -0,0 +1,24 @@
|
||||||
|
---
|
||||||
|
title: Using Just Some Parts
|
||||||
|
slug: 'just-parts'
|
||||||
|
---
|
||||||
|
|
||||||
|
You don't have to extend the whole base class to use some features. All internals are exposed and usable separately so you can practically build the behavior on your own classes.
|
||||||
|
|
||||||
|
Here's an example of using the `html` tag template on a class that extends from vanilla `HTMLElement`... also [View on CodePen ↗](https://codepen.io/ayoayco-the-styleful/pen/bGzJQJg?editors=1010).
|
||||||
|
|
||||||
|
```js
|
||||||
|
import { html } from 'https://unpkg.com/web-component-base/html'
|
||||||
|
import { createElement } from 'https://unpkg.com/web-component-base/utils'
|
||||||
|
|
||||||
|
class MyQuote extends HTMLElement {
|
||||||
|
connectedCallback() {
|
||||||
|
const el = createElement(
|
||||||
|
html` <button onClick=${() => alert('hey')}>hey</button>`
|
||||||
|
)
|
||||||
|
this.appendChild(el)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
customElements.define('my-quote', MyQuote)
|
||||||
|
```
|
8
docs/src/content/docs/guides/library-size.md
Normal file
|
@ -0,0 +1,8 @@
|
||||||
|
---
|
||||||
|
title: Library Size
|
||||||
|
slug: library-size
|
||||||
|
---
|
||||||
|
|
||||||
|
All the functions and the base class in the library are minimalist by design and only contains what is needed for their purpose.
|
||||||
|
|
||||||
|
The main export (with `WebComponent` + `html`) is **1.7 kB** (min + gzip) according to [bundlephobia.com](https://bundlephobia.com/package/web-component-base@latest), and the `WebComponent` base class is **1.08 kB** (min + brotli) according to [size-limit](http://github.com/ai/size-limit).
|
92
docs/src/content/docs/guides/life-cycle-hooks.md
Normal file
|
@ -0,0 +1,92 @@
|
||||||
|
---
|
||||||
|
title: Life-Cycle Hooks
|
||||||
|
slug: life-cycle-hooks
|
||||||
|
---
|
||||||
|
|
||||||
|
Define behavior when certain events in the component's life cycle is triggered by providing hook methods
|
||||||
|
|
||||||
|
### onInit()
|
||||||
|
|
||||||
|
- Triggered when the component is connected to the DOM
|
||||||
|
- Best for setting up the component
|
||||||
|
|
||||||
|
```js
|
||||||
|
import { WebComponent } from 'https://unpkg.com/web-component-base@latest/index.js'
|
||||||
|
|
||||||
|
class ClickableText extends WebComponent {
|
||||||
|
// gets called when the component is used in an HTML document
|
||||||
|
onInit() {
|
||||||
|
this.onclick = () => console.log('>>> click!')
|
||||||
|
}
|
||||||
|
|
||||||
|
get template() {
|
||||||
|
return `<span style="cursor:pointer">Click me!</span>`
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### afterViewInit()
|
||||||
|
|
||||||
|
- Triggered after the view is first initialized
|
||||||
|
|
||||||
|
```js
|
||||||
|
class ClickableText extends WebComponent {
|
||||||
|
// gets called when the component's innerHTML is first filled
|
||||||
|
afterViewInit() {
|
||||||
|
const footer = this.querySelector('footer')
|
||||||
|
// do stuff to footer after view is initialized
|
||||||
|
}
|
||||||
|
|
||||||
|
get template() {
|
||||||
|
return `<footer>Awesome site © 2023</footer>`
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### onDestroy()
|
||||||
|
|
||||||
|
- Triggered when the component is disconnected from the DOM
|
||||||
|
- best for undoing any setup done in `onInit()`
|
||||||
|
|
||||||
|
```js
|
||||||
|
import { WebComponent } from 'https://unpkg.com/web-component-base@latest/index.js'
|
||||||
|
|
||||||
|
class ClickableText extends WebComponent {
|
||||||
|
clickCallback() {
|
||||||
|
console.log('>>> click!')
|
||||||
|
}
|
||||||
|
|
||||||
|
onInit() {
|
||||||
|
this.onclick = this.clickCallback
|
||||||
|
}
|
||||||
|
|
||||||
|
onDestroy() {
|
||||||
|
console.log('>>> removing event listener')
|
||||||
|
this.removeEventListener('click', this.clickCallback)
|
||||||
|
}
|
||||||
|
|
||||||
|
get template() {
|
||||||
|
return `<span style="cursor:pointer">Click me!</span>`
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
### onChanges()
|
||||||
|
|
||||||
|
- Triggered when an attribute value changed
|
||||||
|
|
||||||
|
```js
|
||||||
|
import { WebComponent } from 'https://unpkg.com/web-component-base@latest/index.js'
|
||||||
|
|
||||||
|
class ClickableText extends WebComponent {
|
||||||
|
// gets called when an attribute value changes
|
||||||
|
onChanges(changes) {
|
||||||
|
const { property, previousValue, currentValue } = changes
|
||||||
|
console.log('>>> ', { property, previousValue, currentValue })
|
||||||
|
}
|
||||||
|
|
||||||
|
get template() {
|
||||||
|
return `<span style="cursor:pointer">Click me!</span>`
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
48
docs/src/content/docs/guides/prop-access.mdx
Normal file
|
@ -0,0 +1,48 @@
|
||||||
|
---
|
||||||
|
title: Prop Access
|
||||||
|
slug: prop-access
|
||||||
|
---
|
||||||
|
|
||||||
|
import { Aside } from '@astrojs/starlight/components'
|
||||||
|
|
||||||
|
The `props` property of the `WebComponent` interface is provided for easy read/write access to a camelCase counterpart of _any_ observed attribute.
|
||||||
|
|
||||||
|
```js
|
||||||
|
class HelloWorld extends WebComponent {
|
||||||
|
static props = {
|
||||||
|
myProp: 'World',
|
||||||
|
}
|
||||||
|
get template() {
|
||||||
|
return html` <h1>Hello ${this.props.myProp}</h1> `
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
Assigning a value to the `props.camelCase` counterpart of an observed attribute will trigger an "attribute change" hook.
|
||||||
|
|
||||||
|
For example, assigning a value like so:
|
||||||
|
|
||||||
|
```
|
||||||
|
this.props.myName = 'hello'
|
||||||
|
```
|
||||||
|
|
||||||
|
...is like calling the following:
|
||||||
|
|
||||||
|
```
|
||||||
|
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 props`;
|
||||||
|
|
||||||
|
<Aside type="note">
|
||||||
|
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.
|
||||||
|
|
||||||
|
Another advantage over `HTMLElement.dataset` is that `WebComponent.props` can hold primitive types 'number', 'boolean', 'object' and 'string'.
|
||||||
|
</Aside>
|
||||||
|
|
||||||
|
### Alternatives
|
||||||
|
|
||||||
|
The current alternatives are using what `HTMLElement` provides out-of-the-box, which are:
|
||||||
|
|
||||||
|
1. `HTMLElement.dataset` for attributes prefixed with `data-*`. Read more about this [on MDN](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/dataset).
|
||||||
|
1. Methods for reading/writing attribute values: `setAttribute(...)` and `getAttribute(...)`; note that managing the attribute names as strings can be difficult as the code grows.
|
28
docs/src/content/docs/guides/shadow-dom.md
Normal file
|
@ -0,0 +1,28 @@
|
||||||
|
---
|
||||||
|
title: Using the Shadow DOM
|
||||||
|
slug: shadow-dom
|
||||||
|
---
|
||||||
|
|
||||||
|
Add a static property `shadowRootInit` with object value of type `ShadowRootInit` (see [options on MDN](https://developer.mozilla.org/en-US/docs/Web/API/Element/attachShadow#options)) to opt-in to using shadow dom for the whole component.
|
||||||
|
|
||||||
|
Try it now [on CodePen ↗](https://codepen.io/ayoayco-the-styleful/pen/VwRYVPv?editors=1010)
|
||||||
|
|
||||||
|
Example:
|
||||||
|
|
||||||
|
```js
|
||||||
|
class ShadowElement extends WebComponent {
|
||||||
|
static shadowRootInit = {
|
||||||
|
mode: 'open', // can be 'open' or 'closed'
|
||||||
|
}
|
||||||
|
|
||||||
|
get template() {
|
||||||
|
return html`
|
||||||
|
<div>
|
||||||
|
<p>Wow!?</p>
|
||||||
|
</div>
|
||||||
|
`
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
customElements.define('shadow-element', ShadowElement)
|
||||||
|
```
|
90
docs/src/content/docs/guides/styling.md
Normal file
|
@ -0,0 +1,90 @@
|
||||||
|
---
|
||||||
|
title: Styling
|
||||||
|
slug: styling
|
||||||
|
---
|
||||||
|
|
||||||
|
There are two ways we can safely have scoped styles:
|
||||||
|
|
||||||
|
1. Using style objects
|
||||||
|
2. Using the Shadow DOM and constructable stylesheets
|
||||||
|
|
||||||
|
It is highly recommended to use the second approach, as with it, browsers can assist more for performance.
|
||||||
|
|
||||||
|
## Using style objects
|
||||||
|
|
||||||
|
When using the built-in `html` function for tagged templates, a style object of type `Partial<CSSStyleDeclaration>` can be passed to any element's `style` attribute. This allows for calculated and conditional styles. Read more on style objects [on MDN](https://developer.mozilla.org/en-US/docs/Web/API/CSSStyleDeclaration).
|
||||||
|
|
||||||
|
Try it now with this [example on CodePen ↗](https://codepen.io/ayoayco-the-styleful/pen/bGzXjwQ?editors=1010)
|
||||||
|
|
||||||
|
```js
|
||||||
|
import { WebComponent } from 'https://unpkg.com/web-component-base@latest/index.js'
|
||||||
|
|
||||||
|
class StyledElement extends WebComponent {
|
||||||
|
static props = {
|
||||||
|
emphasize: false,
|
||||||
|
type: 'warn',
|
||||||
|
}
|
||||||
|
|
||||||
|
#typeStyles = {
|
||||||
|
warn: {
|
||||||
|
backgroundColor: 'yellow',
|
||||||
|
border: '1px solid orange',
|
||||||
|
},
|
||||||
|
error: {
|
||||||
|
backgroundColor: 'orange',
|
||||||
|
border: '1px solid red',
|
||||||
|
},
|
||||||
|
}
|
||||||
|
|
||||||
|
get template() {
|
||||||
|
return html`
|
||||||
|
<div
|
||||||
|
style=${{
|
||||||
|
...this.#typeStyles[this.props.type],
|
||||||
|
padding: '1em',
|
||||||
|
}}
|
||||||
|
>
|
||||||
|
<p style=${{ fontStyle: this.props.emphasize && 'italic' }}>Wow!</p>
|
||||||
|
</div>
|
||||||
|
`
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
customElements.define('styled-elements', StyledElement)
|
||||||
|
```
|
||||||
|
|
||||||
|
## Using the Shadow DOM and Constructable Stylesheets
|
||||||
|
|
||||||
|
If you [use the Shadow DOM](/shadow-dom), you can add a `static styles` property of type string which will be added in the `shadowRoot`'s [`adoptedStylesheets`](https://developer.mozilla.org/en-US/docs/Web/API/Document/adoptedStyleSheets).
|
||||||
|
|
||||||
|
Try it now with this [example on CodePen ↗](https://codepen.io/ayoayco-the-styleful/pen/JojmeEe?editors=1010)
|
||||||
|
|
||||||
|
```js
|
||||||
|
class StyledElement extends WebComponent {
|
||||||
|
static shadowRootInit = {
|
||||||
|
mode: 'open',
|
||||||
|
}
|
||||||
|
|
||||||
|
static styles = `
|
||||||
|
div {
|
||||||
|
background-color: yellow;
|
||||||
|
border: 1px solid black;
|
||||||
|
padding: 1em;
|
||||||
|
|
||||||
|
p {
|
||||||
|
text-decoration: underline;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
`
|
||||||
|
|
||||||
|
get template() {
|
||||||
|
return html`
|
||||||
|
<div>
|
||||||
|
<p>Wow!?</p>
|
||||||
|
</div>
|
||||||
|
`
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
customElements.define('styled-elements', StyledElement)
|
||||||
|
```
|
12
docs/src/content/docs/guides/template-vs-render.md
Normal file
|
@ -0,0 +1,12 @@
|
||||||
|
---
|
||||||
|
title: template vs render()
|
||||||
|
slug: template-vs-render
|
||||||
|
---
|
||||||
|
|
||||||
|
This mental model attempts to reduce the cognitive complexity of authoring components:
|
||||||
|
|
||||||
|
1. The `template` is a read-only property (initialized with a `get` keyword) that represents _how_ the component view is rendered.
|
||||||
|
1. There is a `render()` method that triggers a view render.
|
||||||
|
1. This `render()` method is _automatically_ called under the hood every time an attribute value changed.
|
||||||
|
1. You can _optionally_ call this `render()` method at any point to trigger a render if you need (eg, if you have private unobserved properties that need to manually trigger a render)
|
||||||
|
1. Overriding the `render()` function for handling a custom `template` is also possible. Here's an example of using `lit-html`: [View on CodePen ↗](https://codepen.io/ayoayco-the-styleful/pen/ZEwNJBR?editors=1010)
|
43
docs/src/content/docs/guides/usage.md
Normal file
|
@ -0,0 +1,43 @@
|
||||||
|
---
|
||||||
|
title: Usage
|
||||||
|
slug: usage
|
||||||
|
---
|
||||||
|
|
||||||
|
In your component class:
|
||||||
|
|
||||||
|
```js
|
||||||
|
// HelloWorld.mjs
|
||||||
|
import { WebComponent } from 'https://unpkg.com/web-component-base@latest/index.js'
|
||||||
|
|
||||||
|
class HelloWorld extends WebComponent {
|
||||||
|
static props = {
|
||||||
|
myName: 'World',
|
||||||
|
emotion: 'sad',
|
||||||
|
}
|
||||||
|
get template() {
|
||||||
|
return `
|
||||||
|
<h1>Hello ${this.props.myName}${this.props.emotion === 'sad' ? '. 😭' : '! 🙌'}</h1>
|
||||||
|
`
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
customElements.define('hello-world', HelloWorld)
|
||||||
|
```
|
||||||
|
|
||||||
|
In your HTML page:
|
||||||
|
|
||||||
|
```html
|
||||||
|
<head>
|
||||||
|
<script type="module" src="HelloWorld.mjs"></script>
|
||||||
|
</head>
|
||||||
|
<body>
|
||||||
|
<hello-world my-name="Ayo" emotion="sad">
|
||||||
|
<script>
|
||||||
|
const helloWorld = document.querySelector('hello-world');
|
||||||
|
|
||||||
|
setTimeout(() => {
|
||||||
|
helloWorld.setAttribute('emotion', 'excited');
|
||||||
|
}, 2500)
|
||||||
|
</script>
|
||||||
|
</body>
|
||||||
|
```
|
23
docs/src/content/docs/guides/why.mdx
Normal file
|
@ -0,0 +1,23 @@
|
||||||
|
---
|
||||||
|
title: Why use this base class?
|
||||||
|
slug: 'why'
|
||||||
|
---
|
||||||
|
|
||||||
|
import { Aside, Badge } from '@astrojs/starlight/components';
|
||||||
|
|
||||||
|
Often times, when simple websites need a quick custom element, the simplest way is to create one extending from `HTMLElement`. However, it can quickly reach a point where writing the code from scratch can seem confusing and hard to maintain especially when compared to other projects with more advanced setups.
|
||||||
|
|
||||||
|
Also, when coming from frameworks with an easy declarative coding experience (using templates), the default imperative way (e.g., creating instances of elements, manually attaching event handlers, and other DOM manipulations) is a frequent pain point we see.
|
||||||
|
|
||||||
|
By taking out bigger concerns that [a metaframework](https://github.com/ayoayco/mcfly) should handle, this project aims to focus on keeping the component-level matters simple and lightweight. This allows for addressing the said problems with virtually zero tooling required and thin abstractions from vanilla custom element APIs – giving you only the bare minimum code to be productive.
|
||||||
|
|
||||||
|
It works on current-day browsers without needing compilers, transpilers, or polyfills.
|
||||||
|
|
||||||
|
<Aside type="tip">
|
||||||
|
Have questions or suggestions? There are many ways to get in touch:
|
||||||
|
|
||||||
|
1. Open a [GitHub issue](https://github.com/ayoayco/wcb/issues/new) or [discussion](https://github.com/ayoayco/wcb/discussions)
|
||||||
|
1. Submit a ticket via [SourceHut todo](https://todo.sr.ht/~ayoayco/wcb)
|
||||||
|
1. Email me: [ayo@ayco.io](mailto:ayo@ayco.io)
|
||||||
|
1. Chat on Discord: [Ayo's Projects](https://discord.gg/kkvW7GYNAp)
|
||||||
|
</Aside>
|
35
docs/src/content/docs/index.mdx
Normal file
|
@ -0,0 +1,35 @@
|
||||||
|
---
|
||||||
|
title: Web Component Base
|
||||||
|
description: Web components in Easy Mode
|
||||||
|
template: splash
|
||||||
|
hero:
|
||||||
|
tagline: The ultra-minimal base class for your custom HTML elements
|
||||||
|
# image:
|
||||||
|
# file: ../../assets/houston.webp
|
||||||
|
actions:
|
||||||
|
- text: Get Started
|
||||||
|
link: /getting-started
|
||||||
|
icon: right-arrow
|
||||||
|
- text: Try on CodePen
|
||||||
|
link: https://codepen.io/ayoayco-the-styleful/pen/PoVegBK?editors=1010
|
||||||
|
icon: external
|
||||||
|
variant: minimal
|
||||||
|
---
|
||||||
|
|
||||||
|
import { Card, CardGrid } from '@astrojs/starlight/components';
|
||||||
|
|
||||||
|
<CardGrid stagger>
|
||||||
|
<Card title="Clean." icon="star">
|
||||||
|
Skip repetitive things when writing custom elements
|
||||||
|
</Card>
|
||||||
|
<Card title="Tiny." icon="add-document">
|
||||||
|
Only the bare minimum code to boost productivity
|
||||||
|
</Card>
|
||||||
|
<Card title="Easy." icon="heart">
|
||||||
|
Sensible life-cycle hooks that you understand and remember
|
||||||
|
</Card>
|
||||||
|
<Card title="Familiar." icon="open-book">
|
||||||
|
Declarative templates for DOM manipulation & event handlers
|
||||||
|
</Card>
|
||||||
|
</CardGrid>
|
||||||
|
|
11
docs/src/content/docs/reference/example.md
Normal file
|
@ -0,0 +1,11 @@
|
||||||
|
---
|
||||||
|
title: Example Reference
|
||||||
|
description: A reference page in my new Starlight docs site.
|
||||||
|
---
|
||||||
|
|
||||||
|
Reference pages are ideal for outlining how things work in terse and clear terms.
|
||||||
|
Less concerned with telling a story or addressing a specific use case, they should give a comprehensive outline of what you're documenting.
|
||||||
|
|
||||||
|
## Further reading
|
||||||
|
|
||||||
|
- Read [about reference](https://diataxis.fr/reference/) in the Diátaxis framework
|
5
docs/tsconfig.json
Normal file
|
@ -0,0 +1,5 @@
|
||||||
|
{
|
||||||
|
"extends": "astro/tsconfigs/strict",
|
||||||
|
"include": [".astro/types.d.ts", "**/*"],
|
||||||
|
"exclude": ["dist"]
|
||||||
|
}
|
18
eslint.config.mjs
Normal file
|
@ -0,0 +1,18 @@
|
||||||
|
import globals from 'globals'
|
||||||
|
import pluginJs from '@eslint/js'
|
||||||
|
import jsdoc from 'eslint-plugin-jsdoc'
|
||||||
|
|
||||||
|
/** @type {import('eslint').Linter.Config[]} */
|
||||||
|
export default [
|
||||||
|
{ languageOptions: { globals: globals.browser } },
|
||||||
|
pluginJs.configs.recommended,
|
||||||
|
jsdoc.configs['flat/recommended'],
|
||||||
|
{
|
||||||
|
rules: {
|
||||||
|
'no-unused-vars': 'warn',
|
||||||
|
},
|
||||||
|
},
|
||||||
|
{
|
||||||
|
ignores: ['site/*', 'dist/*'],
|
||||||
|
},
|
||||||
|
]
|
12
examples/constructed-styles/index.html
Normal file
|
@ -0,0 +1,12 @@
|
||||||
|
<!doctype html>
|
||||||
|
<html lang="en">
|
||||||
|
<head>
|
||||||
|
<meta charset="UTF-8" />
|
||||||
|
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||||
|
<title>WC demo</title>
|
||||||
|
<script type="module" src="./index.js"></script>
|
||||||
|
</head>
|
||||||
|
<body>
|
||||||
|
<styled-elements type="warn" condition></styled-elements>
|
||||||
|
</body>
|
||||||
|
</html>
|
30
examples/constructed-styles/index.js
Normal file
|
@ -0,0 +1,30 @@
|
||||||
|
// @ts-check
|
||||||
|
import { WebComponent, html } from '../../src/index.js'
|
||||||
|
|
||||||
|
class StyledElements extends WebComponent {
|
||||||
|
static shadowRootInit = {
|
||||||
|
mode: 'open',
|
||||||
|
}
|
||||||
|
|
||||||
|
static styles = `
|
||||||
|
div {
|
||||||
|
background-color: yellow;
|
||||||
|
border: 1px solid black;
|
||||||
|
padding: 1em;
|
||||||
|
|
||||||
|
p {
|
||||||
|
text-decoration: underline;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
`
|
||||||
|
|
||||||
|
get template() {
|
||||||
|
return html`
|
||||||
|
<div>
|
||||||
|
<p>Wow!?</p>
|
||||||
|
</div>
|
||||||
|
`
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
customElements.define('styled-elements', StyledElements)
|
17
examples/demo/BooleanPropTest.mjs
Normal file
|
@ -0,0 +1,17 @@
|
||||||
|
import { html, WebComponent } from '../../src/index.js'
|
||||||
|
|
||||||
|
export class BooleanPropTest extends WebComponent {
|
||||||
|
static props = {
|
||||||
|
isInline: false,
|
||||||
|
anotherone: false,
|
||||||
|
}
|
||||||
|
|
||||||
|
get template() {
|
||||||
|
return html`
|
||||||
|
<p>is-inline: ${this.props.isInline}</p>
|
||||||
|
<p>another-one: ${this.props.anotherone}</p>
|
||||||
|
`
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
customElements.define('boolean-prop-test', BooleanPropTest)
|
17
examples/demo/Counter.mjs
Normal file
|
@ -0,0 +1,17 @@
|
||||||
|
// @ts-check
|
||||||
|
import { WebComponent, html } from '../../src/index.js'
|
||||||
|
|
||||||
|
export class Counter extends WebComponent {
|
||||||
|
static props = {
|
||||||
|
count: 0,
|
||||||
|
}
|
||||||
|
get template() {
|
||||||
|
return html`
|
||||||
|
<button onClick=${() => ++this.props.count} id="btn">
|
||||||
|
${this.props.count}
|
||||||
|
</button>
|
||||||
|
`
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
customElements.define('my-counter', Counter)
|
26
examples/demo/HelloWorld.mjs
Normal file
|
@ -0,0 +1,26 @@
|
||||||
|
// @ts-check
|
||||||
|
import { html, WebComponent } from '../../src/index.js'
|
||||||
|
|
||||||
|
export class HelloWorld extends WebComponent {
|
||||||
|
static props = {
|
||||||
|
count: 0,
|
||||||
|
emotion: 'sad',
|
||||||
|
}
|
||||||
|
|
||||||
|
onInit() {
|
||||||
|
this.props.count = 0
|
||||||
|
}
|
||||||
|
|
||||||
|
get template() {
|
||||||
|
const label = this.props.count ? `Clicked ${this.props.count}` : 'World'
|
||||||
|
const emote = this.props.emotion === 'sad' ? '. 😭' : '! 🙌'
|
||||||
|
|
||||||
|
return html`
|
||||||
|
<button onclick=${() => ++this.props.count}>
|
||||||
|
Hello ${label}${emote}
|
||||||
|
</button>
|
||||||
|
`
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
customElements.define('hello-world', HelloWorld)
|
21
examples/demo/SimpleText.mjs
Normal file
|
@ -0,0 +1,21 @@
|
||||||
|
// @ts-check
|
||||||
|
import { html, WebComponent } from '../../src/index.js'
|
||||||
|
|
||||||
|
class SimpleText extends WebComponent {
|
||||||
|
clickCallback() {
|
||||||
|
console.log('>>> click!')
|
||||||
|
}
|
||||||
|
|
||||||
|
onDestroy() {
|
||||||
|
console.log('>>> removing event listener')
|
||||||
|
this.removeEventListener('click', this.clickCallback)
|
||||||
|
}
|
||||||
|
|
||||||
|
get template() {
|
||||||
|
return html`<span onclick=${this.clickCallback} style="cursor:pointer"
|
||||||
|
>Click me!</span
|
||||||
|
>`
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
customElements.define('simple-text', SimpleText)
|
16
examples/demo/Toggle.js
Normal file
|
@ -0,0 +1,16 @@
|
||||||
|
import { WebComponent, html } from '../../src/index.js'
|
||||||
|
|
||||||
|
class Toggle extends WebComponent {
|
||||||
|
static props = {
|
||||||
|
toggle: false,
|
||||||
|
}
|
||||||
|
get template() {
|
||||||
|
return html`
|
||||||
|
<button onClick=${() => (this.props.toggle = !this.props.toggle)}>
|
||||||
|
${this.props.toggle}
|
||||||
|
</button>
|
||||||
|
`
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
customElements.define('my-toggle', Toggle)
|
33
examples/demo/index.html
Normal file
|
@ -0,0 +1,33 @@
|
||||||
|
<!doctype html>
|
||||||
|
<html lang="en">
|
||||||
|
<head>
|
||||||
|
<meta charset="UTF-8" />
|
||||||
|
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||||
|
<title>WC demo</title>
|
||||||
|
<script type="module" src="./HelloWorld.mjs"></script>
|
||||||
|
<script type="module" src="./SimpleText.mjs"></script>
|
||||||
|
<script type="module" src="./BooleanPropTest.mjs"></script>
|
||||||
|
<script type="module" src="./Counter.mjs"></script>
|
||||||
|
<script type="module" src="./Toggle.js"></script>
|
||||||
|
</head>
|
||||||
|
<body>
|
||||||
|
<my-toggle></my-toggle>
|
||||||
|
<my-toggle toggle></my-toggle>
|
||||||
|
<hr />
|
||||||
|
<hello-world emotion="sad"></hello-world>
|
||||||
|
<my-counter></my-counter>
|
||||||
|
<p>
|
||||||
|
<simple-text></simple-text>
|
||||||
|
</p>
|
||||||
|
<p>
|
||||||
|
<boolean-prop-test is-inline anotherOne></boolean-prop-test>
|
||||||
|
</p>
|
||||||
|
|
||||||
|
<script type="module">
|
||||||
|
const helloWorld = document.querySelector('hello-world')
|
||||||
|
setTimeout(() => {
|
||||||
|
helloWorld.props.emotion = 'excited'
|
||||||
|
}, 2500)
|
||||||
|
</script>
|
||||||
|
</body>
|
||||||
|
</html>
|
57
examples/pens/counter-toggle.html
Normal file
|
@ -0,0 +1,57 @@
|
||||||
|
<!doctype html>
|
||||||
|
<html lang="en">
|
||||||
|
<head>
|
||||||
|
<meta charset="UTF-8" />
|
||||||
|
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||||
|
<title>WC demo</title>
|
||||||
|
<style>
|
||||||
|
* {
|
||||||
|
font-size: larger;
|
||||||
|
}
|
||||||
|
</style>
|
||||||
|
<script type="module">
|
||||||
|
import {
|
||||||
|
WebComponent,
|
||||||
|
html,
|
||||||
|
} from 'https://esm.sh/web-component-base@latest'
|
||||||
|
|
||||||
|
export class Counter extends WebComponent {
|
||||||
|
static props = {
|
||||||
|
count: 0,
|
||||||
|
}
|
||||||
|
get template() {
|
||||||
|
return html`<button onClick=${() => ++this.props.count}>
|
||||||
|
${this.props.count}
|
||||||
|
</button>`
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
class Toggle extends WebComponent {
|
||||||
|
static props = {
|
||||||
|
toggle: false,
|
||||||
|
}
|
||||||
|
|
||||||
|
clickFn = () => (this.props.toggle = !this.props.toggle)
|
||||||
|
|
||||||
|
get template() {
|
||||||
|
return html`<button onclick=${this.clickFn}>
|
||||||
|
${this.props.toggle ? 'On' : 'Off'}
|
||||||
|
</button>`
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
customElements.define('my-counter', Counter)
|
||||||
|
customElements.define('my-toggle', Toggle)
|
||||||
|
</script>
|
||||||
|
</head>
|
||||||
|
<body>
|
||||||
|
<div>
|
||||||
|
Counter:
|
||||||
|
<my-counter />
|
||||||
|
</div>
|
||||||
|
<div>
|
||||||
|
Toggle:
|
||||||
|
<my-toggle />
|
||||||
|
</div>
|
||||||
|
</body>
|
||||||
|
</html>
|
12
examples/props-blueprint/hello-world.js
Normal file
|
@ -0,0 +1,12 @@
|
||||||
|
import { html, WebComponent } from '../../src/index.js'
|
||||||
|
|
||||||
|
export class HelloWorld extends WebComponent {
|
||||||
|
static props = {
|
||||||
|
myName: 'World',
|
||||||
|
}
|
||||||
|
get template() {
|
||||||
|
return html`<p>Hello ${this.props.myName}</p>`
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
customElements.define('hello-world', HelloWorld)
|
14
examples/props-blueprint/index.html
Normal file
|
@ -0,0 +1,14 @@
|
||||||
|
<!doctype html>
|
||||||
|
<html lang="en">
|
||||||
|
<head>
|
||||||
|
<meta charset="UTF-8" />
|
||||||
|
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||||
|
<title>WC demo</title>
|
||||||
|
<script type="module" src="./index.js"></script>
|
||||||
|
<script type="module" src="./hello-world.js"></script>
|
||||||
|
</head>
|
||||||
|
<body>
|
||||||
|
<my-counter></my-counter>
|
||||||
|
<hello-world></hello-world>
|
||||||
|
</body>
|
||||||
|
</html>
|
14
examples/props-blueprint/index.js
Normal file
|
@ -0,0 +1,14 @@
|
||||||
|
import { html, WebComponent } from '../../src/index.js'
|
||||||
|
|
||||||
|
export class Counter extends WebComponent {
|
||||||
|
static props = {
|
||||||
|
count: 123,
|
||||||
|
}
|
||||||
|
get template() {
|
||||||
|
return html`<button onclick=${() => ++this.props.count} id="btn">
|
||||||
|
${this.props.count}
|
||||||
|
</button>`
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
customElements.define('my-counter', Counter)
|
12
examples/style-objects/index.html
Normal file
|
@ -0,0 +1,12 @@
|
||||||
|
<!doctype html>
|
||||||
|
<html lang="en">
|
||||||
|
<head>
|
||||||
|
<meta charset="UTF-8" />
|
||||||
|
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||||
|
<title>WC demo</title>
|
||||||
|
<script type="module" src="./index.js"></script>
|
||||||
|
</head>
|
||||||
|
<body>
|
||||||
|
<styled-elements type="warn" condition></styled-elements>
|
||||||
|
</body>
|
||||||
|
</html>
|
39
examples/style-objects/index.js
Normal file
|
@ -0,0 +1,39 @@
|
||||||
|
// @ts-check
|
||||||
|
import { WebComponent, html } from '../../src/index.js'
|
||||||
|
|
||||||
|
class StyledElements extends WebComponent {
|
||||||
|
static props = {
|
||||||
|
condition: false,
|
||||||
|
type: 'info',
|
||||||
|
}
|
||||||
|
|
||||||
|
#typeStyles = {
|
||||||
|
info: {
|
||||||
|
backgroundColor: 'blue',
|
||||||
|
border: '1px solid green',
|
||||||
|
},
|
||||||
|
warn: {
|
||||||
|
backgroundColor: 'yellow',
|
||||||
|
border: '1px solid orange',
|
||||||
|
},
|
||||||
|
error: {
|
||||||
|
backgroundColor: 'orange',
|
||||||
|
border: '1px solid red',
|
||||||
|
},
|
||||||
|
}
|
||||||
|
|
||||||
|
get template() {
|
||||||
|
return html`
|
||||||
|
<div
|
||||||
|
style=${{
|
||||||
|
...this.#typeStyles[this.props.type],
|
||||||
|
padding: '1em',
|
||||||
|
}}
|
||||||
|
>
|
||||||
|
<p style=${{ fontStyle: this.props.condition && 'italic' }}>Wow!</p>
|
||||||
|
</div>
|
||||||
|
`
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
customElements.define('styled-elements', StyledElements)
|
17
examples/templating/index.html
Normal file
|
@ -0,0 +1,17 @@
|
||||||
|
<!doctype html>
|
||||||
|
<html lang="en">
|
||||||
|
<head>
|
||||||
|
<meta charset="UTF-8" />
|
||||||
|
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||||
|
<title>WC demo</title>
|
||||||
|
<script type="module" src="./index.js"></script>
|
||||||
|
<script type="module" src="./with-lit.js"></script>
|
||||||
|
</head>
|
||||||
|
<body>
|
||||||
|
<h2>With our html</h2>
|
||||||
|
<my-counter></my-counter>
|
||||||
|
<hr />
|
||||||
|
<h2>With lit-html</h2>
|
||||||
|
<lit-counter></lit-counter>
|
||||||
|
</body>
|
||||||
|
</html>
|
49
examples/templating/index.js
Normal file
|
@ -0,0 +1,49 @@
|
||||||
|
// @ts-check
|
||||||
|
import { WebComponent, html } from '../../src/index.js'
|
||||||
|
|
||||||
|
export class Counter extends WebComponent {
|
||||||
|
static props = {
|
||||||
|
count: 123,
|
||||||
|
}
|
||||||
|
get template() {
|
||||||
|
const list = ['a', 'b', 'c', 'what']
|
||||||
|
const links = [
|
||||||
|
{
|
||||||
|
url: 'https://ayco.io',
|
||||||
|
text: 'Ayo Ayco',
|
||||||
|
},
|
||||||
|
{
|
||||||
|
url: 'https://ayco.io/gh/McFly',
|
||||||
|
text: 'McFly',
|
||||||
|
},
|
||||||
|
]
|
||||||
|
|
||||||
|
return html`
|
||||||
|
<button
|
||||||
|
class="hey"
|
||||||
|
id="btn"
|
||||||
|
onClick=${() => ++this.props.count}
|
||||||
|
style="background-color: green; color: white;"
|
||||||
|
about="Elephant"
|
||||||
|
data-name="thing"
|
||||||
|
aria-name="thingz"
|
||||||
|
>
|
||||||
|
<span>${this.props.count}</span>
|
||||||
|
</button>
|
||||||
|
<form style="margin: 1em 0;">
|
||||||
|
<label data-my-name="Ayo" for="the-input">Name</label>
|
||||||
|
<input id="the-input" type="foo" value="Name:" />
|
||||||
|
</form>
|
||||||
|
${list.map((item) => html`<p>${item}</p>`)}
|
||||||
|
<h3 about="Elephant">Links</h3>
|
||||||
|
<ul>
|
||||||
|
${links.map(
|
||||||
|
(link) =>
|
||||||
|
html`<li><a href=${link.url} target="_blank">${link.text}</a></li>`
|
||||||
|
)}
|
||||||
|
</ul>
|
||||||
|
`
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
customElements.define('my-counter', Counter)
|
55
examples/templating/with-lit.js
Normal file
|
@ -0,0 +1,55 @@
|
||||||
|
import { WebComponent } from '../../src/index.js'
|
||||||
|
import {
|
||||||
|
html,
|
||||||
|
render as lit,
|
||||||
|
} from 'https://unpkg.com/lit-html@3.1.0/lit-html.js'
|
||||||
|
|
||||||
|
export class LitCounter extends WebComponent {
|
||||||
|
static props = {
|
||||||
|
count: 123,
|
||||||
|
}
|
||||||
|
get template() {
|
||||||
|
const list = ['a', 'b', 'c', 'what']
|
||||||
|
const links = [
|
||||||
|
{
|
||||||
|
url: 'https://ayco.io',
|
||||||
|
text: 'Ayo Ayco',
|
||||||
|
},
|
||||||
|
{
|
||||||
|
url: 'https://ayco.io/gh/McFly',
|
||||||
|
text: 'McFly',
|
||||||
|
},
|
||||||
|
]
|
||||||
|
|
||||||
|
return html`
|
||||||
|
<button
|
||||||
|
class="hey"
|
||||||
|
id="btn"
|
||||||
|
@click=${() => ++this.props.count}
|
||||||
|
style="background-color: green; color: white;"
|
||||||
|
about="Elephant"
|
||||||
|
data-name="thing"
|
||||||
|
aria-name="thingz"
|
||||||
|
>
|
||||||
|
<span>${this.props.count}</span>
|
||||||
|
</button>
|
||||||
|
<form style="margin: 1em 0;">
|
||||||
|
<label data-my-name="Ayo" for="the-input">Name</label>
|
||||||
|
<input id="the-input" type="foo" value="Name:" />
|
||||||
|
</form>
|
||||||
|
${list.map((item) => html`<p>${item}</p>`)}
|
||||||
|
<h3 about="Elephant">Links</h3>
|
||||||
|
<ul>
|
||||||
|
${links.map(
|
||||||
|
(link) =>
|
||||||
|
html`<li><a href=${link.url} target="_blank">${link.text}</a></li>`
|
||||||
|
)}
|
||||||
|
</ul>
|
||||||
|
`
|
||||||
|
}
|
||||||
|
render() {
|
||||||
|
lit(this.template, this)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
customElements.define('lit-counter', LitCounter)
|
15
examples/type-restore/Counter.mjs
Normal file
|
@ -0,0 +1,15 @@
|
||||||
|
// @ts-check
|
||||||
|
import { html, WebComponent } from '../../src/index.js'
|
||||||
|
|
||||||
|
export class Counter extends WebComponent {
|
||||||
|
static props = {
|
||||||
|
count: 1,
|
||||||
|
}
|
||||||
|
get template() {
|
||||||
|
return html`<button onclick=${() => ++this.props.count}>
|
||||||
|
${this.props.count}
|
||||||
|
</button>`
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
customElements.define('my-counter', Counter)
|
14
examples/type-restore/HelloWorld.mjs
Normal file
|
@ -0,0 +1,14 @@
|
||||||
|
import { html, WebComponent } from '../../src/index.js'
|
||||||
|
|
||||||
|
export class HelloWorld extends WebComponent {
|
||||||
|
static props = {
|
||||||
|
name: 'a',
|
||||||
|
}
|
||||||
|
addA = () => (this.props.name += 'a')
|
||||||
|
|
||||||
|
get template() {
|
||||||
|
return html`<button onclick=${this.addA}>W${this.props.name}h!</button>`
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
customElements.define('my-hello-world', HelloWorld)
|
48
examples/type-restore/Object.mjs
Normal file
|
@ -0,0 +1,48 @@
|
||||||
|
import { html, WebComponent } from '../../src/index.js'
|
||||||
|
|
||||||
|
/**
|
||||||
|
* TODO: rendering currently wipes all children so focus gets removed on fields
|
||||||
|
*/
|
||||||
|
export class ObjectText extends WebComponent {
|
||||||
|
static props = {
|
||||||
|
object: {
|
||||||
|
hello: 'worldzz',
|
||||||
|
age: 2,
|
||||||
|
},
|
||||||
|
}
|
||||||
|
onChanges() {
|
||||||
|
console.log('>>> object', this.props.object)
|
||||||
|
}
|
||||||
|
get template() {
|
||||||
|
return html`
|
||||||
|
<form>
|
||||||
|
<label for="greeting-field">Hello</label>
|
||||||
|
<textarea
|
||||||
|
onkeyup=${(event) => {
|
||||||
|
this.props.object = {
|
||||||
|
...this.props.object,
|
||||||
|
hello: event.target.value,
|
||||||
|
}
|
||||||
|
}}
|
||||||
|
id="greeting-field"
|
||||||
|
>
|
||||||
|
${this.props.object.hello}
|
||||||
|
</textarea
|
||||||
|
>
|
||||||
|
<label for="age-field">Age</label>
|
||||||
|
<input
|
||||||
|
onkeyup=${(event) => {
|
||||||
|
this.props.object = {
|
||||||
|
...this.props.object,
|
||||||
|
age: event.target.value,
|
||||||
|
}
|
||||||
|
}}
|
||||||
|
id="age-field"
|
||||||
|
value=${this.props.object.age}
|
||||||
|
/>
|
||||||
|
</form>
|
||||||
|
`
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
customElements.define('my-object', ObjectText)
|
20
examples/type-restore/Toggle.mjs
Normal file
|
@ -0,0 +1,20 @@
|
||||||
|
// @ts-check
|
||||||
|
import { html, WebComponent } from '../../src/index.js'
|
||||||
|
|
||||||
|
export class Toggle extends WebComponent {
|
||||||
|
static props = {
|
||||||
|
toggle: false,
|
||||||
|
}
|
||||||
|
handleToggle() {
|
||||||
|
this.props.toggle = !this.props.toggle
|
||||||
|
}
|
||||||
|
get template() {
|
||||||
|
return html`
|
||||||
|
<button onclick=${() => this.handleToggle()} id="toggle">
|
||||||
|
${this.props.toggle ? 'On' : 'Off'}
|
||||||
|
</button>
|
||||||
|
`
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
customElements.define('my-toggle', Toggle)
|
44
examples/type-restore/index.html
Normal file
|
@ -0,0 +1,44 @@
|
||||||
|
<!doctype html>
|
||||||
|
<html lang="en">
|
||||||
|
|
||||||
|
<head>
|
||||||
|
<meta charset="UTF-8" />
|
||||||
|
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||||
|
<title>WC demo</title>
|
||||||
|
<script type="module" src="./Counter.mjs"></script>
|
||||||
|
<script type="module" src="./Toggle.mjs"></script>
|
||||||
|
<script type="module" src="./HelloWorld.mjs"></script>
|
||||||
|
<script type="module" src="./Object.mjs"></script>
|
||||||
|
<style>
|
||||||
|
* {
|
||||||
|
font-size: larger;
|
||||||
|
}
|
||||||
|
</style>
|
||||||
|
</head>
|
||||||
|
|
||||||
|
<body>
|
||||||
|
<div>Counter: <my-counter></my-counter></div>
|
||||||
|
<div>Toggle: <my-toggle></my-toggle></div>
|
||||||
|
<div>String: <my-hello-world></my-hello-world></div>
|
||||||
|
<div>
|
||||||
|
<my-object></my-object>
|
||||||
|
<p id="display-panel"></p>
|
||||||
|
</div>
|
||||||
|
<script type="module">
|
||||||
|
/**
|
||||||
|
* TODO: fix using custom events
|
||||||
|
*/
|
||||||
|
|
||||||
|
// import { attachEffect } from '../../src/index.js'
|
||||||
|
// const myObjectEl = document.querySelector('my-object')
|
||||||
|
// const objectProp = myObjectEl.props.object
|
||||||
|
// const displayPanelEl = document.querySelector('#display-panel')
|
||||||
|
// displayPanelEl.textContent = JSON.stringify(objectProp)
|
||||||
|
// attachEffect(objectProp, (object) => {
|
||||||
|
// displayPanelEl.textContent = JSON.stringify(object)
|
||||||
|
// })
|
||||||
|
// console.log(JSON.stringify(object))
|
||||||
|
</script>
|
||||||
|
</body>
|
||||||
|
|
||||||
|
</html>
|
13
examples/use-shadow/index.html
Normal file
|
@ -0,0 +1,13 @@
|
||||||
|
<!doctype html>
|
||||||
|
<html lang="en">
|
||||||
|
<head>
|
||||||
|
<meta charset="UTF-8" />
|
||||||
|
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||||
|
<title>WC demo</title>
|
||||||
|
<script type="module" src="./index.js"></script>
|
||||||
|
</head>
|
||||||
|
<body>
|
||||||
|
<h2>With our html</h2>
|
||||||
|
<my-counter></my-counter>
|
||||||
|
</body>
|
||||||
|
</html>
|
55
examples/use-shadow/index.js
Normal file
|
@ -0,0 +1,55 @@
|
||||||
|
// @ts-check
|
||||||
|
import { WebComponent, html } from '../../src/index.js'
|
||||||
|
|
||||||
|
export class Counter extends WebComponent {
|
||||||
|
static props = {
|
||||||
|
count: 123,
|
||||||
|
}
|
||||||
|
static shadowRootInit = {
|
||||||
|
mode: 'open',
|
||||||
|
}
|
||||||
|
|
||||||
|
get template() {
|
||||||
|
const list = ['a', 'b', 'c', 'what']
|
||||||
|
const links = [
|
||||||
|
{
|
||||||
|
url: 'https://ayco.io',
|
||||||
|
text: 'Ayo Ayco',
|
||||||
|
},
|
||||||
|
{
|
||||||
|
url: 'https://ayco.io/gh/McFly',
|
||||||
|
text: 'McFly',
|
||||||
|
},
|
||||||
|
]
|
||||||
|
|
||||||
|
return html`
|
||||||
|
<button
|
||||||
|
class="hey"
|
||||||
|
id="btn"
|
||||||
|
onClick=${() => ++this.props.count}
|
||||||
|
style=${{ backgroundColor: 'green', color: 'white' }}
|
||||||
|
about="Elephant"
|
||||||
|
data-name="thing"
|
||||||
|
aria-name="thingz"
|
||||||
|
>
|
||||||
|
<span>${this.props.count}</span>
|
||||||
|
</button>
|
||||||
|
<form style="margin: 1em 0;">
|
||||||
|
<label data-my-name="Ayo" for="the-input">Name</label>
|
||||||
|
<input id="the-input" type="foo" value="Name:" />
|
||||||
|
</form>
|
||||||
|
${list.map((item) => html`<p>${item}</p>`)}
|
||||||
|
<h3 about="Elephant">Links</h3>
|
||||||
|
<ul>
|
||||||
|
${links.map(
|
||||||
|
(link) =>
|
||||||
|
html`<li>
|
||||||
|
<a href=${link.url} target="_blank">${link.text}</a>
|
||||||
|
</li>`
|
||||||
|
)}
|
||||||
|
</ul>
|
||||||
|
`
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
customElements.define('my-counter', Counter)
|
3
netlify.toml
Normal file
|
@ -0,0 +1,3 @@
|
||||||
|
[build]
|
||||||
|
base = "docs"
|
||||||
|
publish = "dist"
|
29
package-lock.json
generated
|
@ -1,29 +0,0 @@
|
||||||
{
|
|
||||||
"name": "web-component-base",
|
|
||||||
"version": "1.9.0",
|
|
||||||
"lockfileVersion": 3,
|
|
||||||
"requires": true,
|
|
||||||
"packages": {
|
|
||||||
"": {
|
|
||||||
"name": "web-component-base",
|
|
||||||
"version": "1.9.0",
|
|
||||||
"license": "MIT",
|
|
||||||
"devDependencies": {
|
|
||||||
"typescript": "^5.2.2"
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"node_modules/typescript": {
|
|
||||||
"version": "5.2.2",
|
|
||||||
"resolved": "https://registry.npmjs.org/typescript/-/typescript-5.2.2.tgz",
|
|
||||||
"integrity": "sha512-mI4WrpHsbCIcwT9cF4FZvr80QUeKvsUsUvKDoR+X/7XHQH98xYD8YHZg7ANtz2GtZt/CBq2QJ0thkGJMHfqc1w==",
|
|
||||||
"dev": true,
|
|
||||||
"bin": {
|
|
||||||
"tsc": "bin/tsc",
|
|
||||||
"tsserver": "bin/tsserver"
|
|
||||||
},
|
|
||||||
"engines": {
|
|
||||||
"node": ">=14.17"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
106
package.json
|
@ -1,23 +1,51 @@
|
||||||
{
|
{
|
||||||
"name": "web-component-base",
|
"name": "web-component-base",
|
||||||
"version": "1.9.0",
|
"version": "4.1.1",
|
||||||
"description": "Minimal base class for creating reactive custom elements easily",
|
"description": "A zero-dependency & tiny JS base class for creating reactive custom elements easily",
|
||||||
"main": "index.d.ts",
|
|
||||||
"type": "module",
|
"type": "module",
|
||||||
|
"exports": {
|
||||||
|
".": {
|
||||||
|
"types": "./dist/index.d.ts",
|
||||||
|
"import": "./dist/index.js"
|
||||||
|
},
|
||||||
|
"./*": {
|
||||||
|
"types": "./dist/*.d.ts",
|
||||||
|
"import": "./dist/*.js"
|
||||||
|
},
|
||||||
|
"./utils": {
|
||||||
|
"types": "./dist/utils/index.d.ts",
|
||||||
|
"import": "./dist/utils/index.js"
|
||||||
|
},
|
||||||
|
"./utils/*": {
|
||||||
|
"types": "./dist/utils/*.d.ts",
|
||||||
|
"import": "./dist/utils/*.js"
|
||||||
|
},
|
||||||
|
"./package.json": "./package.json"
|
||||||
|
},
|
||||||
|
"main": "./dist/index.js",
|
||||||
|
"types": "./dist/index.d.ts",
|
||||||
"scripts": {
|
"scripts": {
|
||||||
|
"preinstall": "npx only-allow pnpm",
|
||||||
"start": "npx simple-server .",
|
"start": "npx simple-server .",
|
||||||
"build": "tsc --allowJs src/* --outDir dist --declaration --emitDeclarationOnly",
|
"dev": "npm start",
|
||||||
|
"test": "vitest --run",
|
||||||
|
"test:watch": "vitest",
|
||||||
|
"demo": "npx simple-server .",
|
||||||
|
"docs": "pnpm -F docs start",
|
||||||
|
"build": "pnpm run clean && tsc && pnpm run copy:source",
|
||||||
|
"size-limit": "pnpm run build && size-limit",
|
||||||
"clean": "rm -rf dist",
|
"clean": "rm -rf dist",
|
||||||
"copy:meta": "cp package.json ./dist && cp README.md ./dist",
|
"copy:source": "esbuild --minify --bundle ./src/*.js ./src/utils/* --outdir=\"./dist\" --format=\"esm\"",
|
||||||
"copy:source": "cp ./src/* ./dist",
|
"pub": "pnpm run clean && pnpm run build && npm publish",
|
||||||
"build:publish": "npm run clean && npm run build && npm run copy:meta && npm run copy:source && cd ./dist && npm publish --access public",
|
"pub:patch": "npm version patch && pnpm run pub",
|
||||||
"publish:patch": "npm version patch && npm run build:publish",
|
"pub:minor": "npm version minor && pnpm run pub",
|
||||||
"publish:minor": "npm version minor && npm run build:publish"
|
"pub:major": "npm version major && pnpm run pub",
|
||||||
},
|
"format": "prettier . --write",
|
||||||
"repository": {
|
"lint": "eslint . --config eslint.config.mjs",
|
||||||
"type": "git",
|
"prepare": "husky install"
|
||||||
"url": "https://git.sr.ht/~ayoayco/web-component-base"
|
|
||||||
},
|
},
|
||||||
|
"repository": "https://github.com/ayoayco/web-component-base",
|
||||||
|
"homepage": "https://WebComponent.io",
|
||||||
"keywords": [
|
"keywords": [
|
||||||
"web components",
|
"web components",
|
||||||
"web component",
|
"web component",
|
||||||
|
@ -27,10 +55,54 @@
|
||||||
"author": "Ayo Ayco",
|
"author": "Ayo Ayco",
|
||||||
"license": "MIT",
|
"license": "MIT",
|
||||||
"bugs": {
|
"bugs": {
|
||||||
"url": "https://todo.sr.ht/~ayoayco/web-component-base"
|
"url": "https://github.com/ayoayco/web-component-base/issues"
|
||||||
},
|
},
|
||||||
"homepage": "https://git.sr.ht/~ayoayco/web-component-base#readme",
|
|
||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
"typescript": "^5.2.2"
|
"@eslint/js": "^9.29.0",
|
||||||
}
|
"@size-limit/preset-small-lib": "^11.2.0",
|
||||||
|
"@vitest/coverage-v8": "3.2.4",
|
||||||
|
"esbuild": "^0.25.5",
|
||||||
|
"eslint": "^9.29.0",
|
||||||
|
"eslint-plugin-jsdoc": "^51.2.3",
|
||||||
|
"globals": "^16.2.0",
|
||||||
|
"happy-dom": "^18.0.1",
|
||||||
|
"husky": "^9.1.7",
|
||||||
|
"netlify-cli": "^22.1.6",
|
||||||
|
"prettier": "^3.6.1",
|
||||||
|
"release-it": "^19.0.3",
|
||||||
|
"simple-server": "^1.1.1",
|
||||||
|
"size-limit": "^11.2.0",
|
||||||
|
"typescript": "^5.8.3",
|
||||||
|
"vitest": "^3.2.4"
|
||||||
|
},
|
||||||
|
"size-limit": [
|
||||||
|
{
|
||||||
|
"path": "./dist/WebComponent.js",
|
||||||
|
"limit": "1.2 KB"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"path": "./dist/html.js",
|
||||||
|
"limit": "0.6 KB"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"path": "./dist/utils/create-element.js",
|
||||||
|
"limit": "0.5 KB"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"path": "./dist/utils/deserialize.js",
|
||||||
|
"limit": "0.5 KB"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"path": "./dist/utils/serialize.js",
|
||||||
|
"limit": "0.5 KB"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"path": "./dist/utils/get-camel-case.js",
|
||||||
|
"limit": "0.5 KB"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"path": "./dist/utils/get-kebab-case.js",
|
||||||
|
"limit": "0.5 KB"
|
||||||
|
}
|
||||||
|
]
|
||||||
}
|
}
|
||||||
|
|
14119
pnpm-lock.yaml
Normal file
3
pnpm-workspace.yaml
Normal file
|
@ -0,0 +1,3 @@
|
||||||
|
packages:
|
||||||
|
# include packages in subfolders (e.g. apps/ and packages/)
|
||||||
|
- 'docs/'
|
14
prettier.config.mjs
Normal file
|
@ -0,0 +1,14 @@
|
||||||
|
// prettier.config.js, .prettierrc.js, prettier.config.mjs, or .prettierrc.mjs
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @see https://prettier.io/docs/en/configuration.html
|
||||||
|
* @type {import("prettier").Config}
|
||||||
|
*/
|
||||||
|
const config = {
|
||||||
|
trailingComma: 'es5',
|
||||||
|
tabWidth: 2,
|
||||||
|
semi: false,
|
||||||
|
singleQuote: true,
|
||||||
|
}
|
||||||
|
|
||||||
|
export default config
|
223
src/WebComponent.js
Normal file
|
@ -0,0 +1,223 @@
|
||||||
|
/**
|
||||||
|
* @license MIT <https://opensource.org/licenses/MIT>
|
||||||
|
* @author Ayo Ayco <https://ayo.ayco.io>
|
||||||
|
*/
|
||||||
|
|
||||||
|
import {
|
||||||
|
createElement,
|
||||||
|
getKebabCase,
|
||||||
|
getCamelCase,
|
||||||
|
serialize,
|
||||||
|
deserialize,
|
||||||
|
} from './utils/index.js'
|
||||||
|
|
||||||
|
/**
|
||||||
|
* A minimal base class to reduce the complexity of creating reactive custom elements
|
||||||
|
* @see https://WebComponent.io
|
||||||
|
*/
|
||||||
|
export class WebComponent extends HTMLElement {
|
||||||
|
#host
|
||||||
|
#prevDOM
|
||||||
|
#props
|
||||||
|
#typeMap = {}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Blueprint for the Proxy props
|
||||||
|
* @typedef {{[name: string]: any}} PropStringMap
|
||||||
|
* @type {PropStringMap}
|
||||||
|
*/
|
||||||
|
static props
|
||||||
|
|
||||||
|
// TODO: support array of styles
|
||||||
|
static styles
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Read-only string property that represents how the component will be rendered
|
||||||
|
* @returns {string | any}
|
||||||
|
* @see https://www.npmjs.com/package/web-component-base#template-vs-render
|
||||||
|
*/
|
||||||
|
get template() {
|
||||||
|
return ''
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Shadow root initialization options
|
||||||
|
* @type {ShadowRootInit}
|
||||||
|
*/
|
||||||
|
static shadowRootInit
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Read-only property containing camelCase counterparts of observed attributes.
|
||||||
|
* @see https://www.npmjs.com/package/web-component-base#prop-access
|
||||||
|
* @see https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/dataset
|
||||||
|
* @type {PropStringMap}
|
||||||
|
*/
|
||||||
|
get props() {
|
||||||
|
return this.#props
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Triggered after view is initialized
|
||||||
|
*/
|
||||||
|
afterViewInit() {}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Triggered when the component is connected to the DOM
|
||||||
|
*/
|
||||||
|
onInit() {}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Triggered when the component is disconnected from the DOM
|
||||||
|
*/
|
||||||
|
onDestroy() {}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Triggered when an attribute value changes
|
||||||
|
* @typedef {{
|
||||||
|
* property: string,
|
||||||
|
* previousValue: any,
|
||||||
|
* currentValue: any
|
||||||
|
* }} Changes
|
||||||
|
* @param {Changes} changes
|
||||||
|
*/
|
||||||
|
onChanges(changes) {}
|
||||||
|
|
||||||
|
constructor() {
|
||||||
|
super()
|
||||||
|
this.#initializeProps()
|
||||||
|
this.#initializeHost()
|
||||||
|
}
|
||||||
|
|
||||||
|
static get observedAttributes() {
|
||||||
|
const propKeys = this.props
|
||||||
|
? Object.keys(this.props).map((camelCase) => getKebabCase(camelCase))
|
||||||
|
: []
|
||||||
|
|
||||||
|
return propKeys
|
||||||
|
}
|
||||||
|
|
||||||
|
connectedCallback() {
|
||||||
|
this.onInit()
|
||||||
|
this.render()
|
||||||
|
this.afterViewInit()
|
||||||
|
}
|
||||||
|
|
||||||
|
disconnectedCallback() {
|
||||||
|
this.onDestroy()
|
||||||
|
}
|
||||||
|
|
||||||
|
attributeChangedCallback(property, previousValue, currentValue) {
|
||||||
|
const camelCaps = getCamelCase(property)
|
||||||
|
|
||||||
|
if (previousValue !== currentValue) {
|
||||||
|
this[property] = currentValue === '' || currentValue
|
||||||
|
this[camelCaps] = this[property]
|
||||||
|
|
||||||
|
this.#handleUpdateProp(camelCaps, this[property])
|
||||||
|
|
||||||
|
this.render()
|
||||||
|
this.onChanges({ property, previousValue, currentValue })
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
#handleUpdateProp(key, stringifiedValue) {
|
||||||
|
const restored = deserialize(stringifiedValue, this.#typeMap[key])
|
||||||
|
if (restored !== this.props[key]) this.props[key] = restored
|
||||||
|
}
|
||||||
|
|
||||||
|
#handler(setter, meta) {
|
||||||
|
const typeMap = meta.#typeMap
|
||||||
|
|
||||||
|
return {
|
||||||
|
set(obj, prop, value) {
|
||||||
|
const oldValue = obj[prop]
|
||||||
|
|
||||||
|
if (!(prop in typeMap)) {
|
||||||
|
typeMap[prop] = typeof value
|
||||||
|
}
|
||||||
|
|
||||||
|
if (typeMap[prop] !== typeof value) {
|
||||||
|
throw TypeError(
|
||||||
|
`Cannot assign ${typeof value} to ${
|
||||||
|
typeMap[prop]
|
||||||
|
} property (setting '${prop}' of ${meta.constructor.name})`
|
||||||
|
)
|
||||||
|
} else if (oldValue !== value) {
|
||||||
|
obj[prop] = value
|
||||||
|
const kebab = getKebabCase(prop)
|
||||||
|
setter(kebab, serialize(value))
|
||||||
|
}
|
||||||
|
|
||||||
|
return true
|
||||||
|
},
|
||||||
|
get(obj, prop) {
|
||||||
|
return obj[prop]
|
||||||
|
},
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
#initializeProps() {
|
||||||
|
let initialProps = structuredClone(this.constructor.props) ?? {}
|
||||||
|
Object.keys(initialProps).forEach((camelCase) => {
|
||||||
|
const value = initialProps[camelCase]
|
||||||
|
this.#typeMap[camelCase] = typeof value
|
||||||
|
this.setAttribute(getKebabCase(camelCase), serialize(value))
|
||||||
|
})
|
||||||
|
if (!this.#props) {
|
||||||
|
this.#props = new Proxy(
|
||||||
|
initialProps,
|
||||||
|
this.#handler((key, value) => this.setAttribute(key, value), this)
|
||||||
|
)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
#initializeHost() {
|
||||||
|
this.#host = this
|
||||||
|
if (this.constructor.shadowRootInit) {
|
||||||
|
this.#host = this.attachShadow(this.constructor.shadowRootInit)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
render() {
|
||||||
|
if (typeof this.template === 'string') {
|
||||||
|
this.innerHTML = this.template
|
||||||
|
} else if (typeof this.template === 'object') {
|
||||||
|
const tree = this.template
|
||||||
|
|
||||||
|
// TODO: smart diffing
|
||||||
|
if (JSON.stringify(this.#prevDOM) !== JSON.stringify(tree)) {
|
||||||
|
this.#applyStyles()
|
||||||
|
|
||||||
|
/**
|
||||||
|
* create element
|
||||||
|
* - resolve prop values
|
||||||
|
* - attach event listeners
|
||||||
|
*/
|
||||||
|
const el = createElement(tree)
|
||||||
|
|
||||||
|
if (el) {
|
||||||
|
if (Array.isArray(el)) this.#host.replaceChildren(...el)
|
||||||
|
else this.#host.replaceChildren(el)
|
||||||
|
}
|
||||||
|
this.#prevDOM = tree
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
#applyStyles() {
|
||||||
|
if (this.constructor.styles !== undefined)
|
||||||
|
try {
|
||||||
|
const styleObj = new CSSStyleSheet()
|
||||||
|
styleObj.replaceSync(this.constructor.styles)
|
||||||
|
console.log(this.constructor.styles, this.constructor.props)
|
||||||
|
this.#host.adoptedStyleSheets = [
|
||||||
|
...this.#host.adoptedStyleSheets,
|
||||||
|
styleObj,
|
||||||
|
]
|
||||||
|
} catch (e) {
|
||||||
|
console.error(
|
||||||
|
'ERR: Constructable stylesheets are only supported in shadow roots',
|
||||||
|
e
|
||||||
|
)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
|
@ -1,73 +0,0 @@
|
||||||
// @ts-check
|
|
||||||
|
|
||||||
export class WebComponent extends HTMLElement {
|
|
||||||
/**
|
|
||||||
* @type Array<string>
|
|
||||||
*/
|
|
||||||
static properties = [];
|
|
||||||
|
|
||||||
/**
|
|
||||||
* @returns string
|
|
||||||
*/
|
|
||||||
get template() {
|
|
||||||
return "";
|
|
||||||
}
|
|
||||||
|
|
||||||
static get observedAttributes() {
|
|
||||||
return this.properties;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Triggered after view is initialized
|
|
||||||
* @returns void
|
|
||||||
*/
|
|
||||||
afterViewInit() {}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Triggered when the component is connected to the DOM
|
|
||||||
* @returns void
|
|
||||||
*/
|
|
||||||
onInit() {}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Triggered when the component is disconnected from the DOM
|
|
||||||
* @returns void
|
|
||||||
*/
|
|
||||||
onDestroy() {}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* @param {{'property': string, 'previousValue': any, 'currentValue': any}} changes
|
|
||||||
* @returns void
|
|
||||||
*/
|
|
||||||
onChanges(changes) {}
|
|
||||||
|
|
||||||
connectedCallback() {
|
|
||||||
this.onInit();
|
|
||||||
this.render();
|
|
||||||
this.afterViewInit();
|
|
||||||
}
|
|
||||||
|
|
||||||
disconnectedCallback() {
|
|
||||||
this.onDestroy();
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* @param {string} property
|
|
||||||
* @param {any} previousValue
|
|
||||||
* @param {any} currentValue
|
|
||||||
*/
|
|
||||||
attributeChangedCallback(property, previousValue, currentValue) {
|
|
||||||
const camelCaps = (kebab) =>
|
|
||||||
kebab.replace(/-./g, (x) => x[1].toUpperCase());
|
|
||||||
if (previousValue !== currentValue) {
|
|
||||||
this[property] = currentValue;
|
|
||||||
this[camelCaps(property)] = currentValue;
|
|
||||||
this.render();
|
|
||||||
this.onChanges({ property, previousValue, currentValue });
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
render() {
|
|
||||||
this.innerHTML = this.template;
|
|
||||||
}
|
|
||||||
}
|
|
81
src/html.js
Normal file
|
@ -0,0 +1,81 @@
|
||||||
|
const htm =
|
||||||
|
(new Map(),
|
||||||
|
function (n) {
|
||||||
|
for (
|
||||||
|
var e,
|
||||||
|
l,
|
||||||
|
s = arguments,
|
||||||
|
t = 1,
|
||||||
|
u = '',
|
||||||
|
r = '',
|
||||||
|
o = [0],
|
||||||
|
f = function (n) {
|
||||||
|
1 === t && (n || (u = u.replace(/^\s*\n\s*|\s*\n\s*$/g, '')))
|
||||||
|
? o.push(n ? s[n] : u)
|
||||||
|
: 3 === t && (n || u)
|
||||||
|
? ((o[1] = n ? s[n] : u), (t = 2))
|
||||||
|
: 2 === t && '...' === u && n
|
||||||
|
? (o[2] = Object.assign(o[2] || {}, s[n]))
|
||||||
|
: 2 === t && u && !n
|
||||||
|
? ((o[2] = o[2] || {})[u] = !0)
|
||||||
|
: t >= 5 &&
|
||||||
|
(5 === t
|
||||||
|
? (((o[2] = o[2] || {})[l] = n
|
||||||
|
? u
|
||||||
|
? u + s[n]
|
||||||
|
: s[n]
|
||||||
|
: u),
|
||||||
|
(t = 6))
|
||||||
|
: (n || u) && (o[2][l] += n ? u + s[n] : u)),
|
||||||
|
(u = '')
|
||||||
|
},
|
||||||
|
i = 0;
|
||||||
|
i < n.length;
|
||||||
|
i++
|
||||||
|
) {
|
||||||
|
i && (1 === t && f(), f(i))
|
||||||
|
for (var p = 0; p < n[i].length; p++)
|
||||||
|
(e = n[i][p]),
|
||||||
|
1 === t
|
||||||
|
? '<' === e
|
||||||
|
? (f(), (o = [o, '', null]), (t = 3))
|
||||||
|
: (u += e)
|
||||||
|
: 4 === t
|
||||||
|
? '--' === u && '>' === e
|
||||||
|
? ((t = 1), (u = ''))
|
||||||
|
: (u = e + u[0])
|
||||||
|
: r
|
||||||
|
? e === r
|
||||||
|
? (r = '')
|
||||||
|
: (u += e)
|
||||||
|
: '"' === e || "'" === e
|
||||||
|
? (r = e)
|
||||||
|
: '>' === e
|
||||||
|
? (f(), (t = 1))
|
||||||
|
: t &&
|
||||||
|
('=' === e
|
||||||
|
? ((t = 5), (l = u), (u = ''))
|
||||||
|
: '/' === e && (t < 5 || '>' === n[i][p + 1])
|
||||||
|
? (f(),
|
||||||
|
3 === t && (o = o[0]),
|
||||||
|
(t = o),
|
||||||
|
(o = o[0]).push(this.apply(null, t.slice(1))),
|
||||||
|
(t = 0))
|
||||||
|
: ' ' === e || '\t' === e || '\n' === e || '\r' === e
|
||||||
|
? (f(), (t = 2))
|
||||||
|
: (u += e)),
|
||||||
|
3 === t && '!--' === u && ((t = 4), (o = o[0]))
|
||||||
|
}
|
||||||
|
return f(), o.length > 2 ? o.slice(1) : o[1]
|
||||||
|
})
|
||||||
|
|
||||||
|
function h(type, props, ...children) {
|
||||||
|
return { type, props, children }
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* For htm license information please see ./vendors/htm/LICENSE.txt
|
||||||
|
* @license Apache <https://www.apache.org/licenses/LICENSE-2.0>
|
||||||
|
* @author Jason Miller <jason@developit.ca>
|
||||||
|
*/
|
||||||
|
export const html = htm.bind(h)
|
|
@ -1,3 +1,2 @@
|
||||||
// @ts-check
|
export { WebComponent } from './WebComponent.js'
|
||||||
import { WebComponent } from "./WebComponent.mjs";
|
export { html } from './html.js'
|
||||||
export default WebComponent;
|
|
||||||
|
|
46
src/utils/create-element.mjs
Normal file
|
@ -0,0 +1,46 @@
|
||||||
|
import { serialize } from './serialize.mjs'
|
||||||
|
export function createElement(tree) {
|
||||||
|
if (!tree.type) {
|
||||||
|
if (Array.isArray(tree)) {
|
||||||
|
const frag = document.createDocumentFragment()
|
||||||
|
frag.replaceChildren(...tree.map((leaf) => createElement(leaf)))
|
||||||
|
return frag
|
||||||
|
}
|
||||||
|
return document.createTextNode(tree)
|
||||||
|
} else {
|
||||||
|
const el = document.createElement(tree.type)
|
||||||
|
/**
|
||||||
|
* handle props
|
||||||
|
*/
|
||||||
|
if (tree.props) {
|
||||||
|
Object.entries(tree.props).forEach(([prop, value]) => {
|
||||||
|
const domProp = prop.toLowerCase()
|
||||||
|
if (domProp === 'style' && typeof value === 'object' && !!value) {
|
||||||
|
applyStyles(el, value)
|
||||||
|
} else if (prop in el) {
|
||||||
|
el[prop] = value
|
||||||
|
} else if (domProp in el) {
|
||||||
|
el[domProp] = value
|
||||||
|
} else {
|
||||||
|
el.setAttribute(prop, serialize(value))
|
||||||
|
}
|
||||||
|
})
|
||||||
|
}
|
||||||
|
/**
|
||||||
|
* handle children
|
||||||
|
*/
|
||||||
|
tree.children?.forEach((child) => {
|
||||||
|
const childEl = createElement(child)
|
||||||
|
if (childEl instanceof Node) {
|
||||||
|
el.appendChild(childEl)
|
||||||
|
}
|
||||||
|
})
|
||||||
|
return el
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
function applyStyles(el, styleObj) {
|
||||||
|
Object.entries(styleObj).forEach(([rule, value]) => {
|
||||||
|
if (rule in el.style && value) el.style[rule] = value
|
||||||
|
})
|
||||||
|
}
|
11
src/utils/deserialize.mjs
Normal file
|
@ -0,0 +1,11 @@
|
||||||
|
export function deserialize(value, type) {
|
||||||
|
switch (type) {
|
||||||
|
case 'number':
|
||||||
|
case 'boolean':
|
||||||
|
case 'object':
|
||||||
|
case 'undefined':
|
||||||
|
return JSON.parse(value)
|
||||||
|
default:
|
||||||
|
return value
|
||||||
|
}
|
||||||
|
}
|
3
src/utils/get-camel-case.mjs
Normal file
|
@ -0,0 +1,3 @@
|
||||||
|
export function getCamelCase(kebab) {
|
||||||
|
return kebab.replace(/-./g, (x) => x[1].toUpperCase())
|
||||||
|
}
|
6
src/utils/get-kebab-case.mjs
Normal file
|
@ -0,0 +1,6 @@
|
||||||
|
export function getKebabCase(str) {
|
||||||
|
return str.replace(
|
||||||
|
/[A-Z]+(?![a-z])|[A-Z]/g,
|
||||||
|
($, ofs) => (ofs ? '-' : '') + $.toLowerCase()
|
||||||
|
)
|
||||||
|
}
|
5
src/utils/index.js
Normal file
|
@ -0,0 +1,5 @@
|
||||||
|
export { serialize } from './serialize.mjs'
|
||||||
|
export { deserialize } from './deserialize.mjs'
|
||||||
|
export { getCamelCase } from './get-camel-case.mjs'
|
||||||
|
export { getKebabCase } from './get-kebab-case.mjs'
|
||||||
|
export { createElement } from './create-element.mjs'
|
10
src/utils/serialize.mjs
Normal file
|
@ -0,0 +1,10 @@
|
||||||
|
export function serialize(value) {
|
||||||
|
switch (typeof value) {
|
||||||
|
case 'number':
|
||||||
|
case 'boolean':
|
||||||
|
case 'object':
|
||||||
|
return JSON.stringify(value)
|
||||||
|
default:
|
||||||
|
return value
|
||||||
|
}
|
||||||
|
}
|
27
src/utils/serialize.test.mjs
Normal file
|
@ -0,0 +1,27 @@
|
||||||
|
import { describe, expect, test } from 'vitest'
|
||||||
|
import { serialize } from './serialize.mjs'
|
||||||
|
|
||||||
|
describe('serialize', () => {
|
||||||
|
test('should stringify number', () => {
|
||||||
|
const result = serialize(3)
|
||||||
|
expect(result).toBeTypeOf('string')
|
||||||
|
expect(result).toEqual('3')
|
||||||
|
})
|
||||||
|
|
||||||
|
test('should stringify boolean', () => {
|
||||||
|
const result = serialize(false)
|
||||||
|
expect(result).toBeTypeOf('string')
|
||||||
|
expect(result).toEqual('false')
|
||||||
|
})
|
||||||
|
|
||||||
|
test('should stringify object', () => {
|
||||||
|
const result = serialize({ hello: 'world' })
|
||||||
|
expect(result).toBeTypeOf('string')
|
||||||
|
expect(result).toEqual('{"hello":"world"}')
|
||||||
|
})
|
||||||
|
|
||||||
|
test('should return undefined', () => {
|
||||||
|
const result = serialize(undefined)
|
||||||
|
expect(result).toBeUndefined()
|
||||||
|
})
|
||||||
|
})
|
25
test/WebComponent.test.mjs
Normal file
|
@ -0,0 +1,25 @@
|
||||||
|
import { beforeEach, describe, expect, it } from 'vitest'
|
||||||
|
import { WebComponent } from '../src/WebComponent.js'
|
||||||
|
|
||||||
|
let componentUnderTest
|
||||||
|
|
||||||
|
describe('WebComponent', () => {
|
||||||
|
// Browsers throw an error when you instantiate a custom element class not in the registry
|
||||||
|
window.customElements.define('component-test', WebComponent)
|
||||||
|
|
||||||
|
beforeEach(() => {
|
||||||
|
componentUnderTest = new WebComponent()
|
||||||
|
})
|
||||||
|
|
||||||
|
it('is instantiated', () => {
|
||||||
|
expect(componentUnderTest).toBeDefined()
|
||||||
|
})
|
||||||
|
|
||||||
|
it('has a readonly template prop', () => {
|
||||||
|
expect(componentUnderTest.template).toBe('')
|
||||||
|
const assignToReadonly = () => {
|
||||||
|
componentUnderTest.template = 'should error'
|
||||||
|
}
|
||||||
|
expect(() => assignToReadonly()).toThrowError()
|
||||||
|
})
|
||||||
|
})
|
27
test/utils/serialize.test.mjs
Normal file
|
@ -0,0 +1,27 @@
|
||||||
|
import { describe, expect, test } from 'vitest'
|
||||||
|
import { serialize } from '../../src/utils/serialize.mjs'
|
||||||
|
|
||||||
|
describe('serialize', () => {
|
||||||
|
test('should stringify number', () => {
|
||||||
|
const result = serialize(3)
|
||||||
|
expect(result).toBeTypeOf('string')
|
||||||
|
expect(result).toEqual('3')
|
||||||
|
})
|
||||||
|
|
||||||
|
test('should stringify boolean', () => {
|
||||||
|
const result = serialize(false)
|
||||||
|
expect(result).toBeTypeOf('string')
|
||||||
|
expect(result).toEqual('false')
|
||||||
|
})
|
||||||
|
|
||||||
|
test('should stringify object', () => {
|
||||||
|
const result = serialize({ hello: 'world' })
|
||||||
|
expect(result).toBeTypeOf('string')
|
||||||
|
expect(result).toEqual('{"hello":"world"}')
|
||||||
|
})
|
||||||
|
|
||||||
|
test('should return undefined', () => {
|
||||||
|
const result = serialize(undefined)
|
||||||
|
expect(result).toBeUndefined()
|
||||||
|
})
|
||||||
|
})
|
10
tsconfig.json
Normal file
|
@ -0,0 +1,10 @@
|
||||||
|
{
|
||||||
|
"compilerOptions": {
|
||||||
|
"target": "ES2022",
|
||||||
|
"allowJs": true,
|
||||||
|
"outDir": "dist",
|
||||||
|
"declaration": true,
|
||||||
|
"emitDeclarationOnly": true
|
||||||
|
},
|
||||||
|
"include": ["src/*", "src/utils/*"]
|
||||||
|
}
|
204
vendors/htm/LICENSE.txt
vendored
Normal file
|
@ -0,0 +1,204 @@
|
||||||
|
This license applies to parts of the `html` function originating from https://github.com/developit/htm project:
|
||||||
|
|
||||||
|
|
||||||
|
Apache License
|
||||||
|
Version 2.0, January 2004
|
||||||
|
http://www.apache.org/licenses/
|
||||||
|
|
||||||
|
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
||||||
|
|
||||||
|
1. Definitions.
|
||||||
|
|
||||||
|
"License" shall mean the terms and conditions for use, reproduction,
|
||||||
|
and distribution as defined by Sections 1 through 9 of this document.
|
||||||
|
|
||||||
|
"Licensor" shall mean the copyright owner or entity authorized by
|
||||||
|
the copyright owner that is granting the License.
|
||||||
|
|
||||||
|
"Legal Entity" shall mean the union of the acting entity and all
|
||||||
|
other entities that control, are controlled by, or are under common
|
||||||
|
control with that entity. For the purposes of this definition,
|
||||||
|
"control" means (i) the power, direct or indirect, to cause the
|
||||||
|
direction or management of such entity, whether by contract or
|
||||||
|
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
||||||
|
outstanding shares, or (iii) beneficial ownership of such entity.
|
||||||
|
|
||||||
|
"You" (or "Your") shall mean an individual or Legal Entity
|
||||||
|
exercising permissions granted by this License.
|
||||||
|
|
||||||
|
"Source" form shall mean the preferred form for making modifications,
|
||||||
|
including but not limited to software source code, documentation
|
||||||
|
source, and configuration files.
|
||||||
|
|
||||||
|
"Object" form shall mean any form resulting from mechanical
|
||||||
|
transformation or translation of a Source form, including but
|
||||||
|
not limited to compiled object code, generated documentation,
|
||||||
|
and conversions to other media types.
|
||||||
|
|
||||||
|
"Work" shall mean the work of authorship, whether in Source or
|
||||||
|
Object form, made available under the License, as indicated by a
|
||||||
|
copyright notice that is included in or attached to the work
|
||||||
|
(an example is provided in the Appendix below).
|
||||||
|
|
||||||
|
"Derivative Works" shall mean any work, whether in Source or Object
|
||||||
|
form, that is based on (or derived from) the Work and for which the
|
||||||
|
editorial revisions, annotations, elaborations, or other modifications
|
||||||
|
represent, as a whole, an original work of authorship. For the purposes
|
||||||
|
of this License, Derivative Works shall not include works that remain
|
||||||
|
separable from, or merely link (or bind by name) to the interfaces of,
|
||||||
|
the Work and Derivative Works thereof.
|
||||||
|
|
||||||
|
"Contribution" shall mean any work of authorship, including
|
||||||
|
the original version of the Work and any modifications or additions
|
||||||
|
to that Work or Derivative Works thereof, that is intentionally
|
||||||
|
submitted to Licensor for inclusion in the Work by the copyright owner
|
||||||
|
or by an individual or Legal Entity authorized to submit on behalf of
|
||||||
|
the copyright owner. For the purposes of this definition, "submitted"
|
||||||
|
means any form of electronic, verbal, or written communication sent
|
||||||
|
to the Licensor or its representatives, including but not limited to
|
||||||
|
communication on electronic mailing lists, source code control systems,
|
||||||
|
and issue tracking systems that are managed by, or on behalf of, the
|
||||||
|
Licensor for the purpose of discussing and improving the Work, but
|
||||||
|
excluding communication that is conspicuously marked or otherwise
|
||||||
|
designated in writing by the copyright owner as "Not a Contribution."
|
||||||
|
|
||||||
|
"Contributor" shall mean Licensor and any individual or Legal Entity
|
||||||
|
on behalf of whom a Contribution has been received by Licensor and
|
||||||
|
subsequently incorporated within the Work.
|
||||||
|
|
||||||
|
2. Grant of Copyright License. Subject to the terms and conditions of
|
||||||
|
this License, each Contributor hereby grants to You a perpetual,
|
||||||
|
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||||
|
copyright license to reproduce, prepare Derivative Works of,
|
||||||
|
publicly display, publicly perform, sublicense, and distribute the
|
||||||
|
Work and such Derivative Works in Source or Object form.
|
||||||
|
|
||||||
|
3. Grant of Patent License. Subject to the terms and conditions of
|
||||||
|
this License, each Contributor hereby grants to You a perpetual,
|
||||||
|
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||||
|
(except as stated in this section) patent license to make, have made,
|
||||||
|
use, offer to sell, sell, import, and otherwise transfer the Work,
|
||||||
|
where such license applies only to those patent claims licensable
|
||||||
|
by such Contributor that are necessarily infringed by their
|
||||||
|
Contribution(s) alone or by combination of their Contribution(s)
|
||||||
|
with the Work to which such Contribution(s) was submitted. If You
|
||||||
|
institute patent litigation against any entity (including a
|
||||||
|
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
||||||
|
or a Contribution incorporated within the Work constitutes direct
|
||||||
|
or contributory patent infringement, then any patent licenses
|
||||||
|
granted to You under this License for that Work shall terminate
|
||||||
|
as of the date such litigation is filed.
|
||||||
|
|
||||||
|
4. Redistribution. You may reproduce and distribute copies of the
|
||||||
|
Work or Derivative Works thereof in any medium, with or without
|
||||||
|
modifications, and in Source or Object form, provided that You
|
||||||
|
meet the following conditions:
|
||||||
|
|
||||||
|
(a) You must give any other recipients of the Work or
|
||||||
|
Derivative Works a copy of this License; and
|
||||||
|
|
||||||
|
(b) You must cause any modified files to carry prominent notices
|
||||||
|
stating that You changed the files; and
|
||||||
|
|
||||||
|
(c) You must retain, in the Source form of any Derivative Works
|
||||||
|
that You distribute, all copyright, patent, trademark, and
|
||||||
|
attribution notices from the Source form of the Work,
|
||||||
|
excluding those notices that do not pertain to any part of
|
||||||
|
the Derivative Works; and
|
||||||
|
|
||||||
|
(d) If the Work includes a "NOTICE" text file as part of its
|
||||||
|
distribution, then any Derivative Works that You distribute must
|
||||||
|
include a readable copy of the attribution notices contained
|
||||||
|
within such NOTICE file, excluding those notices that do not
|
||||||
|
pertain to any part of the Derivative Works, in at least one
|
||||||
|
of the following places: within a NOTICE text file distributed
|
||||||
|
as part of the Derivative Works; within the Source form or
|
||||||
|
documentation, if provided along with the Derivative Works; or,
|
||||||
|
within a display generated by the Derivative Works, if and
|
||||||
|
wherever such third-party notices normally appear. The contents
|
||||||
|
of the NOTICE file are for informational purposes only and
|
||||||
|
do not modify the License. You may add Your own attribution
|
||||||
|
notices within Derivative Works that You distribute, alongside
|
||||||
|
or as an addendum to the NOTICE text from the Work, provided
|
||||||
|
that such additional attribution notices cannot be construed
|
||||||
|
as modifying the License.
|
||||||
|
|
||||||
|
You may add Your own copyright statement to Your modifications and
|
||||||
|
may provide additional or different license terms and conditions
|
||||||
|
for use, reproduction, or distribution of Your modifications, or
|
||||||
|
for any such Derivative Works as a whole, provided Your use,
|
||||||
|
reproduction, and distribution of the Work otherwise complies with
|
||||||
|
the conditions stated in this License.
|
||||||
|
|
||||||
|
5. Submission of Contributions. Unless You explicitly state otherwise,
|
||||||
|
any Contribution intentionally submitted for inclusion in the Work
|
||||||
|
by You to the Licensor shall be under the terms and conditions of
|
||||||
|
this License, without any additional terms or conditions.
|
||||||
|
Notwithstanding the above, nothing herein shall supersede or modify
|
||||||
|
the terms of any separate license agreement you may have executed
|
||||||
|
with Licensor regarding such Contributions.
|
||||||
|
|
||||||
|
6. Trademarks. This License does not grant permission to use the trade
|
||||||
|
names, trademarks, service marks, or product names of the Licensor,
|
||||||
|
except as required for reasonable and customary use in describing the
|
||||||
|
origin of the Work and reproducing the content of the NOTICE file.
|
||||||
|
|
||||||
|
7. Disclaimer of Warranty. Unless required by applicable law or
|
||||||
|
agreed to in writing, Licensor provides the Work (and each
|
||||||
|
Contributor provides its Contributions) on an "AS IS" BASIS,
|
||||||
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
||||||
|
implied, including, without limitation, any warranties or conditions
|
||||||
|
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
||||||
|
PARTICULAR PURPOSE. You are solely responsible for determining the
|
||||||
|
appropriateness of using or redistributing the Work and assume any
|
||||||
|
risks associated with Your exercise of permissions under this License.
|
||||||
|
|
||||||
|
8. Limitation of Liability. In no event and under no legal theory,
|
||||||
|
whether in tort (including negligence), contract, or otherwise,
|
||||||
|
unless required by applicable law (such as deliberate and grossly
|
||||||
|
negligent acts) or agreed to in writing, shall any Contributor be
|
||||||
|
liable to You for damages, including any direct, indirect, special,
|
||||||
|
incidental, or consequential damages of any character arising as a
|
||||||
|
result of this License or out of the use or inability to use the
|
||||||
|
Work (including but not limited to damages for loss of goodwill,
|
||||||
|
work stoppage, computer failure or malfunction, or any and all
|
||||||
|
other commercial damages or losses), even if such Contributor
|
||||||
|
has been advised of the possibility of such damages.
|
||||||
|
|
||||||
|
9. Accepting Warranty or Additional Liability. While redistributing
|
||||||
|
the Work or Derivative Works thereof, You may choose to offer,
|
||||||
|
and charge a fee for, acceptance of support, warranty, indemnity,
|
||||||
|
or other liability obligations and/or rights consistent with this
|
||||||
|
License. However, in accepting such obligations, You may act only
|
||||||
|
on Your own behalf and on Your sole responsibility, not on behalf
|
||||||
|
of any other Contributor, and only if You agree to indemnify,
|
||||||
|
defend, and hold each Contributor harmless for any liability
|
||||||
|
incurred by, or claims asserted against, such Contributor by reason
|
||||||
|
of your accepting any such warranty or additional liability.
|
||||||
|
|
||||||
|
END OF TERMS AND CONDITIONS
|
||||||
|
|
||||||
|
APPENDIX: How to apply the Apache License to your work.
|
||||||
|
|
||||||
|
To apply the Apache License to your work, attach the following
|
||||||
|
boilerplate notice, with the fields enclosed by brackets "[]"
|
||||||
|
replaced with your own identifying information. (Don't include
|
||||||
|
the brackets!) The text should be enclosed in the appropriate
|
||||||
|
comment syntax for the file format. We also recommend that a
|
||||||
|
file or class name and description of purpose be included on the
|
||||||
|
same "printed page" as the copyright notice for easier
|
||||||
|
identification within third-party archives.
|
||||||
|
|
||||||
|
Copyright 2018 Google Inc.
|
||||||
|
|
||||||
|
Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
|
you may not use this file except in compliance with the License.
|
||||||
|
You may obtain a copy of the License at
|
||||||
|
|
||||||
|
http://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
|
||||||
|
Unless required by applicable law or agreed to in writing, software
|
||||||
|
distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
|
See the License for the specific language governing permissions and
|
||||||
|
limitations under the License.
|
13
vitest.config.mjs
Normal file
|
@ -0,0 +1,13 @@
|
||||||
|
import { defineConfig } from 'vitest/config'
|
||||||
|
|
||||||
|
export default defineConfig({
|
||||||
|
test: {
|
||||||
|
environment: 'happy-dom',
|
||||||
|
coverage: {
|
||||||
|
enabled: true,
|
||||||
|
provider: 'v8',
|
||||||
|
reporter: ['html', 'text'],
|
||||||
|
include: ['src'],
|
||||||
|
},
|
||||||
|
},
|
||||||
|
})
|