Compare commits

...

434 commits
v1.2.2 ... main

Author SHA1 Message Date
Ayo
ceda1c0efd chore: update deps 2025-06-25 14:24:05 +02:00
68caacda23 chore: add back sr.ht build script 2025-06-09 22:01:10 +02:00
ayo
c0b3350bd2
chore: housekeeping (#55)
* chore: remove lit & fast reference in readme

* chore: remove sourcehut build automation

* chore(docs): various changes

* chore: update attribution
2025-06-07 23:35:36 +02:00
ayo
9abf7fcc6b
chore: housekeeping (#54)
* chore: remove lit & fast reference in readme

* chore: remove sourcehut build automation

* chore(docs): various changes
2025-05-30 01:24:39 +02:00
f18acf0210 chore: update readme 2025-05-29 23:08:47 +02:00
bd01d8741f chore: update links on readme 2025-05-29 23:05:01 +02:00
58e9d14b79 docs: mention option to start a gh discussion 2025-04-21 22:36:09 +02:00
21e49895cf chore: update build id 2025-04-20 20:12:12 +02:00
82c2dea893 Merge branch 'main' of git.sr.ht:~ayoayco/wcb 2025-04-20 20:08:00 +02:00
b6104ad1a1 feat(docs): clarify & emphasize alternative options 2025-04-07 15:26:34 +01:00
69c2e990d6 Merge branch 'main' of git.sr.ht:~ayoayco/wcb 2025-03-31 23:41:21 +02:00
6f11f6fe85 feat(docs): ultimate marketing energy 2025-03-30 21:09:45 +02:00
e0e3151727 feat(docs): update marketing stuff 2025-03-30 21:08:35 +02:00
f98119162f feat(docs): marketing stuff 2025-03-30 21:07:14 +02:00
64113c242c feat(docs): add discord social; update icons 2025-03-30 20:18:39 +02:00
fdcb837382 chore: remove unnecessary installation of docs deps before build 2025-03-30 20:08:27 +02:00
5aa5ee44fa chore: remove old size increase explanation in readme 2025-03-30 20:04:13 +02:00
fca8f06803 4.1.1 2025-03-30 12:47:26 +02:00
20c716d78d feat: show error when has styles & not using shadow roots 2025-03-30 12:46:43 +02:00
114ce87a41 chore: remove story on readme 2025-03-30 12:29:15 +02:00
0c7cc10750 feat(docs): show shadow-dom before styling guide 2025-03-30 12:27:48 +02:00
c8c8eb90f3 feat(docs): add codepen for constructable stylesheets 2025-03-30 12:17:24 +02:00
8d46650c27 4.1.0 2025-03-30 12:15:28 +02:00
ea4cca1958 feat(docs): add guide for shadow dom & constructable stylesheets 2025-03-30 12:14:56 +02:00
822c4d3984 feat: support constructable stylesheets 2025-03-30 12:00:45 +02:00
fdc3b428e5 feat(docs): update ways to request regarding distribution 2025-03-29 21:02:52 +01:00
2a11ac1d77 feat(docs): show github link 2025-03-29 10:48:35 +01:00
822fdf95a3 feat(docs): mention FAST & Lit 2025-03-29 08:56:20 +01:00
422b7a2e06 feat(docs): use note Aside on prop access guide 2025-03-27 20:40:39 +01:00
4c8be71875 feat(docs): indicate tip for using lit-html 2025-03-27 16:28:00 +01:00
e80b157d9d feat(docs): reduce "just" 2025-03-27 13:34:36 +01:00
73a4c18f45 feat(docs): fix links 2025-03-27 13:27:49 +01:00
d9bcb019bc feat(docs): clarify observed property changes result to render 2025-03-27 12:41:01 +01:00
a96d161e02 feat(docs): component -> custom element 2025-03-27 09:46:44 +01:00
36a77bf477 feat(docs): indicate "stable alpha" status 2025-03-27 09:40:03 +01:00
7194eac159 feat(docs): update & make getting started as first page 2025-03-27 09:29:35 +01:00
9651de9cf4 feat(docs): add footer attribution 2025-03-26 23:04:43 +01:00
30483becc5 chore: set correct netlify ID 2025-03-26 22:50:33 +01:00
19240d79c7 chore(docs): set up auto build & deploy 2025-03-26 22:46:29 +01:00
b5bd559e35 feat(docs): create pages for significant readme section 2025-03-26 22:43:07 +01:00
7800df29da chore: remove mcfly deps 2025-03-26 22:10:31 +01:00
379addc4be feat(docs): add why page 2025-03-26 21:40:38 +01:00
519573916c feat: replace mcfly site with starlight docs 2025-03-26 21:10:27 +01:00
3358e7c805 feat(docs): set up first guide page 2025-03-26 19:50:07 +01:00
77b53dbbda feat(docs): set up new docs site 2025-03-26 19:49:46 +01:00
a2945c3880 4.0.1 2025-03-23 11:56:09 +01:00
facf11d294 chore: add build step in precommit 2025-03-23 11:55:02 +01:00
908591b6b7 chore: remove old size increase explanation in readme 2025-03-23 11:54:37 +01:00
3e896ada83 chore: add size-limit to precommit checks 2025-03-22 12:01:19 +01:00
6d05547ed5 chore: ignore dist/* on eslint config 2025-03-22 11:38:24 +01:00
6cd461ae4e chore: set tsc target to ES2022 2025-03-22 11:38:03 +01:00
583ff6e35a 4.0.0 2025-03-22 11:21:35 +01:00
ca0de74f6a chore: add pub:major script 2025-03-22 11:21:23 +01:00
8a63ed56f5 feat: remove support for static properties
- focus usage on static props Blueprint for Proxy
2025-03-22 11:20:32 +01:00
ab8156a2b0 chore: run test on pre-commit 2025-03-22 11:01:14 +01:00
d5606cdd44 chore: separate test:watch script 2025-03-22 11:00:35 +01:00
a35e1901f0 test: organize test files 2025-03-22 10:14:35 +01:00
3056e84d4c test: set up vitest & add tests 2025-03-22 10:11:48 +01:00
35b8b5539b chore: bump version for release; add eslint/js dep 2025-03-21 23:07:48 +01:00
77a2c63c19 feat: remove proxy get handler for type restoration 2025-03-21 22:09:46 +01:00
b1cfdb4a9f feat(site): add onInit hook example 2025-03-09 01:05:35 +01:00
6e30abbaa0 chore: add simple-server devdep 2025-03-09 00:49:01 +01:00
7dda6c86d0 chore: remove github stuff 2025-03-09 00:42:08 +01:00
3e697027f3 Release 3.0.0 2025-03-09 00:40:52 +01:00
e125586487 chore: update deps 2025-03-09 00:36:20 +01:00
9ead44babe feat: remove attach-effect 2025-03-09 00:34:10 +01:00
d41affd709 chore: add npm dev script 2025-03-09 00:25:05 +01:00
a281017d63 chore: add inspiration & thanks in readme 2025-03-09 00:17:07 +01:00
ddf9b6d360 chore: update sh note on readme 2025-02-08 20:31:25 +01:00
2043893b6a chore: update sh note on readme 2025-02-08 20:28:58 +01:00
9058ee63e5 chore: add links to sourcehut on the readme 2025-02-08 20:17:56 +01:00
d7ec75386d chore: add links to readme 2025-02-08 20:03:30 +01:00
76320df77c chore: add gh PR template pointing to SourceHut 2025-02-08 19:52:25 +01:00
1d46484ca7 chore: add push-mirror step 2025-02-08 19:36:29 +01:00
a9a190c574 feat(site): update footer link from gh to sh 2025-01-10 15:48:59 +01:00
eb235ed96a chore: update deps 2025-01-10 10:22:49 +01:00
510db20ab2 feat(site): fix call to action 2025-01-09 23:08:39 +01:00
87eeed06f1 chore: show correct image 2025-01-09 23:08:22 +01:00
c6d9792ad2 chore(site): add nitro preset netlify 2025-01-09 23:04:41 +01:00
7c2c4473d1 chore: add dev dep netlify-cli 2025-01-09 23:03:00 +01:00
37fdbbc187 chore: add netlify.toml 2025-01-09 23:01:39 +01:00
6cee66e26d chore: add build.yml 2025-01-09 23:00:30 +01:00
0cfeb51554 feat(site): update mcfly 2025-01-09 22:59:27 +01:00
f08391d13f chore: gitignore eslint cache 2024-12-27 16:18:57 +01:00
2a24028043 chore: cache precommit lint results 2024-12-27 16:17:43 +01:00
d10a164998 chore: add eslint-plugin-jsdoc 2024-12-27 15:45:07 +01:00
ee0df6a7b0 chore: update deps to latest 2024-12-27 15:16:48 +01:00
b0738b0c37 chore(site): update mcfly & nitro 2024-12-27 15:16:00 +01:00
c69cee4a36 chore: update precommit script 2024-12-27 11:11:00 +01:00
da6c563eee chore: set up prettier ignore 2024-12-27 11:10:32 +01:00
e7b2a23cf4 fix(site): server error caused by missing semicolon 2024-12-20 00:18:17 +01:00
1610683a70 chore: use vitest run on ci 2024-12-19 23:29:09 +01:00
f4102f17f3 chore: remove upload report on test gh action 2024-12-19 23:28:46 +01:00
ea95bf47b8 chore: use npm i for test gh action 2024-12-19 23:27:39 +01:00
fbf311ba4f chore: use pnpm on gh action 2024-12-19 23:24:51 +01:00
f3e4d28719 chore: add test action 2024-12-19 23:23:57 +01:00
a254cdc669 chore: remove format on gh action 2024-12-19 23:21:24 +01:00
a78c67fa2f chore: use .mjs config files 2024-12-19 23:16:57 +01:00
833e835f65 chore: format code 2024-12-19 22:43:12 +01:00
ae2df5096d chore: remove format in pre-commit hook 2024-12-19 22:42:28 +01:00
7fcbbfb28d chore: set up prettier 2024-12-19 22:41:46 +01:00
5020713fa7 chore: remove eslint no-undef override 2024-12-19 22:19:30 +01:00
8c46683527 chore: format code 2024-12-19 22:18:52 +01:00
3ab877e869 chore: setup eslint 2024-12-19 22:18:41 +01:00
4f6f441b3b test: add vitest & initial tests 2024-11-10 21:31:48 +01:00
6f0ad3e1d5 chore: update deps 2024-11-10 21:05:38 +01:00
a18cf3ca22
chore: fix section link README.md (#51) 2024-09-29 20:30:47 +02:00
aa59785806 feat: update all examples to use latest features 2024-09-03 00:52:38 +02:00
eb115d25ea
chore: add new post-apocalyptic demo (#50) 2024-08-24 01:40:57 +02:00
1443b15b4d
chore: patch version (#49)
* 2.1.1

* chore: update  readme instructions on using CDNs

* 2.1.2
2024-07-27 22:41:01 +02:00
87c1c9faca
chore: update instructions on using CDNs (#48)
* 2.1.1

* chore: update  readme instructions on using CDNs
2024-07-27 22:38:29 +02:00
4445d04208
chore: update gh action for eslint (#47)
* chore: update dev deps

* chore: pnpm update dev deps

* chore: update deps; initial migrate to eslint flat config

* chore: remove 'beta' from readme

* 2.1.0

* chore: update gh action for eslint
2024-07-27 22:16:53 +02:00
8723290d90
chore: udpate dev deps; initial migration to eslint flat config (#46)
* chore: update dev deps

* chore: pnpm update dev deps

* chore: update deps; initial migrate to eslint flat config

* chore: remove 'beta' from readme

* 2.1.0
2024-07-27 22:09:06 +02:00
d15746a91a
chore: remove memoization as needed improvement
Will focus now on smart diffing
2024-07-03 21:37:09 +02:00
37ff3f9cf2 feat: update McFly link 2024-06-11 16:09:47 +02:00
Ayo Ayco
88299332aa
chore: update README.md (#45) 2024-05-21 11:12:03 +02:00
Ayo
da83077ec8 chore: pin nitropack to 2.8 2024-03-11 13:17:38 +01:00
Ayo
ce157f9f63 chore: migrate to pnpm; set size limits 2024-03-09 21:07:06 +01:00
Ayo
0c5d4ef15f chore(readme): link to custom-elements MDN page 2024-01-15 11:29:21 +01:00
Ayo
29dc82b0c3 feat(site): update example of imperative way 2024-01-13 23:23:51 +01:00
Ayo
5e50df8613 feat(site): update why section 2024-01-13 23:15:03 +01:00
Ayo
162b468d8d feat(site): update attribution 2023-12-28 12:16:17 +01:00
Ayo
1c2ad3b5e0 feat(site): update attribution footer 2023-12-28 11:45:41 +01:00
Ayo Ayco
e3d6b2783c
feat(site): zero js scenario (#44) 2023-12-28 11:26:16 +01:00
Ayo
96b4c9f76b chore: remove gif on readme 2023-12-28 11:04:56 +01:00
Ayo
d1a5462f4a chore: add list of feature-specific demos 2023-12-28 10:58:44 +01:00
Ayo
82cf06df62 chore: reorder sections
- move examples next to usage
2023-12-27 22:15:17 +01:00
Ayo
41b4a32673 chore: add todo-app example on readme 2023-12-27 22:11:59 +01:00
Ayo
9d8ff3b453 chore: disable continue on error 2023-12-27 13:56:08 +01:00
Ayo
af1ef22042 Merge branch 'main' of github.com:ayoayco/web-component-base 2023-12-27 13:47:38 +01:00
Ayo
4ab63c4da0 chore: update eslint.yml 2023-12-27 13:47:08 +01:00
Ayo Ayco
a2c34bdc81
chore: add eslint.yml for gh actions (#42) 2023-12-27 13:45:30 +01:00
Ayo
d42fbc0e40 chore: mention shadow dom usage on readme 2023-12-27 12:52:01 +01:00
Ayo
2f46ad3c67 chore: remove closed issue on readme 2023-12-27 00:24:54 +01:00
Ayo Ayco
e78030ab13
feat: use shadow dom host (#41) 2023-12-27 00:13:21 +01:00
Ayo Ayco
29fa864ca2
feat: use shadow mode (#39) 2023-12-26 23:48:54 +01:00
Ayo
d4dcea4503 chore: mention shadow dom opt-in plan on readme 2023-12-26 11:30:41 +01:00
Ayo
4cdaddf858 chore: housekeeping
- remove pretty on husky pre-commit
- vscode formatOnSave
2023-12-24 14:59:13 +01:00
Ayo Ayco
879032aa1e
chore: set up eslint & husky (#38) 2023-12-23 22:40:45 +01:00
Ayo
deda46ed9c chore: update site deps 2023-12-22 05:04:46 +01:00
Ayo Ayco
83f30ae2c4
feat: add lit-html usage example (#35) 2023-12-21 12:59:25 +01:00
9c41f2e29a
chore: update README.md 2023-12-20 07:41:24 +01:00
264a5cf0cf
chore: update README.md 2023-12-20 07:40:18 +01:00
Ayo
5bd5164c44 chore: fix link to styling beta 2023-12-19 17:21:07 +01:00
Ayo
4222257633 chore: mention styling is on beta 2023-12-19 17:20:15 +01:00
Ayo Ayco
64fd600435
chore: publish dist from root dir (#32) 2023-12-18 23:12:18 +01:00
Ayo
43b526a870 chore: bump 2.1.0-beta 2023-12-18 17:01:32 +01:00
Ayo Ayco
aee0ec74aa
feat: scoped styles (#31) 2023-12-18 16:57:36 +01:00
Ayo Ayco
9eae4e5b8a
chore: update link to library size section 2023-12-18 08:48:31 +01:00
Ayo
0c9df45ecc feat(site): update tiny feature description 2023-12-16 11:04:22 +01:00
Ayo
3b1df66734 style(site): feature-set box shadows 2023-12-16 11:03:13 +01:00
Ayo
6ce0db7e71 feat(site): rollback to simple proj description 2023-12-16 10:46:01 +01:00
Ayo
aa7d5a645b feat(site): add "tiny" feature 2023-12-16 10:42:28 +01:00
Ayo
03a72b111c feat(site): marketing stuff 2023-12-16 10:36:23 +01:00
Ayo
006fd4ba73 style(site): spacing 2023-12-16 10:29:30 +01:00
Ayo
2a60e95a3d feat(site): update content 2023-12-16 10:27:57 +01:00
Ayo
c606857f4d feat(site): initial feature-set component 2023-12-16 10:26:25 +01:00
Ayo
8b074a3495 chore: update pkg scripts 2023-12-16 09:05:35 +01:00
Ayo
f984e6f595 2.0.6 2023-12-16 09:04:14 +01:00
Ayo
99eb2e0e26 2.0.5 2023-12-16 09:03:07 +01:00
Ayo
9268676797 fix: static props makes state shared across class instances
- uses structuredClone on static props
- closes #28
2023-12-16 09:03:01 +01:00
Ayo
c4a5d7d6e6 2.0.4 2023-12-14 12:21:29 +01:00
Ayo
df99804bab 2.0.3 2023-12-14 12:07:08 +01:00
Ayo
21bc13f40f chore: update readme 2023-12-13 22:00:55 +01:00
Ayo
d1b76de35a chore: update readme 2023-12-13 20:01:00 +01:00
Ayo
f0b4f8a0a7 chore: update readme 2023-12-13 19:59:17 +01:00
Ayo
b4addc511d chore: update readme 2023-12-13 19:57:34 +01:00
Ayo
1b0072a45d chore: update readme 2023-12-13 19:53:47 +01:00
Ayo
47ee0ef2a9 chore: add sections to readme; update site content
- add Project Status section
- add exports section
- update features list on site and readme
2023-12-13 19:50:09 +01:00
Ayo
7cc1026ccb feat(site): update features list with lit-html usage 2023-12-13 15:47:19 +01:00
Ayo Ayco
1879c36350
feat(site): show example of custom template w/ lit-html (#26) 2023-12-13 15:32:17 +01:00
Ayo Ayco
6379334335
chore: mention lit-html usage on readme (#25) 2023-12-13 15:23:13 +01:00
Ayo
f82aed7f26 chore: test branch protection rule 2023-12-12 22:16:29 +01:00
Ayo
fae9ed2cd3 chore: test branch protection rule 🤣 2023-12-12 22:14:43 +01:00
Ayo
ad467ded5e chore: test branch protection rule 2023-12-12 22:13:52 +01:00
Ayo
63c1ee6b24 2.0.2 2023-12-12 22:11:08 +01:00
Ayo Ayco
5720901d25
chore: update license info (#21) 2023-12-12 22:06:12 +01:00
Ayo
ce1733c7ca chore: update readme
to test branch protection rules on GH
2023-12-12 21:26:50 +01:00
Ayo Ayco
2a562a3b39
feat: update meta & document title (#20) 2023-12-12 21:21:43 +01:00
Ayo Ayco
d290fc90a0
refactor: use static props in all examples (#19) 2023-12-12 21:17:57 +01:00
Ayo
8aabf89208 feat(site): update meta description 2023-12-12 20:39:48 +01:00
Ayo
45180dc681 chore: add fine-grained usage on readme 2023-12-12 12:30:24 +01:00
Ayo
dcb9222bf9 refactor(site): remove unused components; update counter 2023-12-12 11:56:53 +01:00
Ayo
a35f5a086e Merge branch 'main' of github.com:ayoayco/web-component-base 2023-12-12 08:36:44 +01:00
Ayo
a0f62d65d4 feat(site): update project description 2023-12-12 08:36:33 +01:00
42f8b75781
chore: Update README.md screenshot 2023-12-11 23:43:01 +01:00
fa249b53d4
chore: add sample code pix 2023-12-11 23:40:43 +01:00
Ayo
5cc52e66f4 feat(site): update why section 2023-12-11 20:20:40 +01:00
Ayo
48bf30ea7b feat(site): update why section 2023-12-11 20:07:38 +01:00
Ayo
dc829269a6 feat(site): update why section 2023-12-11 19:28:02 +01:00
Ayo
041aed195e feat(site): update counter component & why section 2023-12-11 19:22:43 +01:00
Ayo
79ce197c8a fix(site): first letter line-height on firefox 2023-12-11 17:01:13 +01:00
Ayo
01c9a4f170 feat(site): remove mcfly in features list 2023-12-11 16:55:50 +01:00
Ayo Ayco
06d41cd78b
chore: update README.md 2023-12-10 22:37:44 +01:00
Ayo
8418287e1d chore: update package description 2023-12-10 21:11:15 +01:00
Ayo
a6c292ff68 chore: update library size report in readme 2023-12-10 21:08:41 +01:00
Ayo
6d52a3bea0 chore: fix typos in readme 2023-12-10 20:27:48 +01:00
Ayo
5eafd01827 fix(site): typo in link to preact htm/mini 2023-12-10 20:19:17 +01:00
Ayo
4c885ccf9d chore: update site, readme, & examples for v2.0 features 2023-12-10 20:17:46 +01:00
Ayo Ayco
4d4fdb3d89
chore: set up bundling; bump for major release (#16)
* chore: format code with prettier

* chore: use eslint; bump to major
2023-12-10 18:24:27 +01:00
Ayo Ayco
488743e011
chore: format code with prettier (#14) 2023-12-10 10:58:46 +01:00
Ayo
6eb93b5dd3 feat: update counter example 2023-12-09 22:52:17 +01:00
Ayo
ec50f0f86e refactor(templating): attributes handling & JSX
- support unparented DOM nodes
- simpler attributes handling
- jsx-like syntax
- use .mjs for utils
2023-12-09 22:35:58 +01:00
Ayo
538aa01ecd feat(templating): support adding aria- attributes 2023-12-09 09:54:35 +01:00
Ayo
669fee1d49 feat(templating): only assign standard DOM props 2023-12-09 02:05:32 +01:00
Ayo
6844ffe9f2 feat(templating): support more standard attrs
- data- <-> dataset.
- for <-> htmlFor
- class <-> className
2023-12-09 01:57:13 +01:00
Ayo
27a5fb3024 feat(templating): support for non on-event props
- use class or className
- only on-event props are tolowercase'd
2023-12-09 00:48:56 +01:00
Ayo
b4f3b98ee4 feat: use standard event prop behavior
- call .toLowerCase() on attribute props
2023-12-09 00:15:39 +01:00
Ayo
7bf37d75db feat: use standard event handler props 2023-12-09 00:11:32 +01:00
Ayo
956424cbaf chore: bump version for release 2023-12-08 23:36:20 +01:00
Ayo
26129a5934 feat: helpful TypeError message 2023-12-08 23:36:01 +01:00
Ayo
07bb2d850a feat: simpler TypeError; use proxy default err 2023-12-08 23:14:03 +01:00
Ayo
75f914606f feat: example of type mismatch 2023-12-08 22:40:27 +01:00
Ayo
bea93f69f7 feat: improve error report for type mismatch 2023-12-08 22:40:03 +01:00
Ayo
98c89624f9 feat: throw TypeError when setting different type 2023-12-08 22:34:25 +01:00
Ayo
7500f0c3fe chore: bump version for release 2023-12-08 22:13:51 +01:00
Ayo
85284e9e42 fix: wrong previous dom used in diffing 2023-12-08 22:13:34 +01:00
Ayo Ayco
3c1b3b0893
feat: templating (#9) 2023-12-08 21:31:05 +01:00
Ayo Ayco
00648883fa
feat: props blueprint (#8) 2023-12-08 18:00:40 +01:00
Ayo
000e3811cd feat(site): update code example import 2023-12-08 15:35:42 +01:00
Ayo
2ac38747cb feat(site): show console on code pen for beta 2023-12-08 15:22:51 +01:00
Ayo
f56068e76e chore: export all utils 2023-12-08 15:05:27 +01:00
Ayo
b613d8e77c refactor: use index exports 2023-12-08 14:45:12 +01:00
Ayo Ayco
703ef9e45d
feat: initial utils distribution (#7) 2023-12-08 13:15:00 +01:00
Ayo
1ae5fa7535 chore: update readme; props can now hold object 2023-12-07 18:31:57 +01:00
Ayo
84c4a00fb8 feat: update example for object props 2023-12-07 18:05:51 +01:00
Ayo
d7651b5f33 feat: support objects in props 2023-12-07 17:30:53 +01:00
Ayo Ayco
d6755dd9e3
chore: update readme "note" 2023-12-04 15:52:02 +01:00
Ayo
d3dc78e75c chore: organize examples 2023-12-02 17:00:41 +01:00
Ayo
91356bde9f chore: fix typo on readme 2023-12-02 09:53:02 +01:00
Ayo
b5b4243f6d feat(site): modify primary link to gh instead 2023-12-02 09:50:19 +01:00
Ayo
c3957862ad chore: update README section for template & render 2023-12-02 09:49:05 +01:00
Ayo
6ae5961c4f feat(site): show link to FAQs issue 2023-12-02 09:39:37 +01:00
Ayo
8829bd28aa feat: show 2.0 beta announcement 2023-12-01 10:46:34 +01:00
Ayo
fd72c6d097 2.0.0-beta 2023-12-01 09:11:44 +01:00
Ayo
7632f96f69 2.0.0 2023-12-01 09:11:18 +01:00
Ayo
2943aa4c37 breaking: remove main entry point; use exports 2023-12-01 09:11:05 +01:00
Ayo
78ebd0058e 1.14.7 2023-12-01 08:48:03 +01:00
Ayo Ayco
73dd374a3e
feat: attach-effect (#2)
We are now able to attach "side effects" to property value changes, from inside the component and outside.
2023-12-01 08:42:10 +01:00
Ayo
54a3819b83 style(site): text & button sizes 2023-11-30 15:33:23 +01:00
Ayo
dd6dc96f1b chore: organize examples 2023-11-30 15:23:44 +01:00
Ayo
c9dd590931 feat(site): update content 2023-11-27 09:46:57 +01:00
Ayo
3e8334f2c1 feat(site): update content 2023-11-26 19:50:29 +01:00
Ayo
766cf65b4a feat(site): update content 2023-11-26 19:36:36 +01:00
Ayo Ayco
5cbd65090b
Merge pull request #1 from ayoayco/perf/optimize
feat: preserve props types
2023-11-26 04:21:30 +01:00
Ayo
9480f37844 chore: format 2023-11-26 04:19:19 +01:00
Ayo
da85a71aec 1.13.3 2023-11-26 03:47:07 +01:00
Ayo
b3189e2c6e chore: update readme 2023-11-26 03:46:54 +01:00
Ayo
6027f664b3 feat: preserve props type 2023-11-26 03:43:41 +01:00
Ayo
0209095d0a style(site): adjust call to action responsiveness 2023-11-25 21:17:44 +01:00
Ayo
7c3c98d382 feat(site): github link on the footer 2023-11-24 20:05:50 +01:00
Ayo
238fd3e071 feat(site): clean content 2023-11-24 14:01:07 +01:00
Ayo
82c11ea1d5 fix(site): non-unique IDs in code-block 2023-11-24 13:23:08 +01:00
Ayo
f4e74474c8 feat(site): update content with features list 2023-11-24 11:01:06 +01:00
Ayo
bda00b51b3 style(site): spacing, colors, hover 2023-11-24 01:11:10 +01:00
Ayo
07cacab1e9 style(site): fix responsiveness 2023-11-24 00:59:59 +01:00
Ayo
9fbea956e0 style(site): fix call to action buttons on mobile 2023-11-24 00:55:36 +01:00
Ayo
80b678da27 style(site): spacing, colors, responsiveness 2023-11-24 00:29:12 +01:00
Ayo
0140f79339 1.13.2 2023-11-23 22:15:34 +01:00
Ayo
fa506c8c0f refactor: use Proxy of empty object 2023-11-23 22:15:25 +01:00
Ayo
d392b1a0ca 1.13.1 2023-11-23 22:03:37 +01:00
Ayo
15a3b1ce33 chore: clean up; update readme docs 2023-11-23 22:03:26 +01:00
Ayo
2e87077ff6 feat(site): add link to codepen 2023-11-23 21:31:04 +01:00
Ayo
1b297859db style(site): adjust sizes and spaces 2023-11-23 08:21:37 +01:00
Ayo
851df8da14 refactor(site): footer content and structure 2023-11-23 08:13:33 +01:00
Ayo
44617ed999 feat(site): call-to-action, link to mcfly 2023-11-23 08:06:29 +01:00
Ayo
d0e458ff87 feat(site): update content 2023-11-22 11:09:35 +01:00
Ayo
a96047d680 feat(site): update page content 2023-11-22 11:03:03 +01:00
Ayo
278f1de61d feat(site): update meta 2023-11-22 11:02:08 +01:00
Ayo
3e87327440 feat(site): initial content 2023-11-22 10:45:23 +01:00
Ayo
b5bb13a7d2 feat(site): initial website for webcomponent.io 2023-11-22 08:55:10 +01:00
Ayo
98d47af7dc 1.13.0 2023-11-21 21:05:43 +01:00
Ayo
eeb0b1ef59 feat: allow string | Node | (string | Node)[] 2023-11-21 21:05:22 +01:00
Ayo
bce526f17e 1.12.21 2023-11-21 13:32:22 +01:00
Ayo
31cd515498 don't ship devDependencies 2023-11-21 13:32:10 +01:00
Ayo
ad359a60ef refactor hello-world component 2023-11-21 11:23:20 +01:00
Ayo
a7f3dfaf8e 1.12.20 2023-11-21 09:50:17 +01:00
Ayo
d56d7593f8 chore: update pkg meta 2023-11-21 09:50:09 +01:00
Ayo
3828c0392e 1.12.19 2023-11-20 22:17:25 +01:00
Ayo
51110f46ed chore: update package description 2023-11-20 22:17:17 +01:00
Ayo
f8aac1420f counter example 2023-11-20 22:14:37 +01:00
Ayo
9cc7959609 rollback version bump 2023-11-20 21:57:18 +01:00
Ayo
e33d56c1fb 1.12.19 2023-11-20 21:55:38 +01:00
Ayo
e57ac4f9b3 1.12.18 2023-11-20 21:53:13 +01:00
Ayo
b0f9e11ea5 chore: update readme 2023-11-20 21:53:00 +01:00
Ayo
d6c0e46649 1.12.17 2023-11-20 21:37:40 +01:00
Ayo
bdc0fb88f9 chore: update package meta 2023-11-20 21:37:25 +01:00
Ayo
3e79455ccb chore: update package meta & scripts 2023-11-19 18:38:41 +01:00
Ayo
dfd19a7484 1.12.16 2023-11-19 18:32:17 +01:00
Ayo
ad3994119c 1.12.15 2023-11-19 18:30:08 +01:00
Ayo
fcc6748819 1.12.14 2023-11-19 18:28:42 +01:00
Ayo
de673e2f12 feat: remove barrel file 2023-11-19 18:25:49 +01:00
Ayo
9d539f32a3 1.12.13 2023-11-19 01:44:39 +01:00
Ayo
60a3c75df0 chore: clean up build scripts 2023-11-19 01:44:35 +01:00
Ayo
4fb97836c3 chore: update readme, foldable table of contents 2023-11-19 01:43:49 +01:00
Ayo
ac6827e4cb chore: update readme 2023-11-19 00:41:01 +01:00
Ayo
e7b86df07b 1.12.12 2023-11-19 00:35:57 +01:00
Ayo
5a71651abc feat: add minified version 2023-11-19 00:35:33 +01:00
Ayo
29c26be58c refactor: move initializeProp to constructor 2023-11-19 00:35:07 +01:00
Ayo
7716348c9f 1.12.11 2023-11-19 00:15:22 +01:00
Ayo
fce411f7f4 chore: update library size section 2023-11-19 00:15:13 +01:00
Ayo
b8565ef3d1 1.12.10 2023-11-19 00:12:53 +01:00
Ayo
2c285a60bb refactor: remove constructor; move initializeProps to connectedCallback 2023-11-19 00:12:30 +01:00
Ayo
5799f8ea4e 1.12.9 2023-11-18 23:43:31 +01:00
Ayo
c4d4b3e699 chore: update package description and repo 2023-11-18 23:43:02 +01:00
Ayo
a9f5189b7f 1.12.8 2023-11-18 23:38:24 +01:00
Ayo
a3845b7e7c refactor: prevent attribute changing twice 2023-11-18 23:38:06 +01:00
Ayo
d54ff6fa94 fix: illegal invocation 2023-11-18 23:30:56 +01:00
Ayo
341424187b refactor: only pass setter to handler; initializeProps on attribute changes 2023-11-18 23:28:10 +01:00
Ayo
f8ca80da72 update sample demo page 2023-11-18 23:27:23 +01:00
Ayo
12acf83c8c chore: add library size section 2023-11-18 23:27:01 +01:00
Ayo
74e7c16335 refactor: add return types; organize code 2023-11-18 22:47:26 +01:00
Ayo
2affb0697c chore: update tldr 2023-11-18 22:46:51 +01:00
Ayo
10b2c09bac chore: update tldr 2023-11-18 22:45:26 +01:00
Ayo
b9c66923c9 chore: add check:size script using size-limit 2023-11-18 22:34:31 +01:00
Ayo
85944641fe 1.12.7 2023-11-18 10:40:10 +01:00
Ayo
60008bf07e chore: update readme
- clearer explanation
2023-11-18 10:40:03 +01:00
Ayo
307670bf11 1.12.6 2023-11-18 10:31:34 +01:00
Ayo
6869ccb3e7 feat: more explainer for using WebComponent.props
- update readme with more read/write access explanation and example
- update demo page to use .props
2023-11-18 10:31:12 +01:00
Ayo
a3fcf4572f 1.12.5 2023-11-18 09:11:59 +01:00
Ayo
8343fded9c chore: update README examples 2023-11-18 09:11:51 +01:00
Ayo
3e828912db 1.12.4 2023-11-18 02:50:12 +01:00
Ayo
463136eea8 feat: assign DOMStringMap type to props 2023-11-18 02:50:03 +01:00
Ayo
1fb893a03f 1.12.3 2023-11-18 00:45:39 +01:00
Ayo
b73a62dc35 feat: camelCase backwards compatibility 2023-11-18 00:45:35 +01:00
Ayo
fad385d5b6 move sample.html 2023-11-17 23:44:18 +01:00
Ayo
53817036d9 add quick-start sample as demo page 2023-11-17 23:43:49 +01:00
Ayo
a388ea7dc9 1.12.2 2023-11-17 23:31:23 +01:00
Ayo
2616591315 refactor: make props read-only 2023-11-17 23:31:10 +01:00
Ayo
63175c6c9f 1.12.1 2023-11-17 23:23:51 +01:00
Ayo
693c35d082 fix: README examples 2023-11-17 23:23:32 +01:00
Ayo
3d31b41f53 1.12.0 2023-11-17 23:10:13 +01:00
Ayo
910a5096d0 feat: props Proxy for camelCase counterparts
- provide easy access to any observed attribute.
- update README examples
- update JSDoc examples
2023-11-17 23:10:02 +01:00
Ayo
003b72a1f2 1.11.4 2023-11-17 16:10:19 +01:00
Ayo
aabbb09c89 feat: better example to show observed attrs are only smallcase 2023-11-17 16:08:25 +01:00
Ayo
bef423fde1 feat: support boolean attribute
if no value is passed to an attribute it returns 'true'
2023-11-17 15:42:45 +01:00
Ayo
670c882e44 1.11.3 2023-11-12 16:06:59 +01:00
Ayo
d3573ec5b2 chore: better example with explanations 2023-11-12 16:06:47 +01:00
Ayo
859260f578 fix: demo import 2023-11-10 22:06:55 +01:00
Ayo
bfacf84b45 refactor: update jsdocs types & example 2023-11-10 22:04:46 +01:00
Ayo
b74ee310da chore: add LICENSE file 2023-11-10 21:56:12 +01:00
Ayo
2423dc6887 1.11.2 2023-11-09 11:01:27 +01:00
Ayo
157e9ed8cb fix: supper.connectedCallback doesn't exist 2023-11-09 11:01:19 +01:00
Ayo
1172247693 1.11.1 2023-11-07 00:00:05 +01:00
Ayo
d0e144953a feat: add jsdoc example and links 2023-11-06 23:59:46 +01:00
Ayo
4aaa93e57a 1.11.0 2023-10-29 18:11:51 +01:00
Ayo
feed3f7005 chore: deliver .js instead of .mjs 2023-10-29 18:10:42 +01:00
Ayo
12ef8fe02f 1.10.0 2023-10-27 08:50:24 +02:00
Ayo
4e533009df remove prep 2023-10-27 08:49:59 +02:00
Ayo
7eb067f923 try prepare 2023-10-27 08:49:37 +02:00
Ayo
316433b1d0 1.9.9 2023-10-27 08:48:16 +02:00
Ayo
3633b49e4d try prepublishOnly 2023-10-27 08:48:08 +02:00
Ayo
18b34019ba 1.9.8 2023-10-27 08:47:38 +02:00
Ayo
1415c82113 chore: prepare scripts 2023-10-27 08:47:30 +02:00
Ayo
3d1e92b36a 1.9.7 2023-10-27 08:45:59 +02:00
Ayo
39180f45f2 1.9.6 2023-10-27 08:45:48 +02:00
Ayo
e61f033520 chore revert patch 2023-10-27 08:45:39 +02:00
Ayo
61e4dadb41 1.9.6 2023-10-27 08:45:01 +02:00
Ayo
09ffc5d99c refactor: add class description; private camelCase util 2023-10-27 08:44:55 +02:00
Ayo
884da7e2aa 1.9.5 2023-10-25 16:27:56 +02:00
Ayo
4d266891a8 1.9.4 2023-10-24 18:39:47 +02:00
Ayo
8c06069b25 fix: readme example 2023-10-24 18:39:39 +02:00
Ayo
42ad333201 1.9.3 2023-10-20 12:19:48 +02:00
Ayo
9b37dfa0de chore: fix quick start example 2023-10-20 12:19:41 +02:00
Ayo
3fff13c08a 1.9.2 2023-10-20 12:14:30 +02:00
Ayo
b5cb00d26f chore: update samples in readme 2023-10-20 12:14:20 +02:00
Ayo
5ee41e9a1d 1.9.1 2023-10-20 12:05:42 +02:00
Ayo
53fc70aa96 chore: add Prop Access section to readme 2023-10-20 12:05:35 +02:00
Ayo
f785799fcf 1.9.0 2023-10-20 11:59:06 +02:00
Ayo
79d733ee82 1.8.0 2023-10-20 11:58:50 +02:00
Ayo
8a977ce3e2 feat: access kebab-case props with camelCase counterpart 2023-10-20 11:58:36 +02:00
Ayo
746c09f79e 1.7.1 2023-10-19 18:18:55 +02:00
Ayo
4763df6ee8 Revert "1.8.0"
This reverts commit da5cb1ad08.
2023-10-19 18:18:33 +02:00
Ayo
da5cb1ad08 1.8.0 2023-10-19 18:17:37 +02:00
Ayo
6ad2ab5707 fix: missing dts 2023-10-19 18:17:30 +02:00
Ayo
6b448f2c1b 1.7.0 2023-10-19 18:11:07 +02:00
Ayo
c360bd1b7f feat: make package type module; rename to .mjs 2023-10-19 18:10:10 +02:00
Ayo
a250387246 1.6.15 2023-09-25 18:18:46 +02:00
Ayo
8b80b93e47 chore: update readme 2023-09-25 18:18:33 +02:00
Ayo
db5b07d14f 1.6.14 2023-09-25 18:16:05 +02:00
Ayo
9568c4e0d4 feat: onDestroy life-cycle hook 2023-09-25 18:15:55 +02:00
Ayo
a74180680d 1.6.13 2023-09-23 11:10:25 +02:00
Ayo
5449ef2ee2 chore: update readme tldr 2023-09-23 11:10:20 +02:00
Ayo
c58415db0e 1.6.12 2023-09-23 11:07:36 +02:00
Ayo
0d7bdfa162 chore: update readme tldr 2023-09-23 11:06:20 +02:00
Ayo
919a07a5e1 1.6.11 2023-09-22 10:26:31 +02:00
Ayo
ca8264c4b9 chore: update readme 2023-09-22 10:26:26 +02:00
Ayo
e226c1bf3b 1.6.10 2023-09-22 09:56:17 +02:00
Ayo
16108193fd chore: add template vs render() section to readme 2023-09-22 09:55:13 +02:00
Ayo
86f77d86ca 1.6.9 2023-09-19 16:35:23 +02:00
Ayo
ed393fb617 chore: update publish script 2023-09-19 16:35:14 +02:00
Ayo
7ea47166bf 1.6.8 2023-09-19 16:30:26 +02:00
Ayo
99ea3a4d57 chore: update readme import instructions & examples 2023-09-19 16:30:18 +02:00
Ayo
0880f9d188 1.6.7 2023-09-19 14:27:22 +02:00
Ayo
e2ebf8f91a chore: fix version 2023-09-19 14:27:13 +02:00
Ayo
d551e7c36b 1.6.7 2023-09-19 14:25:05 +02:00
Ayo
aa29751f8c 1.6.6 2023-09-19 14:23:50 +02:00
Ayo
bdc457d16d chore: fix version 2023-09-19 14:23:42 +02:00
Ayo
d202f81124 1.6.7 2023-09-19 14:23:07 +02:00
Ayo
f85a947955 1.6.6 2023-09-19 14:22:14 +02:00
Ayo
4a8fc484af chore: update copy scripts 2023-09-19 14:22:06 +02:00
Ayo
e1dff4001d 1.6.6 2023-09-19 14:19:10 +02:00
Ayo
1104b53df9 chore: update build 2023-09-19 14:18:18 +02:00
Ayo
9a49e8905f chore: update scripts 2023-09-19 14:12:31 +02:00
Ayo
831b870744 1.6.5 2023-09-19 14:09:06 +02:00
Ayo
fdf09762f9 chore: add scripts 2023-09-19 14:09:00 +02:00
Ayo
d78de84238 1.6.4 2023-09-19 14:01:59 +02:00
Ayo
ee3416561d chore: update distribution directory 2023-09-19 14:01:55 +02:00
Ayo
ba4d33a96d 1.6.3 2023-09-19 09:44:02 +02:00
Ayo
ca900a3544 chore: npm i in-progress 2023-09-19 09:43:53 +02:00
Ayo
9bec740f07 1.6.2 2023-09-18 22:54:42 +02:00
Ayo
b3892cf95d feat: publish type definitions 2023-09-18 22:52:38 +02:00
Ayo
b05941caca chore: add "start" script 2023-09-18 20:30:41 +02:00
Ayo
3e76af7412 chore: update readme 2023-09-17 22:09:09 +02:00
Ayo
566840c901 1.6.1 2023-09-17 22:04:22 +02:00
Ayo
031d18f448 chore: update readme, package description 2023-09-17 22:04:12 +02:00
Ayo
4d791dc3a4 1.6.0 2023-09-17 20:35:27 +02:00
Ayo
d5b83ed847 refactor: revert onChanges param 2023-09-17 20:35:21 +02:00
Ayo
060c717092 chore: update readme 2023-09-17 20:22:10 +02:00
Ayo
c8f0c64bc6 1.5.0 2023-09-17 20:18:38 +02:00
Ayo
a5a39e314a chore: update test component 2023-09-17 20:18:32 +02:00
Ayo
e07c97b760 feat: afterViewInit hook; change onChanges param structure 2023-09-17 20:15:55 +02:00
Ayo
bdbd05d92c 1.4.1 2023-09-17 19:29:36 +02:00
Ayo
377b129d73 chore: update readme; add badges, rephrase 2023-09-17 19:29:26 +02:00
Ayo
53cf7c492b 1.4.0 2023-09-17 14:45:58 +02:00
Ayo
e4a5ce37bd feat: static properties 2023-09-17 14:45:46 +02:00
Ayo
596896b0f0 1.3.0 2023-09-17 13:49:03 +02:00
Ayo
0ba7738da1 feat: only call onChanges when previousValue !== currentValue 2023-09-17 13:48:57 +02:00
Ayo
8cfd286598 1.2.5 2023-09-17 13:40:56 +02:00
Ayo
ccd3d9ed18 chore: update onChanges example 2023-09-17 13:40:48 +02:00
Ayo
ce9210d93c 1.2.4 2023-09-17 11:29:26 +02:00
Ayo
e7608f8be6 chore: remove unneeded url 2023-09-17 11:29:20 +02:00
Ayo
b82e31c78a 1.2.3 2023-09-17 11:27:48 +02:00
Ayo
162bae487f chore: add quick start example 2023-09-17 11:27:42 +02:00
92 changed files with 23164 additions and 229 deletions

35
.build.yml Normal file
View 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

13
.gitignore vendored
View file

@ -1,5 +1,18 @@
node_modules/
dist/
# temporary files # temporary files
*~ *~
*swo *swo
*swp *swp
# nitro site
*.log*
.nitro
.cache
.output
.env
.eslintcache
# vitest
coverage

4
.husky/pre-commit Executable file
View file

@ -0,0 +1,4 @@
npm run lint --cache
npm run test
npm run build
npx size-limit

19
.npmignore Normal file
View 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
View file

@ -0,0 +1,7 @@
# someday let's think about formatting html
**/*.html
**/*.md
**/*.css
**/*.yml
**/*.yaml

View file

@ -1,3 +1,4 @@
{ {
"editor.formatOnSave": true "js/ts.implicitProjectConfig.checkJs": true,
} "editor.formatOnSave": true
}

21
LICENSE Normal file
View 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.

156
README.md
View file

@ -1,119 +1,39 @@
Web Component Base # Web Component Base
[![Package information: NPM version](https://img.shields.io/npm/v/web-component-base)](https://www.npmjs.com/package/web-component-base)
[![Package information: NPM license](https://img.shields.io/npm/l/web-component-base)](https://www.npmjs.com/package/web-component-base)
[![Package information: NPM downloads](https://img.shields.io/npm/dt/web-component-base)](https://www.npmjs.com/package/web-component-base)
[![Bundle Size](https://img.shields.io/bundlephobia/minzip/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 ✨
![counter example code snippet](https://git.sr.ht/~ayoayco/wcb/blob/main/assets/IMG_0682.png)
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.
## Links
- [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)
## Want to get in touch?
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)
## Inspirations and thanks
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
--- ---
This is a very minimal base class for creating reactive custom elements easily. *Just keep building.*<br>
*A project by [Ayo](https://ayo.ayco.io)*
When you extend the `WebComponent` class for your component, you only have to define the `template()` and `observedAttributes()`, and changes in any attribute value will automatically cause the UI to render.
The result is a reactive UI on attribute changes.
## Table of Contents
1. [Vanilla JS import](#vanilla-js-import)
1. [Installation](#installation)
1. [Usage](#usage)
1. [Life-Cycle Hooks](#life-cycle-hooks)
1. [`onInit`](#oninit) - the component is connected to the DOM
1. [`onChanges`](#onchanges) - an attribute value changed
## Vanilla JS import
Import using [unpkg](https://unpkg.com/web-component-base) in your component. We will use this in the rest of our [usage examples](#usage).
```js
import WebComponent from "https://unpkg.com/web-component-base";
```
## Installation
If you have a bundler to help resolving imports:
```bash
npm i web-component-base
```
## Usage
In your component class:
```js
// HelloWorld.mjs
import WebComponent from "https://unpkg.com/web-component-base";
class HelloWorld extends WebComponent {
name = "World";
emotion = "excited";
static get observedAttributes() {
return ["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" />
## Life-Cycle Hooks
Define behavior when certain events in the component's life cycle is triggered by providing hook methods
### onInit()
- gets 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";
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>`;
}
}
```
### onChanges()
- gets triggered when an attribute value changed
```js
import WebComponent from "https://unpkg.com/web-component-base";
class ClickableText extends WebComponent {
// gets called when an attribute value changes
onChanges({attr, prev, curr}) {
console.log('>>> something changed', {attr, prev, curr})
}
get template() {
return `<span style="cursor:pointer">Click me!</span>`;
}
}
```

View file

@ -1,35 +0,0 @@
// @ts-check
export class WebComponent extends HTMLElement {
get template() {
return "";
}
/**
* triggered when the component is connected to the DOM
*/
onInit() {}
/**
* triggered when an attribute value changed
*/
onChanges({ property, previousValue, currentValue }) {}
connectedCallback() {
this.render();
this.onInit();
}
attributeChangedCallback(property, previousValue, currentValue) {
if (previousValue !== currentValue) {
this[property] = currentValue;
this.render();
}
this.onChanges({ property, previousValue, currentValue });
}
render() {
this.innerHTML = this.template;
}
}

BIN
assets/IMG_0682.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 136 KiB

BIN
assets/IMG_0683.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 102 KiB

BIN
assets/IMG_0684.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 93 KiB

BIN
assets/styling.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 319 KiB

BIN
assets/todo-app.gif Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 474 KiB

View file

@ -1,22 +0,0 @@
// @ts-check
import WebComponent from "../index.mjs";
export class HelloWorld extends WebComponent {
name = "World";
emotion = "excited";
static get observedAttributes() {
return ["name", "emotion"];
}
onChanges({ property, previousValue, currentValue }) {
console.log(">>> changed", { property, previousValue, currentValue });
}
get template() {
return `
<h1>Hello ${this.name}${this.emotion === "sad" ? ". 😭" : "! 🙌"}</h1>`;
}
}
customElements.define("hello-world", HelloWorld);

View file

@ -1,14 +0,0 @@
// @ts-check
import WebComponent from "../index.mjs";
class SimpleText extends WebComponent {
onInit() {
this.onclick = () => console.log(">>> click!");
}
get template() {
return `<span>Click me!</span>`;
}
}
customElements.define("simple-text", SimpleText);

View file

@ -1,21 +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 name="Ayo" emotion="sad"></hello-world>
<simple-text greeting="hey"></simple-text>
<script type="module">
const helloWorld = document.querySelector("hello-world");
setTimeout(() => {
helloWorld.setAttribute("emotion", "excited");
}, 2500);
</script>
</body>
</html>

21
docs/.gitignore vendored Normal file
View 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
View file

@ -0,0 +1,4 @@
{
"recommendations": ["astro-build.astro-vscode"],
"unwantedRecommendations": []
}

11
docs/.vscode/launch.json vendored Normal file
View 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
View file

@ -0,0 +1,54 @@
# Starlight Starter Kit: Basics
[![Built with Starlight](https://astro.badg.es/v2/built-with-starlight/tiny.svg)](https://starlight.astro.build)
```
npm create astro@latest -- --template starlight
```
[![Open in StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz.svg)](https://stackblitz.com/github/withastro/starlight/tree/main/examples/basics)
[![Open with CodeSandbox](https://assets.codesandbox.io/github/button-edit-lime.svg)](https://codesandbox.io/p/sandbox/github/withastro/starlight/tree/main/examples/basics)
[![Deploy to Netlify](https://www.netlify.com/img/deploy/button.svg)](https://app.netlify.com/start/deploy?repository=https://github.com/withastro/starlight&create_from_path=examples/basics)
[![Deploy with Vercel](https://vercel.com/button)](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 [Starlights 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
View 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

File diff suppressed because it is too large Load diff

18
docs/package.json Normal file
View 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"
}
}

Binary file not shown.

After

Width:  |  Height:  |  Size: 2.8 KiB

1
docs/public/favicon.svg Normal file
View 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

View 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

Binary file not shown.

After

Width:  |  Height:  |  Size: 8.8 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 96 KiB

View 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>

View 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() }),
};

View 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)
![To-Do App screen recording](https://raw.githubusercontent.com/ayoayco/web-component-base/main/assets/todo-app.gif)
### 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)

View 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...
```

View 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
```

View 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)
```

View 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).

View 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 &copy; 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>`
}
}
```

View 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.

View 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)
```

View 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)
```

View 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)

View 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>
```

View 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>

View 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>

View 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
View file

@ -0,0 +1,5 @@
{
"extends": "astro/tsconfigs/strict",
"include": [".astro/types.d.ts", "**/*"],
"exclude": ["dist"]
}

18
eslint.config.mjs Normal file
View 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/*'],
},
]

View 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>

View 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)

View 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
View 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)

View 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)

View 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
View 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
View 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>

View 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>

View 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)

View 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>

View 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)

View 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>

View 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)

View 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>

View 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)

View 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)

View 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)

View 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)

View 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)

View 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)

View 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>

View 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>

View 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)

View file

@ -1,3 +0,0 @@
import { WebComponent } from './WebComponent.mjs';
export default WebComponent;

3
netlify.toml Normal file
View file

@ -0,0 +1,3 @@
[build]
base = "docs"
publish = "dist"

View file

@ -1,19 +1,51 @@
{ {
"name": "web-component-base", "name": "web-component-base",
"version": "1.2.2", "version": "4.1.1",
"description": "JavaScript Web Component base class", "description": "A zero-dependency & tiny JS base class for creating reactive custom elements easily",
"main": "index.mjs", "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": {
"test": "echo \"Error: no test specified\" && exit 1" "preinstall": "npx only-allow pnpm",
"start": "npx simple-server .",
"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",
"copy:source": "esbuild --minify --bundle ./src/*.js ./src/utils/* --outdir=\"./dist\" --format=\"esm\"",
"pub": "pnpm run clean && pnpm run build && npm publish",
"pub:patch": "npm version patch && pnpm run pub",
"pub:minor": "npm version minor && pnpm run pub",
"pub:major": "npm version major && pnpm run pub",
"format": "prettier . --write",
"lint": "eslint . --config eslint.config.mjs",
"prepare": "husky install"
}, },
"repository": { "repository": "https://github.com/ayoayco/web-component-base",
"type": "git", "homepage": "https://WebComponent.io",
"url": "https://git.sr.ht/~ayoayco/web-component-base"
},
"files": [
"index.mjs",
"WebComponent.mjs"
],
"keywords": [ "keywords": [
"web components", "web components",
"web component", "web component",
@ -23,7 +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": {
"@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

File diff suppressed because it is too large Load diff

3
pnpm-workspace.yaml Normal file
View file

@ -0,0 +1,3 @@
packages:
# include packages in subfolders (e.g. apps/ and packages/)
- 'docs/'

14
prettier.config.mjs Normal file
View 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
View 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
)
}
}
}

81
src/html.js Normal file
View 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)

2
src/index.js Normal file
View file

@ -0,0 +1,2 @@
export { WebComponent } from './WebComponent.js'
export { html } from './html.js'

View 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
View 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
}
}

View file

@ -0,0 +1,3 @@
export function getCamelCase(kebab) {
return kebab.replace(/-./g, (x) => x[1].toUpperCase())
}

View 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
View 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
View 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
}
}

View 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()
})
})

View 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()
})
})

View 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
View 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
View 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
View 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'],
},
},
})