@drawcall/uikitml

中文文档
0.1.8发布于 2026/07/30TypeScriptES Module构建来源已验证近 30 天下载 2.5万

UIKitML logo

原始使用文档
文档目录4 节
  1. What It Is
  2. Why
  3. Quick Start
  4. Custom TTF fonts

UIKitML logo

UIKitML

Generate immersive 3D interfaces for Three.js, React Three Fiber, IWSDK, and more with HTML syntax. Perfect for AI workflows.

npx skills add drawcall-ai/uikitml

What It Is

UIKitML is a small HTML-like format for spatial UI. AI agents can write it, validate it, preview it, and turn it into real 3D interface code.

prompt / Pencil design / .pen file
  -> .uikitml
  -> PNG preview
  -> Three.js / React Three Fiber / IWSDK / more

Use it for AI-generated XR panels, dashboards, controls, and design-to-code workflows.

Why

  • Strict markup, so agents get clear errors.
  • Built-in Lucide, default, Horizon, and immersive UI references.
  • Works well with Pencil: inspect a design, generate UIKitML, render, compare, convert.

Quick Start

uikitml validate ./screen.uikitml --kit horizon
uikitml render ./screen.uikitml --kit horizon --out screen.png
uikitml convert ./screen.uikitml --kit horizon --name Screen --out Screen.tsx
uikitml convert ./screen.uikitml --to three --kit horizon --name createScreen --out screen.ts

Code:

import { parse, generate } from "@drawcall/uikitml";

const result = parse("<div><h1>Hello XR</h1></div>");
if (result.success) generate(result.ast);

Custom TTF fonts

Declare runtime TTF fonts with CSS @font-face, then use the family name in attributes, inline styles, or stylesheet rules:

<style>
  @font-face {
    font-family: "Brand Sans";
    src: url("/fonts/BrandSans-Regular.ttf");
    font-weight: 400;
  }

  @font-face {
    font-family: "Brand Sans";
    src: url("/fonts/BrandSans-Bold.ttf") format("truetype");
    font-weight: 700;
  }

  .title { font-family: "Brand Sans"; font-weight: 700; }
</style>

<h1 class="title">Launch ready</h1>

UIKitML supports .ttf URLs and the CSS font-family, src, and font-weight descriptors. font-weight defaults to normal. Runtime and vanilla Three.js conversion use TTFLoader. React conversion uses useTTF and requires a Suspense boundary.

See the minimal editor source for a working multiple-weight example.

版本与发布记录

@drawcall/uikitml 共发布 8 个版本,首次发布于 2026/05/16;过去 12 个月发布了 8 个版本。最新版本附带 npm provenance 构建来源证明,可追溯到公开的 CI 构建记录。

版本发布日期距今
0.1.8latest2026/07/303 个月前
0.1.72026/06/254 个月前
0.1.62026/06/025 个月前
0.1.52026/05/285 个月前
0.1.42026/05/285 个月前
0.1.32026/05/275 个月前

关于 @drawcall/uikitml 的常见问题

如何安装 @drawcall/uikitml?

在项目目录运行 npm install @drawcall/uikitml,或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖:@pmndrs/uikit(^1.0.71)、three(>=0.162)。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖,Yarn 需要手动安装。它还提供命令行工具 uikitml,可以用 npx uikitml 直接运行。

@drawcall/uikitml 支持 TypeScript 吗?

支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。

@drawcall/uikitml 支持 ESM 还是 CommonJS?

以 ES Module 形式发布,推荐使用 import 引入。在 CommonJS 项目中,Node.js 20.19+ / 22.12+ 可以直接 require() 不含顶层 await 的 ES Module,更早的版本需要改用动态 import()。

@drawcall/uikitml 可以商用吗?

@drawcall/uikitml 使用 未声明 许可。package.json 没有声明许可证。没有许可证的代码默认保留全部权利,商用前请联系作者或查看仓库中的 LICENSE 文件。以上为概括,不构成法律意见,请以许可原文为准。

@drawcall/uikitml 的下载量有多少?

根据 npm 官方下载统计,@drawcall/uikitml 在 2026/10/13 – 2026/11/11 这 30 天内被下载 25,267 次,日均约 842 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@drawcall/uikitml 还在维护吗?

最新版本 0.1.8 发布于 2026/07/30(3 个月前);至今共发布 8 个版本,其中过去 12 个月发布了 8 个;首次发布于 2026/05/16。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。