UI Dev Kit (build)


License
CC-BY-4.0
Install
npm install @uiwebkit/udk@2.0.0-27

Documentation

Built With Stencil

UI Dev Kit

UI Dev Kit is a set of Web Components & Custom Elements to build widgets and even web apps in a declarative style.

UI Dev Kit elements have three modes:

  1. Custom Element - 100% convenience;
  2. Web Component - 100% security;
  3. Custom Element Wrapper - 100% customization;

UI Dev Kit takes TypeScript, JSX, a tiny virtual DOM layer, efficient one-way data binding, an asynchronous rendering pipeline (similar to React Fiber), and lazy-loading out of the box, and generates 100% standards-based Web Components & Custom Elements that run in any browser supporting the Custom Elements v1 spec.

UI Dev Kit elements are just HTML Web Components & HTML Custom Elements, so they work in any major framework or with no framework at all.

Getting Started

Check out our docs here.

Using Components

There are two strategies we recommend for using UI Dev Kit:

Script tag

  • Put a script tag <script type="module" src="https://cdn.jsdelivr.net/npm/@uiwebkit/udk@latest/dist/udk.esm.js"></script> in the head of your index.html
  • To support old browsers, also put a script tag <script nomodule src="https://cdn.jsdelivr.net/npm/@uiwebkit/udk@latest/dist/udk.js"></script> in the head of your index.html
  • Then you can use the element anywhere in your template, JSX, html etc

Node Modules

  • Run npm i @uiwebkit/udk --save
  • Put a script tag similar to this <script type="module" src="node_modules/@uiwebkit/udk/dist/udk.esm.js"></script> in the head of your index.html
  • To support old browsers, also put a script tag <script nomodule src="node_modules/@uiwebkit/udk/dist/udk.js"></script> in the head of your index.html
  • Then you can use the element anywhere in your template, JSX, html etc