nek-ui

Nek-ui is a work-in-progress UI component library based on the RegularJS framework, made by Kaola FED. It ships as both a browser-ready bundle on unpkg and an npm package, giving developers a set of reusable interface elements that follow conventions inspired by Ant Design and Element.

What is nek-ui?

Nek-ui is a collection of UI components built on RegularJS 0.4.3. The library is distributed via unpkg for direct browser use and through npm under the package name nek-ui, which exposes a NEKUI object when required. It is not yet stable, as the repository is marked WIP, and its documentation is available at the Kaola FED docs site.

Key Features

• RegularJS foundation — Components are implemented with RegularJS 0.4.3, a lightweight template-based framework, and the npm install command locks to [email protected].
• CDN and npm distribution — The browser build is available from unpkg with separate CSS, runtime (regular.min.js), and minified JS files; the Node build is installed with npm i [email protected] nek-ui -S.
• MIT license — The project is released under the MIT license, allowing free use and modification.
• Documentation site and wiki — A hosted documentation site and a GitHub wiki cover usage and development; the docs directory can be run locally with npm run dev.
• Design influences — The library is forked from Regular UI and borrows documentation style from Vue's docs, with ideas from Ant Design and Element.
• Actively tracked on GitHub — The repository has 44 stars and is managed by the Kaola FED organization.

Who is it for?

• RegularJS developers — Anyone building a web app with RegularJS can drop in nek-ui components instead of writing UI code from scratch.
• Front-end teams — Teams that want a consistent set of interface elements with documentation can use nek-ui as their component baseline.
• Open-source contributors — Developers interested in UI libraries can study or extend an MIT-licensed codebase that combines ideas from multiple design systems.

What can you do with nek-ui?

• Browser apps — Link to the unpkg CSS and JS files to start using components directly in an HTML page without any build step.
• Node-based workflows — Install the npm package and require('nek-ui') to integrate components into a CommonJS-oriented project.
• Local documentation — Run cd doc && npm i then npm run dev to view and develop against the docs site.

FAQ

Is nek-ui free?

Yes, nek-ui uses the MIT license, so it is free to use, copy, modify, and distribute. No commercial restrictions are stated.

Is nek-ui production-ready?

The repository is labeled WIP (work in progress), so it should be treated as unstable. APIs may change, and there is no guarantee of full test coverage.

How do I install nek-ui?

Install via npm with npm i [email protected] nek-ui -S or load the distributed files from unpkg: the default CSS, regular.min.js, and nek-ui.min.js.