Package Exports

@tinijs/core
@tinijs/core/src/public-api.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@tinijs/core) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

TiniJS Core

The core module of the TiniJS framework.

It uses the Lit library under the hood.

Install

To manually install the module: npm i @tinijs/core

It is recommended to download the Skeleton for a ready-to-use structured project.

For more, please visit: https://tinijs.dev (TODO)

Usage

Create an app (ex. app.ts):

import {html} from 'lit';
import {TiniComponent, App} from '@tinijs/core';

@App()
export class AppRoot extends TiniComponent {
  protected render() {
    return html`...`;
  }
}

Create a component:

import {html} from 'lit';
import {TiniComponent, Component, Input} from '@tinijs/core';

@Component()
export class AppHelloComponent extends TiniComponent {
  static readonly defaultTagName = 'app-hello';

  @Input() name?: string;

  protected render() {
    return html`<h1>Hello ${this.name}! 👋</h1>`;
  }
}

Create a page:

import {html} from 'lit';
import {TiniComponent, Page} from '@tinijs/core';

@Page({
  name: 'app-page-404'
})
export class AppPage404 extends TiniComponent {
  protected render() {
    return html`<h1>Oops 🫣!</h1>`;
  }
}

For more detail, please visit the docs: https://tinijs.dev/docs (TODO)

API

// TODO

Developement

Create a home for TiniJS: mkdir TiniJS && cd TiniJS
Fork the repo
Install dependencies: cd core && npm i
Make changes & preview locally: npm run build && npm pack
Push changes & create a PR 👌

License

@tinijs/core is released under the MIT license.