๐ TypeDocs ย ยทย API Reference

this.gui
Generative User Interfaces
A collection of components and building blocks for UI Generation.
Scaffold a new app
npx this.gui my-app
cd my-app
npm install
npm run dev
Install
npm install this.gui
Add this.me only if you want namespace-backed state:
npm install this.me
Composition
this.gui separates five concerns: syntax, form, composition, routes, identity.
Theme โ Layout โ view
Theme is the visual environment. Layout is the chrome โ topbar, sidebar, footer. Your view fills the content area.
import { Theme, Layout } from 'this.gui';
import { Typography, Button } from 'this.gui/atoms';
import { Hero, Stack } from 'this.gui/molecules';
function Home() {
return (
<Hero height="100vh" mode="left" padding=>
<Stack spacing={2} alignItems="flex-start">
<Typography variant="h1">My App</Typography>
<Button variant="contained" size="large">Get started</Button>
</Stack>
</Hero>
);
}
export default function App() {
return (
<Theme initialThemeId="neurons.me">
<Layout
TopBar=
LeftBar=
>
<Home />
</Layout>
</Theme>
);
}
Routes + Identity
Use this.me when your app should be declared as a namespace-backed identity. The app manifest is written into .me, and views read from that namespace.
// app.ts โ declare the app as a namespace context
export default {
id: 'my-app',
namespace: 'apps.my-app',
title: 'My App',
theme: 'neurons.me',
views: { home: Home },
};
// main.tsx
import ME from 'this.me';
import { mountApp } from 'this.gui/runtime';
import app from './app';
mountApp({ me: new ME() as any, app, target: '#root' });
// views/Home.tsx โ reads from .me namespace
import { Typography, Button } from 'this.gui/atoms';
import { Hero, Stack } from 'this.gui/molecules';
import { useMeValue } from 'this.gui/react';
export default function Home() {
const title = useMeValue<string>('apps.my-app.manifest.title') || 'My App';
return (
<Hero height="100vh" mode="left" padding=>
<Stack spacing={2} alignItems="flex-start">
<Typography variant="h1">{title}</Typography>
<Button variant="contained" size="large">Get started</Button>
</Stack>
</Hero>
);
}
Package Surface
Components are organized as atoms โ molecules โ compounds โ primitives compose into patterns, patterns compose into features.
| Entry | What it gives you |
|---|---|
this.gui |
Theme, Layout, ThemeLauncher |
this.gui/atoms |
Primitives โ Box, Button, Typography, Icon, Avatar, โฆ |
this.gui/molecules |
Compositions โ Hero, Stack, Page, โฆ |
this.gui/compounds |
Feature panels built from molecules |
this.gui/react |
.me bridge โ MeRuntimeProvider, useMeValue, useMeAction |
this.gui/runtime |
mountApp, declareApp, writeMeValue, readMeValue |
Docs

MIT License. โด suiGn / neurons.me