Documentation

Getting Started

Choose Your Path

TypeScript / Web Developers

Start with the @littleui/sdk npm package. Author layouts programmatically or consume the web runtime.

View on npm →

Game Developers (Unreal 5.3–5.7+)

Download the Pro plugin or try the free Unreal demo.

Download Demo →

Layout Specification

v1.0 Schema — frozen, no breaking changes in 1.x

LittleUI layouts are pure JSON. The same file renders in Unreal, on Canvas, or any future host.

{
  "id": "root",
  "type": "box",
  "width": 1280,
  "height": 720,
  "backgroundColor": "#0A0E27",
  "children": [
    { "id": "title", "type": "text", "text": "Hello World", "fontSize": 32, "textColor": "#FFFFFF" },
    { "id": "btn", "type": "button", "text": "Click Me", "width": 200, "height": 60 }
  ]
}

Full spec: docs/LAYOUT_SPEC.md

SDK Reference

LayoutBuilder API

import { LayoutBuilder } from '@littleui/sdk';

const layout = new LayoutBuilder()
  .box({ id: 'root', width: 1280, height: 720 })
    .text({ id: 'title', text: 'Welcome', fontSize: 32 })
    .button({ id: 'btn', text: 'Play', width: 200, height: 60 })
  .end()
  .build();

Full API on npm.

Web Runtime

Canvas Rendering

import { CanvasRenderer } from '@littleui/web';

const renderer = new CanvasRenderer(canvas, layout);
renderer.onButtonClick('btn', (id) => console.log('clicked:', id));
renderer.start();

Renders to HTML5 Canvas in any browser. Hover and click handling included.

FAQ

Is LittleUI free?

Yes. Core and TypeScript SDK are MIT-licensed. The Unreal Pro plugin is $499 perpetual.

Can I use this in production?

Yes. v1.0 format is frozen and production-ready.

What engines are supported?

v1.0: Unreal 5.3–5.7+ and web Canvas. v1.5+: Unity, Godot. See ROADMAP.md.

Need Help?

Community support is free. Pro customers get priority email support.

alexander@littleui.se →