https://github.com/siddeshwarnavink/kyte

A Javascript library for building Widgets.
https://github.com/siddeshwarnavink/kyte

javascript-library widget-library

Last synced: 8 months ago
JSON representation

A Javascript library for building Widgets.

• Host: GitHub
• URL: https://github.com/siddeshwarnavink/kyte
• Owner: siddeshwarnavink
• Created: 2021-01-05T23:44:35.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2022-10-19T15:18:45.000Z (over 3 years ago)
• Last Synced: 2025-03-13T08:35:14.270Z (about 1 year ago)
• Topics: javascript-library, widget-library
• Language: JavaScript
• Homepage:
• Size: 427 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# Kyte.js

![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg) ![CI badge](https://github.com/siddeshwarnavink/kyte/workflows/CI/badge.svg) ![PRs status](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)

A Javascript library for building Widgets.

[VIEW DOCUMENTATION](https://github.com/siddeshwarnavink/kyte/wiki/Core-concepts)

## Installation

### Install as a package

This is the recommended way to use Kyte. To install Kyte you have to install it as dependency

```

npm install --save kyte-js

```

Now you get access to Kyte.js features as follows.

```js

import Kyte, { Widget } from 'kyte-js';

```

#### Use the CDN

You can simply use the CDN to get started with Kyte. Although, it is recommended to install Kyte as a package and use it in case of a real app.

```html

```

## Documentation

[View the documentation](https://github.com/siddeshwarnavink/kyte/wiki/Core-concepts) to know how to use kyte in your project

## Examples

You can find several example code in the ```examples``` folder. Here is a simple hello world example.

```js

import { Widget } from 'kyte-js';

class App extends Widget {

    template = `

        
Hello to Kyte.js

    `;

}

```


This example will render "Hello to Kyte.js".

## Contributing

Contribution helps in making this library more stable. You can contribute to this library if you find any bugs or if you feel some things can be improved. But make sure that you read the [Contributing guidelines](https://github.com/siddeshwarnavink/kyte/wiki/Contributing-guidelines) first.