/orbiton

A JavaScript library for building Browser User Interfaces

Primary LanguageJavaScriptMIT LicenseMIT

Npm package total downloads Npm package total downloads

A Javascript library for building Browser User Interfaces. Orbiton JS is a component base javascript rendering library for creating User Interfaces in the browser. Orbiton was originally developed by Beingana Jim Junior as a rendering engine for his small library for creating video elements. He later decided to separate it from the main package and in order to make it reusable in other projects. That is how it came about.

Why use Orbiton

Most developers ask themselves why use a new young library like Orbiton.

  • Light Weight: One of the greatest advantage of Orbiton is that its lightweight. This assures you that your app has fast page loads since most of the chunk is from just your own code.
  • Close To Dom: This is another advantage of Orbiton. Being close to the Dom means that the library will not have to carry out many functions in order to update the Dom making the app feel fast for the user.
  • Fast: Orbiton JS was written with speed in mind. This users have a great user experience while using your application.
  • Modern: Orbiton JS is among the youngest libraries and so it utilizes modern JavaScript removing legacy code from your apps. Most modern browsers like chrome recommend this.

Installation

Installing Orbiton is Quite simple. You can use Orbiton to build full Application or just small parts of your website.

Using CDN

Orbiton JS prefers usage of jsDeliver as the default CDN for adding Orbiton to your website since its faster. In case you want to quickly, get started in your browser. Add a script tag with the following links.

<!-- If you are in development mode -->
<script src="https://cdn.jsdeliver.net/npm/orbiton/umd/orbitonjs.development.js" crossorigin></script>
<!-- For production use the optimized and minified version  -->
<script src="https://cdn.jsdeliver.net/npm/orbiton/umd/orbitonjs.production.min.js" crossorigin></script>

Using Node JS

If you are using Node to build a your web app run this in the command line

# yarn
yarn add orbiton

# npm
npm install orbiton

If you want a quick start guide you can visit the official Quick Start Guide.

Usage

Using Orbiton is easy. All you have to do is import Orbiton and use JSX to create your app. Visit the Orbiton JS documentation here to Learn how to build Apps in Orbiton JS.

const Button = <button onClick={() => { alert('Clicked') } } >Click me</button>

Orbiton.append(Button, document.getElementById('root'))

Here are some important links that you might find usefull if you are gettig started with Orbiton JS.

Contributing

Anybody willing to contribute to the development of this library can help by contibuting to the repository on Github.

Some Important links for Contributors.


License

MIT License