@tuidom/core 0.1.0 → 0.2.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 +27 -0
- package/package.json +1 -1
package/README.md
ADDED
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
# @tuidom/core
|
|
2
|
+
|
|
3
|
+
The core of [TUIDom](https://github.com/tuidom/tuidom), a DOM-like terminal UI
|
|
4
|
+
engine: element tree, flex layout, styles cascade, events/focus, grid rendering
|
|
5
|
+
with ANSI diffing, input parsing (incl. the Kitty protocol) and the
|
|
6
|
+
`ITerminalBackend` contract.
|
|
7
|
+
|
|
8
|
+
> ⚠️ Experimental — the API is unstable, deep imports expose internals on purpose.
|
|
9
|
+
|
|
10
|
+
```sh
|
|
11
|
+
npm install @tuidom/core @tuidom/elements @tuidom/terminal-backend
|
|
12
|
+
```
|
|
13
|
+
|
|
14
|
+
Everything is imported via deep paths (requires `moduleResolution` `node16`,
|
|
15
|
+
`nodenext` or `bundler`):
|
|
16
|
+
|
|
17
|
+
```ts
|
|
18
|
+
import { TuiApplication } from "@tuidom/core/dom/tuiApplication";
|
|
19
|
+
import { TUIElement, RenderContext } from "@tuidom/core/dom/tuiElement";
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
`TuiApplication` owns the frame loop (layout → styles → damage → ANSI diff);
|
|
23
|
+
widgets subclass `TUIElement` and draw through `RenderContext`. Ready-made
|
|
24
|
+
widgets live in `@tuidom/elements`, the real terminal backend in
|
|
25
|
+
`@tuidom/terminal-backend`.
|
|
26
|
+
|
|
27
|
+
Full guide: <https://github.com/tuidom/tuidom/blob/main/GUIDE.md>
|
package/package.json
CHANGED