Getting Started

Welcome to the documentation for @jimka/typescript-ui.

This site is under construction. The single-page reference in the project README covers everything until guide pages are migrated here.

Installation

npm install @jimka/typescript-ui

Bootstrap

import { Body, Window, ThemeManager, DefaultTheme } from '@jimka/typescript-ui/core';
import { Button } from '@jimka/typescript-ui/component/button';
ThemeManager.setTheme(DefaultTheme);

const win = Window('Hello');
win.show();

Components and layout managers are callable — Window('Hello') works without new. Most configuration that has a matching setter (setSize, setBackgroundColor, ...) can also be passed via a trailing options bag, e.g. Panel({ layoutManager: HBox(), backgroundColor: '#222', components: [Text('hi')] }). See Mental model — JSX-shaped, without JSX for the design rationale.

Next steps

• Concepts — the framework's mental model.
• Components — per-component reference.
• Layouts — the layout managers.
• API Reference — generated TypeDoc output.