qr-element-extended/README.md

A simple wrapper for QR code generation and scanning in webcomponents

* HTML ELEMENT EXTENDED

This goal of this project is to
create a simple wrapper for web components that provides
much of the useful functionality of lifecycle frameworks like react
without the complication or overhead.

In particular there is no compile-time step for this library,
each of the files can be loaded as a module. 

To use this, (currently, until its on npmjs.com)
To a caller add to `package.json/dependencies`
```
"html-element-extended": "https://github.com/mitra42/html-element-extended",
```
Then in your webcomponents.js file for example include it with
```
import { EL, HTMLElementExtended, getUrl } from './node_modules/html-element-extended/htmlelementextended.js';
import { ContentVideo } from './node_modules/html-element-extended/videoelementextended.js';
import { QRScanExtended, QRCodeExtended } from './node_modules/html-element-extended/qrlementextended.js';
```
To add a new module,
* Add a file here xxxelementextended.js
* Add to the docs here
* Add to package.json/exports

Each module is documented internally but as a TL;DR

** htmlelementextended.js

Provides HTMLElementExtended which can be used instead of HTMLElement
to create your own web components, but has the key functionality already there.

** qrelementextended.js

Use HTMLElementExtended to build a QR scanner and a QR display

** videoelementextended.js

Uses HTMLElementExtended to create [yaml2sqlite.js](..%2F..%2Fmitrabiz%2Fserver%2Fyaml2sqlite.js)a number of video webComponents that 
know how to display videos from a variety of sources (based on the URL)
allowing a single <ContentVideo> component to handle 
YouTube, Vimeo, Internet Archive, WebTorrent etc. 

Note - all of these are under development. 
If you use them please introduce yourself in a git issue, 
and I'll bear this in mind when making any breaking revisions. 

** eventbus.js
A simple event handler to hide the mechanisms

* At the page level create e.g. `const bus = new EventBus`
* At a receiving object typically   bus.register("foo",(evt) => {...})
* At sending end bus.fire("foo",{a: 1, b: 2})
* remove is rarely used, but is there for completeness.

** Upgrading packages
There is a fair bit of instability at the moment (July 2023) in npm 
with modules and commonJS coexisting. 
The following document some of the issues with upgrading
*** webtorrent
At some point webtorrent.min.js was moved into dist/ certainl[sqllib.js](..%2F..%2Fmitrabiz%2Fserver%2Fsqllib.js)y there in 2.1.13