ayo/wcb
1
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

chore: add .gitignore; update readme

Browse source
This commit is contained in:
Ayo 2023-09-17 00:36:03 +02:00
parent 781232701d
commit 523fa7d620
2 changed files with 9 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
.gitignore vendored Normal file
View file

@ -0,0 +1,5 @@
# temporary files
*~
*swo
*swp

8
README.md
View file

@ -1,8 +1,10 @@
# Web Component Base # Web Component Base
This serves as a very minimal base class for creating custom elements. This is a very minimal base class for creating reactive custom elements easily.
This does not aim to be an alternative to [Lit](https://lit.dev/). Lit is good; use it if you want. 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.
## Installation ## Installation
@ -12,7 +14,6 @@ npm i web-component-base
## Usage ## Usage
When you extend the `WebComponent` class for your component, you only have to define the `template()` and `observedAttributes()`, and the UI will be reactive on attribute changes.
In your component class: In your component class:
@ -37,7 +38,6 @@ export class HelloWorld extends WebComponent {
customElements.define('hello-world', HelloWorld); customElements.define('hello-world', HelloWorld);
``` ```
Then changes in the attributes observed will cause the UI to render.
In your HTML page: In your HTML page: