@uiwebkit/tabs
TypeScript icon, indicating that this package has built-in type declarations

1.0.3 • Public • Published

Built With Stencil

Uni Tabs

Uni Tabs is a set of Web Components & Custom Elements for adding webpage tabs and customize it in the declarative style.

Uni Tabs components have three modes:

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

Uni Tabs 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.

Uni Tabs components are just HTML Web Components & Custom Elements, so they work in any major framework or with no framework at all.

Getting Started

Clone this repo to a new directory:

git clone https://github.com/uiwebkit/tabs.git uni-tabs
cd uni-tabs

and run:

npm i
npm run serve:dev

To build the component for production, run:

npm run build:prod

Check out our docs here.

Naming Components

When creating new component tags, use uni in the component name (ex: <uni-tab>) or use a prefix that fits your company or any name for a group of related components. For example, all the UiWebKit generated Web Components & Custom Elements use the prefix uni.

Using Components

There are two strategies we recommend for using Uni Tabs:

Script tag

  • Put a script tag <script type="module" src="https://cdn.jsdelivr.net/npm/@uiwebkit/tabs@latest/dist/tabs/tabs.esm.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/tabs --save
  • Paste import '@uiwebkit/tabs'; into the main JS/TS file;
  • Then you can use the element anywhere in your template, JSX, html etc

Keywords

none

Install

DownloadsWeekly Downloads

16

Version

1.0.3

License

MIT

Unpacked Size

554 kB

Total Files

84

Last publish

Collaborators

  • uiwebkit