weldkit
v0.1.11
Published
HTML elements library for web components
Downloads
5
Readme
Weldkit
Create web and desktop applications using web components.
Installation
cd myproject
npm install weldkitGetting started
There are four base classes to create web components:
- WebAppElement: Used to create web applications
- ElectronAppElement: Used to create desktop applications
- PageElement: Used to create page elements
- ViewElement: Used to create view elements
- FragmentElement: Used to create fragment elements
All these are modules exported by the weldkit module. These elements are meant to be used in a hierarchical way, so the App element should be at the at the root of the documents body.
body
|
+--> AppElement
|
+--> PageElement
|
+--> ViewElement
|
+--> FragmentElementIn this hierarchy view elements are optional, so a fragment element may be a child of a page element. A fragment element would be for example a table, a form, a list, in general, an HTML UI widget. A view is a collection of fragments that work together. The page element is used to hold an entire screen, so at any given time only one page is active and visible to the user, who may navigate between different screens to interact with the application.
To use a base element, simply import it and extend your class, like so:
// MyAppElement.js
import {WebAppElement} from 'npm_modules/weldkit/index.js';
class MyAppElement extends WebAppElement {
constructor() {
super();
}
}All base element classes extend from HTMLElement class, so they share the same API, which include HTML element lifecycle methods, such as (see MDN guide: Using custom elements):
- connectedCallback
- disconnectedCallback
- adoptedCallback
- attributeChangedCallback
Your element should be a module, so it has to be exported. But before you should register it like so:
customElements.define('my-app', MyAppElement);To run your app, you need an HTML document that looks similar to this:
<!DOCTYPE html>
<html>
<head>
<script src="/node_modules/systemjs/dist/system-production.js"></script>
<script type="module" src="node_modules/weldkit/index.js"></script>
<script type="module" src="MyAppElement.js"></script>
</head>
<body>
<my-app data-role="app"></my-app>
</body>
</html>weldkit relies on SystemJS to handle commonJS modules, so make sure to include the library first, like in the example above. Also note the role attribute, weldkit relies on such attributes to identify special components since the tag name is arbitrary and thus cannot be used to identify a component's role. Other roles are page, for page elements and view, for view elements.
Check out the web app example included in the project.
Currently weldkit is under heavy development, so it is unstable. Keep tuned to our twitter for updates.