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

chore: update readme, foldable table of contents

Browse source
This commit is contained in:
Ayo 2023-11-19 01:43:49 +01:00
parent ac6827e4cb
commit 4fb97836c3
1 changed files with 25 additions and 23 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

48
README.md
View file

@ -11,21 +11,30 @@ When you extend the `WebComponent` class for your component, you only have to de
The result is a reactive UI on property changes. The result is a reactive UI on property changes.
## Table of Contents <details>
1. [Import via unpkg](#import-via-unpkg) <summary>Table of Contents</summary>
1. [Installation via npm](#installation-via-npm) <ol>
1. [Usage](#usage) <li><a href="#import-via-unpkg">Import via unpkg</a></li>
1. [`template` vs `render()`](#template-vs-render) <li><a href="#installation-via-npm">Installation via npm</a></li>
1. [Prop access](#prop-access) <li><a href="#usage">Usage</a></li>
1. [Alternatives](#alternatives) <li><a href="#template-vs-render">`template` vs `render()`</a></li>
1. [Quick Start Example](#quick-start-example) <li><a href="#prop-access">Prop access</a>
1. [Life-Cycle Hooks](#life-cycle-hooks) <ol>
1. [`onInit`](#oninit) - the component is connected to the DOM, before view is initialized <li><a href="#alternatives">Alternatives</a></li>
1. [`afterViewInit`](#afterviewinit) - after the view is first initialized </ol>
1. [`onDestroy`](#ondestroy) - the component is disconnected from the DOM </li>
1. [`oChanges`](#onchanges) - every time an attribute value changes <li><a href="#quick-start-example">Quick Start Example</a></li>
1. [Library Size](#library-size) <li><a href="#life-cycle-hooks">Life-Cycle Hooks</a>
<ol>
<li><a href="#oninit">`onInit`</a> - the component is connected to the DOM, before view is initialized</li>
<li><a href="#afterviewinit">`afterViewInit`</a> - after the view is first initialized</li>
<li><a href="#ondestroy">`onDestroy`</a> - the component is disconnected from the DOM</li>
<li><a href="#onchanges">`onChanges`</a> - every time an attribute value changes</li>
</ol>
</li>
<li><a href="#library-size">Library Size</a></li>
</ol>
</details>
## Import via unpkg ## Import via unpkg
Import using [unpkg](https://unpkg.com/web-component-base) in your vanilla JS component. We will use this in the rest of our [usage examples](#usage). Import using [unpkg](https://unpkg.com/web-component-base) in your vanilla JS component. We will use this in the rest of our [usage examples](#usage).
@ -51,7 +60,6 @@ import WebComponent from "https://unpkg.com/web-component-base@latest/WebCompone
class HelloWorld extends WebComponent { class HelloWorld extends WebComponent {
static properties = ["my-name", "emotion"]; static properties = ["my-name", "emotion"];
get template() { get template() {
return ` return `
<h1>Hello ${this.props.myName}${this.props.emotion === "sad" ? ". 😭" : "! 🙌"}</h1>`; <h1>Hello ${this.props.myName}${this.props.emotion === "sad" ? ". 😭" : "! 🙌"}</h1>`;
@ -75,8 +83,6 @@ In your HTML page:
setTimeout(() => { setTimeout(() => {
helloWorld.setAttribute('emotion', 'excited'); helloWorld.setAttribute('emotion', 'excited');
// or:
helloWorld.props.emotion = 'excited';
}, 2500) }, 2500)
</script> </script>
</body> </body>
@ -244,10 +250,6 @@ class ClickableText extends WebComponent {
} }
``` ```
### onChanges() ### onChanges()
- Triggered when an attribute value changed - Triggered when an attribute value changed
@ -269,4 +271,4 @@ class ClickableText extends WebComponent {
## Library Size ## Library Size
Running [size-limit](https://npmjs.com/package/@size-limit/preset-small-lib) reports the library size as around 760 Bytes, minified and brotlied. Read more about how to [minify and compress payload with brotli](https://web.dev/articles/codelab-text-compression-brotli) for your app. Running [size-limit](https://npmjs.com/package/@size-limit/preset-small-lib) reports the base class size as around 760 Bytes (minified & brotlied). Using the `WebComponent.min.js` version gets it down to 400 Bytes. Read more about how to [minify and compress payload with brotli](https://web.dev/articles/codelab-text-compression-brotli) for your app.