@ignifx/ui 0.21.0 → 0.22.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md ADDED
@@ -0,0 +1,23 @@
1
+ # @ignifx/ui
2
+
3
+ ignifx UI: a DOM overlay over the canvas with named layers for menus, HUDs and dialogs in any web framework, focus routing, and GPU-drawn world and HUD text for the cases the DOM cannot cover.
4
+
5
+ Part of [ignifx](https://ignifx.com), a code-first TypeScript game engine for WebGPU-capable browsers and Electron. The engine is pre-1.0: minor releases may include breaking changes.
6
+
7
+ ## Install
8
+
9
+ ```sh
10
+ pnpm add @ignifx/ui @ignifx/core
11
+ ```
12
+
13
+ `@ignifx/input` is an optional peer, needed only for the virtual joystick and button.
14
+ `@babylonjs/lite` is a peer dependency at the version `@ignifx/core` pins; pnpm and npm install it for you.
15
+ The `ignifx` umbrella package re-exports this package.
16
+
17
+ ## Documentation
18
+
19
+ The package ships its guide as an agent skill: `skills/ui/SKILL.md` (`node_modules/@ignifx/ui/skills/ui/SKILL.md` once installed). It covers setup, the main APIs, recipes and gotchas.
20
+
21
+ ## License
22
+
23
+ Apache-2.0 © Astrum Forge Studios
package/dist/index.d.ts CHANGED
@@ -1169,10 +1169,10 @@ export declare function uiError(code: UiErrorCode, message: string, options?: Ui
1169
1169
  *
1170
1170
  * ## Headless
1171
1171
  *
1172
- * Everything registers headlessly. With no DOM canvas the host is inert (`13-ui.md` §1's
1173
- * "the host hides itself in headless mode"*, read through `07-rendering.md` §6's rule that a
1174
- * headless member is a documented no-op rather than a throw), no text renderer is created, and the
1175
- * `PreRender` system still runs — so `WorldText` keeps its state and a test asserts on it.
1172
+ * Everything registers headlessly. With no DOM canvas the host is absent (`13-ui.md` §6:
1173
+ * `app.ui.root` is `null`, and a headless member is a documented no-op rather than a throw), no
1174
+ * text renderer is created, and the `PreRender` system still runs — so `WorldText` keeps its state
1175
+ * and a test asserts on it.
1176
1176
  */
1177
1177
  /**
1178
1178
  * What `ui()` accepts. Every field that names a settings value overrides the matching `ui` section
package/dist/index.js CHANGED
@@ -3073,7 +3073,7 @@ function worldTextSchema() {
3073
3073
  *
3074
3074
  * @public
3075
3075
  */
3076
- const VERSION = "0.21.0";
3076
+ const VERSION = "0.22.0";
3077
3077
  //#endregion
3078
3078
  //#region src/world/anchor-math.ts
3079
3079
  /**