@teammates/consolonia 0.3.1 → 0.3.3
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 +48 -48
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,48 +1,48 @@
|
|
|
1
|
-
# @teammates/consolonia
|
|
2
|
-
|
|
3
|
-
> Part of the [teammates](https://github.com/Stevenic/teammates) monorepo.
|
|
4
|
-
|
|
5
|
-
Terminal UI rendering engine inspired by Consolonia. Pixel-level compositing with ANSI output.
|
|
6
|
-
|
|
7
|
-
## Quick Start
|
|
8
|
-
|
|
9
|
-
```bash
|
|
10
|
-
npm install @teammates/consolonia
|
|
11
|
-
```
|
|
12
|
-
|
|
13
|
-
## Features
|
|
14
|
-
|
|
15
|
-
- Pixel-level terminal buffer with foreground/background compositing
|
|
16
|
-
- Box-drawing character merging (single, double, mixed)
|
|
17
|
-
- Layout system: Box, Row, Column, Stack with constraint-based sizing
|
|
18
|
-
- Clipping regions for nested drawing contexts
|
|
19
|
-
- Widget library: Border, Panel, Text, TextInput, ScrollView, ChatView, Markdown, Syntax
|
|
20
|
-
- Styled text with inline markup (`*bold*`, `_italic_`, `` `code` ``, `~dim~`)
|
|
21
|
-
- Input processing: keyboard, mouse, paste detection, escape sequences
|
|
22
|
-
- ANSI output with dirty-region rendering (only redraws what changed)
|
|
23
|
-
|
|
24
|
-
## Architecture
|
|
25
|
-
|
|
26
|
-
```
|
|
27
|
-
src/
|
|
28
|
-
pixel/ # Buffer, Pixel, Color, Symbol, Foreground, Background
|
|
29
|
-
layout/ # Box, Row, Column, Stack, Control (constraint solver)
|
|
30
|
-
drawing/ # DrawingContext, Clip
|
|
31
|
-
render/ # RenderTarget, Regions (dirty tracking)
|
|
32
|
-
widgets/ # Border, Panel, Text, TextInput, ScrollView, ChatView, Markdown, Syntax
|
|
33
|
-
input/ # Processor, Matchers (text, escape, mouse, paste)
|
|
34
|
-
ansi/ # Escape codes, Output, Strip
|
|
35
|
-
styled.ts # Inline markup parser
|
|
36
|
-
app.ts # Application lifecycle
|
|
37
|
-
index.ts # Public API
|
|
38
|
-
```
|
|
39
|
-
|
|
40
|
-
## Testing
|
|
41
|
-
|
|
42
|
-
```bash
|
|
43
|
-
npm test
|
|
44
|
-
```
|
|
45
|
-
|
|
46
|
-
## Requirements
|
|
47
|
-
|
|
48
|
-
- Node.js >= 20
|
|
1
|
+
# @teammates/consolonia
|
|
2
|
+
|
|
3
|
+
> Part of the [teammates](https://github.com/Stevenic/teammates) monorepo.
|
|
4
|
+
|
|
5
|
+
Terminal UI rendering engine inspired by Consolonia. Pixel-level compositing with ANSI output.
|
|
6
|
+
|
|
7
|
+
## Quick Start
|
|
8
|
+
|
|
9
|
+
```bash
|
|
10
|
+
npm install @teammates/consolonia
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
## Features
|
|
14
|
+
|
|
15
|
+
- Pixel-level terminal buffer with foreground/background compositing
|
|
16
|
+
- Box-drawing character merging (single, double, mixed)
|
|
17
|
+
- Layout system: Box, Row, Column, Stack with constraint-based sizing
|
|
18
|
+
- Clipping regions for nested drawing contexts
|
|
19
|
+
- Widget library: Border, Panel, Text, TextInput, ScrollView, ChatView, Markdown, Syntax
|
|
20
|
+
- Styled text with inline markup (`*bold*`, `_italic_`, `` `code` ``, `~dim~`)
|
|
21
|
+
- Input processing: keyboard, mouse, paste detection, escape sequences
|
|
22
|
+
- ANSI output with dirty-region rendering (only redraws what changed)
|
|
23
|
+
|
|
24
|
+
## Architecture
|
|
25
|
+
|
|
26
|
+
```
|
|
27
|
+
src/
|
|
28
|
+
pixel/ # Buffer, Pixel, Color, Symbol, Foreground, Background
|
|
29
|
+
layout/ # Box, Row, Column, Stack, Control (constraint solver)
|
|
30
|
+
drawing/ # DrawingContext, Clip
|
|
31
|
+
render/ # RenderTarget, Regions (dirty tracking)
|
|
32
|
+
widgets/ # Border, Panel, Text, TextInput, ScrollView, ChatView, Markdown, Syntax
|
|
33
|
+
input/ # Processor, Matchers (text, escape, mouse, paste)
|
|
34
|
+
ansi/ # Escape codes, Output, Strip
|
|
35
|
+
styled.ts # Inline markup parser
|
|
36
|
+
app.ts # Application lifecycle
|
|
37
|
+
index.ts # Public API
|
|
38
|
+
```
|
|
39
|
+
|
|
40
|
+
## Testing
|
|
41
|
+
|
|
42
|
+
```bash
|
|
43
|
+
npm test
|
|
44
|
+
```
|
|
45
|
+
|
|
46
|
+
## Requirements
|
|
47
|
+
|
|
48
|
+
- Node.js >= 20
|
package/package.json
CHANGED