chore: update examples to use unpkg
This commit is contained in:
parent
abf19652f8
commit
3debb6fdd9
1 changed files with 13 additions and 4 deletions
15
README.md
15
README.md
|
@ -7,13 +7,22 @@ When you extend the `WebComponent` class for your component, you only have to de
|
||||||
The result is a reactive UI on attribute changes.
|
The result is a reactive UI on attribute changes.
|
||||||
|
|
||||||
## Table of Contents
|
## Table of Contents
|
||||||
|
1. [Vanilla JS import](#vanilla-js-import)
|
||||||
1. [Installation](#installation)
|
1. [Installation](#installation)
|
||||||
1. [Usage](#usage)
|
1. [Usage](#usage)
|
||||||
1. [Life-Cycle Hooks](#life-cycle-hooks)
|
1. [Life-Cycle Hooks](#life-cycle-hooks)
|
||||||
1. [`onInit`](#oninit) - the component is connected to the DOM
|
1. [`onInit`](#oninit) - the component is connected to the DOM
|
||||||
1. [`onChanges`](#onchanges) - an attribute value changed
|
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
|
## Installation
|
||||||
|
If you have a bundler to help resolving imports:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
npm i web-component-base
|
npm i web-component-base
|
||||||
|
@ -26,7 +35,7 @@ In your component class:
|
||||||
|
|
||||||
```js
|
```js
|
||||||
// HelloWorld.mjs
|
// HelloWorld.mjs
|
||||||
import WebComponent from "web-component-base";
|
import WebComponent from "https://unpkg.com/web-component-base";
|
||||||
|
|
||||||
export class HelloWorld extends WebComponent {
|
export class HelloWorld extends WebComponent {
|
||||||
name = "World";
|
name = "World";
|
||||||
|
@ -77,7 +86,7 @@ Define behavior when certain events in the component's life cycle is triggered b
|
||||||
- best for setting up the component
|
- best for setting up the component
|
||||||
|
|
||||||
```js
|
```js
|
||||||
import WebComponent from "../index.mjs";
|
import WebComponent from "https://unpkg.com/web-component-base";
|
||||||
|
|
||||||
class ClickableText extends WebComponent {
|
class ClickableText extends WebComponent {
|
||||||
// gets called when the component is used in an HTML document
|
// gets called when the component is used in an HTML document
|
||||||
|
@ -95,7 +104,7 @@ class ClickableText extends WebComponent {
|
||||||
- gets triggered when an attribute value changed
|
- gets triggered when an attribute value changed
|
||||||
|
|
||||||
```js
|
```js
|
||||||
import WebComponent from "../index.mjs";
|
import WebComponent from "https://unpkg.com/web-component-base";
|
||||||
|
|
||||||
class ClickableText extends WebComponent {
|
class ClickableText extends WebComponent {
|
||||||
// gets called when an attribute value changes
|
// gets called when an attribute value changes
|
||||||
|
|
Loading…
Reference in a new issue