@cascadetui/core 0.1.1
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/3d/SpriteResourceManager.d.ts +74 -0
- package/3d/SpriteUtils.d.ts +13 -0
- package/3d/TextureUtils.d.ts +24 -0
- package/3d/ThreeRenderable.d.ts +40 -0
- package/3d/WGPURenderer.d.ts +61 -0
- package/3d/animation/ExplodingSpriteEffect.d.ts +71 -0
- package/3d/animation/PhysicsExplodingSpriteEffect.d.ts +76 -0
- package/3d/animation/SpriteAnimator.d.ts +124 -0
- package/3d/animation/SpriteParticleGenerator.d.ts +62 -0
- package/3d/canvas.d.ts +44 -0
- package/3d/index.d.ts +12 -0
- package/3d/physics/PlanckPhysicsAdapter.d.ts +19 -0
- package/3d/physics/RapierPhysicsAdapter.d.ts +19 -0
- package/3d/physics/physics-interface.d.ts +27 -0
- package/3d.d.ts +2 -0
- package/3d.js +34041 -0
- package/3d.js.map +155 -0
- package/LICENSE +21 -0
- package/NativeSpanFeed.d.ts +41 -0
- package/README.md +62 -0
- package/Renderable.d.ts +334 -0
- package/animation/Timeline.d.ts +126 -0
- package/ansi.d.ts +13 -0
- package/assets/javascript/highlights.scm +205 -0
- package/assets/javascript/tree-sitter-javascript.wasm +0 -0
- package/assets/markdown/highlights.scm +150 -0
- package/assets/markdown/injections.scm +27 -0
- package/assets/markdown/tree-sitter-markdown.wasm +0 -0
- package/assets/markdown_inline/highlights.scm +115 -0
- package/assets/markdown_inline/tree-sitter-markdown_inline.wasm +0 -0
- package/assets/typescript/highlights.scm +604 -0
- package/assets/typescript/tree-sitter-typescript.wasm +0 -0
- package/assets/zig/highlights.scm +284 -0
- package/assets/zig/tree-sitter-zig.wasm +0 -0
- package/buffer.d.ts +107 -0
- package/console.d.ts +140 -0
- package/edit-buffer.d.ts +98 -0
- package/editor-view.d.ts +73 -0
- package/index-jx194wn1.js +17723 -0
- package/index-jx194wn1.js.map +61 -0
- package/index.d.ts +18 -0
- package/index.js +12210 -0
- package/index.js.map +49 -0
- package/lib/KeyHandler.d.ts +61 -0
- package/lib/RGBA.d.ts +25 -0
- package/lib/ascii.font.d.ts +508 -0
- package/lib/border.d.ts +49 -0
- package/lib/bunfs.d.ts +7 -0
- package/lib/clipboard.d.ts +29 -0
- package/lib/data-paths.d.ts +26 -0
- package/lib/debounce.d.ts +42 -0
- package/lib/env.d.ts +42 -0
- package/lib/extmarks-history.d.ts +17 -0
- package/lib/extmarks.d.ts +89 -0
- package/lib/hast-styled-text.d.ts +17 -0
- package/lib/index.d.ts +18 -0
- package/lib/keymapping.d.ts +25 -0
- package/lib/objects-in-viewport.d.ts +24 -0
- package/lib/output.capture.d.ts +24 -0
- package/lib/parse.keypress-kitty.d.ts +2 -0
- package/lib/parse.keypress.d.ts +26 -0
- package/lib/parse.mouse.d.ts +30 -0
- package/lib/queue.d.ts +15 -0
- package/lib/renderable.validations.d.ts +12 -0
- package/lib/scroll-acceleration.d.ts +43 -0
- package/lib/selection.d.ts +63 -0
- package/lib/singleton.d.ts +7 -0
- package/lib/stdin-buffer.d.ts +44 -0
- package/lib/styled-text.d.ts +63 -0
- package/lib/terminal-capability-detection.d.ts +30 -0
- package/lib/terminal-palette.d.ts +43 -0
- package/lib/tree-sitter/assets/update.d.ts +11 -0
- package/lib/tree-sitter/client.d.ts +47 -0
- package/lib/tree-sitter/default-parsers.d.ts +2 -0
- package/lib/tree-sitter/download-utils.d.ts +21 -0
- package/lib/tree-sitter/index.d.ts +8 -0
- package/lib/tree-sitter/parser.worker.d.ts +1 -0
- package/lib/tree-sitter/parsers-config.d.ts +38 -0
- package/lib/tree-sitter/resolve-ft.d.ts +2 -0
- package/lib/tree-sitter/types.d.ts +81 -0
- package/lib/tree-sitter-styled-text.d.ts +14 -0
- package/lib/validate-dir-name.d.ts +1 -0
- package/lib/yoga.options.d.ts +32 -0
- package/package.json +67 -0
- package/parser.worker.js +878 -0
- package/parser.worker.js.map +12 -0
- package/post/filters.d.ts +105 -0
- package/renderables/ASCIIFont.d.ts +52 -0
- package/renderables/Box.d.ts +72 -0
- package/renderables/Code.d.ts +66 -0
- package/renderables/Diff.d.ts +135 -0
- package/renderables/EditBufferRenderable.d.ts +162 -0
- package/renderables/FrameBuffer.d.ts +16 -0
- package/renderables/Input.d.ts +67 -0
- package/renderables/LineNumberRenderable.d.ts +74 -0
- package/renderables/Markdown.d.ts +150 -0
- package/renderables/ScrollBar.d.ts +77 -0
- package/renderables/ScrollBox.d.ts +116 -0
- package/renderables/Select.d.ts +115 -0
- package/renderables/Slider.d.ts +44 -0
- package/renderables/TabSelect.d.ts +96 -0
- package/renderables/Text.d.ts +36 -0
- package/renderables/TextBufferRenderable.d.ts +105 -0
- package/renderables/TextNode.d.ts +91 -0
- package/renderables/TextTable.d.ts +130 -0
- package/renderables/Textarea.d.ts +114 -0
- package/renderables/__tests__/renderable-test-utils.d.ts +7 -0
- package/renderables/composition/VRenderable.d.ts +16 -0
- package/renderables/composition/constructs.d.ts +35 -0
- package/renderables/composition/vnode.d.ts +46 -0
- package/renderables/index.d.ts +21 -0
- package/renderables/markdown-parser.d.ts +10 -0
- package/renderer.d.ts +382 -0
- package/syntax-style.d.ts +54 -0
- package/testing/mock-keys.d.ts +80 -0
- package/testing/mock-mouse.d.ts +38 -0
- package/testing/mock-tree-sitter-client.d.ts +23 -0
- package/testing/spy.d.ts +7 -0
- package/testing/test-recorder.d.ts +61 -0
- package/testing/test-renderer.d.ts +23 -0
- package/testing.d.ts +6 -0
- package/testing.js +670 -0
- package/testing.js.map +15 -0
- package/text-buffer-view.d.ts +42 -0
- package/text-buffer.d.ts +67 -0
- package/types.d.ts +126 -0
- package/utils.d.ts +14 -0
- package/zig-structs.d.ts +155 -0
- package/zig.d.ts +351 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2025 cascade
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
import { type Pointer } from "bun:ffi";
|
|
2
|
+
import type { NativeSpanFeedOptions } from "./zig-structs";
|
|
3
|
+
export type { GrowthPolicy, NativeSpanFeedOptions, NativeSpanFeedStats } from "./zig-structs";
|
|
4
|
+
export type DataHandler = (data: Uint8Array) => void | Promise<void>;
|
|
5
|
+
/**
|
|
6
|
+
* Zero-copy wrapper over Zig memory; not a full stream interface.
|
|
7
|
+
*/
|
|
8
|
+
export declare class NativeSpanFeed {
|
|
9
|
+
static create(options?: NativeSpanFeedOptions): NativeSpanFeed;
|
|
10
|
+
static attach(streamPtr: bigint | number, _options?: NativeSpanFeedOptions): NativeSpanFeed;
|
|
11
|
+
readonly streamPtr: Pointer;
|
|
12
|
+
private readonly lib;
|
|
13
|
+
private readonly eventHandler;
|
|
14
|
+
private chunkMap;
|
|
15
|
+
private chunkSizes;
|
|
16
|
+
private dataHandlers;
|
|
17
|
+
private errorHandlers;
|
|
18
|
+
private drainBuffer;
|
|
19
|
+
private stateBuffer;
|
|
20
|
+
private closed;
|
|
21
|
+
private destroyed;
|
|
22
|
+
private draining;
|
|
23
|
+
private pendingDataAvailable;
|
|
24
|
+
private pendingClose;
|
|
25
|
+
private closing;
|
|
26
|
+
private pendingAsyncHandlers;
|
|
27
|
+
private inCallback;
|
|
28
|
+
private closeQueued;
|
|
29
|
+
private constructor();
|
|
30
|
+
private ensureDrainBuffer;
|
|
31
|
+
onData(handler: DataHandler): () => void;
|
|
32
|
+
onError(handler: (code: number) => void): () => void;
|
|
33
|
+
close(): void;
|
|
34
|
+
private processPendingClose;
|
|
35
|
+
private performClose;
|
|
36
|
+
private finalizeDestroy;
|
|
37
|
+
private handleEvent;
|
|
38
|
+
private decrementRefcount;
|
|
39
|
+
private drainOnce;
|
|
40
|
+
drainAll(): void;
|
|
41
|
+
}
|
package/README.md
ADDED
|
@@ -0,0 +1,62 @@
|
|
|
1
|
+
# Cascade Core
|
|
2
|
+
|
|
3
|
+
Cascade is a native terminal UI core written in Zig with TypeScript bindings. The native core exposes a C ABI and can be used from any language. It is an extensible core with a focus on correctness, stability, and high performance. It provides a component-based architecture with flexible layout capabilities, allowing you to create complex terminal applications.
|
|
4
|
+
|
|
5
|
+
## Documentation
|
|
6
|
+
|
|
7
|
+
- [Getting Started](docs/getting-started.md) - API and usage guide
|
|
8
|
+
- [Development Guide](docs/development.md) - Building, testing, and contributing
|
|
9
|
+
- [Tree-Sitter](docs/tree-sitter.md) - Syntax highlighting integration
|
|
10
|
+
- [Renderables vs Constructs](docs/renderables-vs-constructs.md) - Understanding the component model
|
|
11
|
+
- [Environment Variables](docs/env-vars.md) - Configuration options
|
|
12
|
+
|
|
13
|
+
## Install
|
|
14
|
+
|
|
15
|
+
```bash
|
|
16
|
+
bun install @cascadetui/core
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
## Build
|
|
20
|
+
|
|
21
|
+
```bash
|
|
22
|
+
bun run build
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
This creates platform-specific libraries that are automatically loaded by the TypeScript layer.
|
|
26
|
+
|
|
27
|
+
## Examples
|
|
28
|
+
|
|
29
|
+
```bash
|
|
30
|
+
bun install
|
|
31
|
+
bun run src/examples/index.ts
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
## Benchmarks
|
|
35
|
+
|
|
36
|
+
Run native performance benchmarks:
|
|
37
|
+
|
|
38
|
+
```bash
|
|
39
|
+
bun run bench:native
|
|
40
|
+
```
|
|
41
|
+
|
|
42
|
+
See [src/zig/bench.zig](src/zig/bench.zig) for available options like `--filter` and `--mem`.
|
|
43
|
+
|
|
44
|
+
NativeSpanFeed TypeScript benchmarks:
|
|
45
|
+
|
|
46
|
+
- [src/benchmark/native-span-feed-benchmark.md](src/benchmark/native-span-feed-benchmark.md)
|
|
47
|
+
|
|
48
|
+
## CLI Renderer
|
|
49
|
+
|
|
50
|
+
### Renderables
|
|
51
|
+
|
|
52
|
+
Renderables are hierarchical objects that can be positioned, nested, styled and rendered to the terminal:
|
|
53
|
+
|
|
54
|
+
```typescript
|
|
55
|
+
import { createCliRenderer, TextRenderable } from "@cascadetui/core"
|
|
56
|
+
|
|
57
|
+
const renderer = await createCliRenderer()
|
|
58
|
+
|
|
59
|
+
const obj = new TextRenderable(renderer, { id: "my-obj", content: "Hello, world!" })
|
|
60
|
+
|
|
61
|
+
renderer.root.add(obj)
|
|
62
|
+
```
|
package/Renderable.d.ts
ADDED
|
@@ -0,0 +1,334 @@
|
|
|
1
|
+
import { EventEmitter } from "events";
|
|
2
|
+
import { type Node as YogaNode } from "yoga-layout";
|
|
3
|
+
import { OptimizedBuffer } from "./buffer";
|
|
4
|
+
import type { KeyEvent, PasteEvent } from "./lib/KeyHandler";
|
|
5
|
+
import type { Selection } from "./lib/selection";
|
|
6
|
+
import { type AlignString, type FlexDirectionString, type JustifyString, type OverflowString, type PositionTypeString, type WrapString } from "./lib/yoga.options";
|
|
7
|
+
import { type VNode } from "./renderables/composition/vnode";
|
|
8
|
+
import type { MouseEvent } from "./renderer";
|
|
9
|
+
import type { RenderContext } from "./types";
|
|
10
|
+
declare const BrandedRenderable: unique symbol;
|
|
11
|
+
export declare enum LayoutEvents {
|
|
12
|
+
LAYOUT_CHANGED = "layout-changed",
|
|
13
|
+
ADDED = "added",
|
|
14
|
+
REMOVED = "removed",
|
|
15
|
+
RESIZED = "resized"
|
|
16
|
+
}
|
|
17
|
+
export declare enum RenderableEvents {
|
|
18
|
+
FOCUSED = "focused",
|
|
19
|
+
BLURRED = "blurred"
|
|
20
|
+
}
|
|
21
|
+
export interface Position {
|
|
22
|
+
top?: number | "auto" | `${number}%`;
|
|
23
|
+
right?: number | "auto" | `${number}%`;
|
|
24
|
+
bottom?: number | "auto" | `${number}%`;
|
|
25
|
+
left?: number | "auto" | `${number}%`;
|
|
26
|
+
}
|
|
27
|
+
export interface BaseRenderableOptions {
|
|
28
|
+
id?: string;
|
|
29
|
+
}
|
|
30
|
+
export interface LayoutOptions extends BaseRenderableOptions {
|
|
31
|
+
flexGrow?: number;
|
|
32
|
+
flexShrink?: number;
|
|
33
|
+
flexDirection?: FlexDirectionString;
|
|
34
|
+
flexWrap?: WrapString;
|
|
35
|
+
alignItems?: AlignString;
|
|
36
|
+
justifyContent?: JustifyString;
|
|
37
|
+
alignSelf?: AlignString;
|
|
38
|
+
flexBasis?: number | "auto" | undefined;
|
|
39
|
+
position?: PositionTypeString;
|
|
40
|
+
overflow?: OverflowString;
|
|
41
|
+
top?: number | "auto" | `${number}%`;
|
|
42
|
+
right?: number | "auto" | `${number}%`;
|
|
43
|
+
bottom?: number | "auto" | `${number}%`;
|
|
44
|
+
left?: number | "auto" | `${number}%`;
|
|
45
|
+
minWidth?: number | "auto" | `${number}%`;
|
|
46
|
+
minHeight?: number | "auto" | `${number}%`;
|
|
47
|
+
maxWidth?: number | "auto" | `${number}%`;
|
|
48
|
+
maxHeight?: number | "auto" | `${number}%`;
|
|
49
|
+
margin?: number | "auto" | `${number}%`;
|
|
50
|
+
marginX?: number | "auto" | `${number}%`;
|
|
51
|
+
marginY?: number | "auto" | `${number}%`;
|
|
52
|
+
marginTop?: number | "auto" | `${number}%`;
|
|
53
|
+
marginRight?: number | "auto" | `${number}%`;
|
|
54
|
+
marginBottom?: number | "auto" | `${number}%`;
|
|
55
|
+
marginLeft?: number | "auto" | `${number}%`;
|
|
56
|
+
padding?: number | `${number}%`;
|
|
57
|
+
paddingX?: number | `${number}%`;
|
|
58
|
+
paddingY?: number | `${number}%`;
|
|
59
|
+
paddingTop?: number | `${number}%`;
|
|
60
|
+
paddingRight?: number | `${number}%`;
|
|
61
|
+
paddingBottom?: number | `${number}%`;
|
|
62
|
+
paddingLeft?: number | `${number}%`;
|
|
63
|
+
enableLayout?: boolean;
|
|
64
|
+
}
|
|
65
|
+
export interface RenderableOptions<T extends BaseRenderable = BaseRenderable> extends Partial<LayoutOptions> {
|
|
66
|
+
width?: number | "auto" | `${number}%`;
|
|
67
|
+
height?: number | "auto" | `${number}%`;
|
|
68
|
+
zIndex?: number;
|
|
69
|
+
visible?: boolean;
|
|
70
|
+
buffered?: boolean;
|
|
71
|
+
live?: boolean;
|
|
72
|
+
opacity?: number;
|
|
73
|
+
renderBefore?: (this: T, buffer: OptimizedBuffer, deltaTime: number) => void;
|
|
74
|
+
renderAfter?: (this: T, buffer: OptimizedBuffer, deltaTime: number) => void;
|
|
75
|
+
onMouse?: (this: T, event: MouseEvent) => void;
|
|
76
|
+
onMouseDown?: (this: T, event: MouseEvent) => void;
|
|
77
|
+
onMouseUp?: (this: T, event: MouseEvent) => void;
|
|
78
|
+
onMouseMove?: (this: T, event: MouseEvent) => void;
|
|
79
|
+
onMouseDrag?: (this: T, event: MouseEvent) => void;
|
|
80
|
+
onMouseDragEnd?: (this: T, event: MouseEvent) => void;
|
|
81
|
+
onMouseDrop?: (this: T, event: MouseEvent) => void;
|
|
82
|
+
onMouseOver?: (this: T, event: MouseEvent) => void;
|
|
83
|
+
onMouseOut?: (this: T, event: MouseEvent) => void;
|
|
84
|
+
onMouseScroll?: (this: T, event: MouseEvent) => void;
|
|
85
|
+
onPaste?: (this: T, event: PasteEvent) => void;
|
|
86
|
+
onKeyDown?: (key: KeyEvent) => void;
|
|
87
|
+
onSizeChange?: (this: T) => void;
|
|
88
|
+
}
|
|
89
|
+
export declare function isRenderable(obj: any): obj is Renderable;
|
|
90
|
+
export declare abstract class BaseRenderable extends EventEmitter {
|
|
91
|
+
[BrandedRenderable]: boolean;
|
|
92
|
+
private static renderableNumber;
|
|
93
|
+
protected _id: string;
|
|
94
|
+
readonly num: number;
|
|
95
|
+
protected _dirty: boolean;
|
|
96
|
+
parent: BaseRenderable | null;
|
|
97
|
+
protected _visible: boolean;
|
|
98
|
+
constructor(options: BaseRenderableOptions);
|
|
99
|
+
abstract add(obj: BaseRenderable | unknown, index?: number): number;
|
|
100
|
+
abstract remove(id: string): void;
|
|
101
|
+
abstract insertBefore(obj: BaseRenderable | unknown, anchor: BaseRenderable | unknown): void;
|
|
102
|
+
abstract getChildren(): BaseRenderable[];
|
|
103
|
+
abstract getChildrenCount(): number;
|
|
104
|
+
abstract getRenderable(id: string): BaseRenderable | undefined;
|
|
105
|
+
abstract requestRender(): void;
|
|
106
|
+
abstract findDescendantById(id: string): BaseRenderable | undefined;
|
|
107
|
+
get id(): string;
|
|
108
|
+
set id(value: string);
|
|
109
|
+
get isDirty(): boolean;
|
|
110
|
+
protected markClean(): void;
|
|
111
|
+
protected markDirty(): void;
|
|
112
|
+
destroy(): void;
|
|
113
|
+
destroyRecursively(): void;
|
|
114
|
+
get visible(): boolean;
|
|
115
|
+
set visible(value: boolean);
|
|
116
|
+
}
|
|
117
|
+
export declare abstract class Renderable extends BaseRenderable {
|
|
118
|
+
static renderablesByNumber: Map<number, Renderable>;
|
|
119
|
+
protected _isDestroyed: boolean;
|
|
120
|
+
protected _ctx: RenderContext;
|
|
121
|
+
protected _translateX: number;
|
|
122
|
+
protected _translateY: number;
|
|
123
|
+
protected _x: number;
|
|
124
|
+
protected _y: number;
|
|
125
|
+
protected _width: number | "auto" | `${number}%`;
|
|
126
|
+
protected _height: number | "auto" | `${number}%`;
|
|
127
|
+
protected _widthValue: number;
|
|
128
|
+
protected _heightValue: number;
|
|
129
|
+
private _zIndex;
|
|
130
|
+
selectable: boolean;
|
|
131
|
+
protected buffered: boolean;
|
|
132
|
+
protected frameBuffer: OptimizedBuffer | null;
|
|
133
|
+
protected _focusable: boolean;
|
|
134
|
+
protected _focused: boolean;
|
|
135
|
+
protected keypressHandler: ((key: KeyEvent) => void) | null;
|
|
136
|
+
protected pasteHandler: ((event: PasteEvent) => void) | null;
|
|
137
|
+
private _live;
|
|
138
|
+
protected _liveCount: number;
|
|
139
|
+
private _sizeChangeListener;
|
|
140
|
+
private _mouseListener;
|
|
141
|
+
private _mouseListeners;
|
|
142
|
+
private _pasteListener;
|
|
143
|
+
private _keyListeners;
|
|
144
|
+
protected yogaNode: YogaNode;
|
|
145
|
+
protected _positionType: PositionTypeString;
|
|
146
|
+
protected _overflow: OverflowString;
|
|
147
|
+
protected _position: Position;
|
|
148
|
+
protected _opacity: number;
|
|
149
|
+
private _flexShrink;
|
|
150
|
+
private renderableMapById;
|
|
151
|
+
protected _childrenInLayoutOrder: Renderable[];
|
|
152
|
+
protected _childrenInZIndexOrder: Renderable[];
|
|
153
|
+
private needsZIndexSort;
|
|
154
|
+
parent: Renderable | null;
|
|
155
|
+
private childrenPrimarySortDirty;
|
|
156
|
+
private childrenSortedByPrimaryAxis;
|
|
157
|
+
private _shouldUpdateBefore;
|
|
158
|
+
onLifecyclePass: (() => void) | null;
|
|
159
|
+
renderBefore?: (this: Renderable, buffer: OptimizedBuffer, deltaTime: number) => void;
|
|
160
|
+
renderAfter?: (this: Renderable, buffer: OptimizedBuffer, deltaTime: number) => void;
|
|
161
|
+
constructor(ctx: RenderContext, options: RenderableOptions<any>);
|
|
162
|
+
get id(): string;
|
|
163
|
+
set id(value: string);
|
|
164
|
+
get focusable(): boolean;
|
|
165
|
+
set focusable(value: boolean);
|
|
166
|
+
get ctx(): RenderContext;
|
|
167
|
+
get visible(): boolean;
|
|
168
|
+
get primaryAxis(): "row" | "column";
|
|
169
|
+
set visible(value: boolean);
|
|
170
|
+
get opacity(): number;
|
|
171
|
+
set opacity(value: number);
|
|
172
|
+
hasSelection(): boolean;
|
|
173
|
+
onSelectionChanged(selection: Selection | null): boolean;
|
|
174
|
+
getSelectedText(): string;
|
|
175
|
+
shouldStartSelection(x: number, y: number): boolean;
|
|
176
|
+
focus(): void;
|
|
177
|
+
blur(): void;
|
|
178
|
+
get focused(): boolean;
|
|
179
|
+
get live(): boolean;
|
|
180
|
+
get liveCount(): number;
|
|
181
|
+
set live(value: boolean);
|
|
182
|
+
protected propagateLiveCount(delta: number): void;
|
|
183
|
+
handleKeyPress?(key: KeyEvent): boolean;
|
|
184
|
+
handlePaste?(event: PasteEvent): void;
|
|
185
|
+
findDescendantById(id: string): Renderable | undefined;
|
|
186
|
+
requestRender(): void;
|
|
187
|
+
get translateX(): number;
|
|
188
|
+
set translateX(value: number);
|
|
189
|
+
get translateY(): number;
|
|
190
|
+
set translateY(value: number);
|
|
191
|
+
get x(): number;
|
|
192
|
+
set x(value: number);
|
|
193
|
+
get top(): number | "auto" | `${number}%` | undefined;
|
|
194
|
+
set top(value: number | "auto" | `${number}%` | undefined);
|
|
195
|
+
get right(): number | "auto" | `${number}%` | undefined;
|
|
196
|
+
set right(value: number | "auto" | `${number}%` | undefined);
|
|
197
|
+
get bottom(): number | "auto" | `${number}%` | undefined;
|
|
198
|
+
set bottom(value: number | "auto" | `${number}%` | undefined);
|
|
199
|
+
get left(): number | "auto" | `${number}%` | undefined;
|
|
200
|
+
set left(value: number | "auto" | `${number}%` | undefined);
|
|
201
|
+
get y(): number;
|
|
202
|
+
set y(value: number);
|
|
203
|
+
get width(): number;
|
|
204
|
+
set width(value: number | "auto" | `${number}%`);
|
|
205
|
+
get height(): number;
|
|
206
|
+
set height(value: number | "auto" | `${number}%`);
|
|
207
|
+
get zIndex(): number;
|
|
208
|
+
set zIndex(value: number);
|
|
209
|
+
private requestZIndexSort;
|
|
210
|
+
private ensureZIndexSorted;
|
|
211
|
+
getChildrenSortedByPrimaryAxis(): Renderable[];
|
|
212
|
+
private setupYogaProperties;
|
|
213
|
+
private setupMarginAndPadding;
|
|
214
|
+
set position(positionType: PositionTypeString | null | undefined);
|
|
215
|
+
get overflow(): OverflowString;
|
|
216
|
+
set overflow(overflow: OverflowString | null | undefined);
|
|
217
|
+
setPosition(position: Position): void;
|
|
218
|
+
private updateYogaPosition;
|
|
219
|
+
set flexGrow(grow: number | null | undefined);
|
|
220
|
+
set flexShrink(shrink: number | null | undefined);
|
|
221
|
+
set flexDirection(direction: FlexDirectionString | null | undefined);
|
|
222
|
+
set flexWrap(wrap: WrapString | null | undefined);
|
|
223
|
+
set alignItems(alignItems: AlignString | null | undefined);
|
|
224
|
+
set justifyContent(justifyContent: JustifyString | null | undefined);
|
|
225
|
+
set alignSelf(alignSelf: AlignString | null | undefined);
|
|
226
|
+
set flexBasis(basis: number | "auto" | null | undefined);
|
|
227
|
+
set minWidth(minWidth: number | `${number}%` | null | undefined);
|
|
228
|
+
set maxWidth(maxWidth: number | `${number}%` | null | undefined);
|
|
229
|
+
set minHeight(minHeight: number | `${number}%` | null | undefined);
|
|
230
|
+
set maxHeight(maxHeight: number | `${number}%` | null | undefined);
|
|
231
|
+
set margin(margin: number | "auto" | `${number}%` | null | undefined);
|
|
232
|
+
set marginX(marginX: number | "auto" | `${number}%` | null | undefined);
|
|
233
|
+
set marginY(marginY: number | "auto" | `${number}%` | null | undefined);
|
|
234
|
+
set marginTop(margin: number | "auto" | `${number}%` | null | undefined);
|
|
235
|
+
set marginRight(margin: number | "auto" | `${number}%` | null | undefined);
|
|
236
|
+
set marginBottom(margin: number | "auto" | `${number}%` | null | undefined);
|
|
237
|
+
set marginLeft(margin: number | "auto" | `${number}%` | null | undefined);
|
|
238
|
+
set padding(padding: number | `${number}%` | null | undefined);
|
|
239
|
+
set paddingX(paddingX: number | `${number}%` | null | undefined);
|
|
240
|
+
set paddingY(paddingY: number | `${number}%` | null | undefined);
|
|
241
|
+
set paddingTop(padding: number | `${number}%` | null | undefined);
|
|
242
|
+
set paddingRight(padding: number | `${number}%` | null | undefined);
|
|
243
|
+
set paddingBottom(padding: number | `${number}%` | null | undefined);
|
|
244
|
+
set paddingLeft(padding: number | `${number}%` | null | undefined);
|
|
245
|
+
getLayoutNode(): YogaNode;
|
|
246
|
+
updateFromLayout(): void;
|
|
247
|
+
protected onLayoutResize(width: number, height: number): void;
|
|
248
|
+
protected handleFrameBufferResize(width: number, height: number): void;
|
|
249
|
+
protected createFrameBuffer(): void;
|
|
250
|
+
/**
|
|
251
|
+
* This will be called during a render pass.
|
|
252
|
+
* Requesting a render during a render pass will drop the requested render.
|
|
253
|
+
* If you need to request a render during a render pass, use process.nextTick.
|
|
254
|
+
*/
|
|
255
|
+
protected onResize(width: number, height: number): void;
|
|
256
|
+
private replaceParent;
|
|
257
|
+
add(obj: Renderable | VNode<any, any[]> | unknown, index?: number): number;
|
|
258
|
+
insertBefore(obj: Renderable | VNode<any, any[]> | unknown, anchor?: Renderable | unknown): number;
|
|
259
|
+
getRenderable(id: string): Renderable | undefined;
|
|
260
|
+
remove(id: string): void;
|
|
261
|
+
protected onRemove(): void;
|
|
262
|
+
getChildren(): Renderable[];
|
|
263
|
+
getChildrenCount(): number;
|
|
264
|
+
updateLayout(deltaTime: number, renderList?: RenderCommand[]): void;
|
|
265
|
+
render(buffer: OptimizedBuffer, deltaTime: number): void;
|
|
266
|
+
protected _getVisibleChildren(): number[];
|
|
267
|
+
protected onUpdate(deltaTime: number): void;
|
|
268
|
+
protected getScissorRect(): {
|
|
269
|
+
x: number;
|
|
270
|
+
y: number;
|
|
271
|
+
width: number;
|
|
272
|
+
height: number;
|
|
273
|
+
};
|
|
274
|
+
protected renderSelf(buffer: OptimizedBuffer, deltaTime: number): void;
|
|
275
|
+
get isDestroyed(): boolean;
|
|
276
|
+
destroy(): void;
|
|
277
|
+
destroyRecursively(): void;
|
|
278
|
+
protected destroySelf(): void;
|
|
279
|
+
processMouseEvent(event: MouseEvent): void;
|
|
280
|
+
protected onMouseEvent(event: MouseEvent): void;
|
|
281
|
+
set onMouse(handler: ((event: MouseEvent) => void) | undefined);
|
|
282
|
+
set onMouseDown(handler: ((event: MouseEvent) => void) | undefined);
|
|
283
|
+
set onMouseUp(handler: ((event: MouseEvent) => void) | undefined);
|
|
284
|
+
set onMouseMove(handler: ((event: MouseEvent) => void) | undefined);
|
|
285
|
+
set onMouseDrag(handler: ((event: MouseEvent) => void) | undefined);
|
|
286
|
+
set onMouseDragEnd(handler: ((event: MouseEvent) => void) | undefined);
|
|
287
|
+
set onMouseDrop(handler: ((event: MouseEvent) => void) | undefined);
|
|
288
|
+
set onMouseOver(handler: ((event: MouseEvent) => void) | undefined);
|
|
289
|
+
set onMouseOut(handler: ((event: MouseEvent) => void) | undefined);
|
|
290
|
+
set onMouseScroll(handler: ((event: MouseEvent) => void) | undefined);
|
|
291
|
+
set onPaste(handler: ((event: PasteEvent) => void) | undefined);
|
|
292
|
+
get onPaste(): ((event: PasteEvent) => void) | undefined;
|
|
293
|
+
set onKeyDown(handler: ((key: KeyEvent) => void) | undefined);
|
|
294
|
+
get onKeyDown(): ((key: KeyEvent) => void) | undefined;
|
|
295
|
+
set onSizeChange(handler: (() => void) | undefined);
|
|
296
|
+
get onSizeChange(): (() => void) | undefined;
|
|
297
|
+
private applyEventOptions;
|
|
298
|
+
}
|
|
299
|
+
interface RenderCommandBase {
|
|
300
|
+
action: "render" | "pushScissorRect" | "popScissorRect" | "pushOpacity" | "popOpacity";
|
|
301
|
+
}
|
|
302
|
+
interface RenderCommandPushScissorRect extends RenderCommandBase {
|
|
303
|
+
action: "pushScissorRect";
|
|
304
|
+
x: number;
|
|
305
|
+
y: number;
|
|
306
|
+
width: number;
|
|
307
|
+
height: number;
|
|
308
|
+
screenX: number;
|
|
309
|
+
screenY: number;
|
|
310
|
+
}
|
|
311
|
+
interface RenderCommandPopScissorRect extends RenderCommandBase {
|
|
312
|
+
action: "popScissorRect";
|
|
313
|
+
}
|
|
314
|
+
interface RenderCommandRender extends RenderCommandBase {
|
|
315
|
+
action: "render";
|
|
316
|
+
renderable: Renderable;
|
|
317
|
+
}
|
|
318
|
+
interface RenderCommandPushOpacity extends RenderCommandBase {
|
|
319
|
+
action: "pushOpacity";
|
|
320
|
+
opacity: number;
|
|
321
|
+
}
|
|
322
|
+
interface RenderCommandPopOpacity extends RenderCommandBase {
|
|
323
|
+
action: "popOpacity";
|
|
324
|
+
}
|
|
325
|
+
export type RenderCommand = RenderCommandPushScissorRect | RenderCommandPopScissorRect | RenderCommandRender | RenderCommandPushOpacity | RenderCommandPopOpacity;
|
|
326
|
+
export declare class RootRenderable extends Renderable {
|
|
327
|
+
private renderList;
|
|
328
|
+
constructor(ctx: RenderContext);
|
|
329
|
+
render(buffer: OptimizedBuffer, deltaTime: number): void;
|
|
330
|
+
protected propagateLiveCount(delta: number): void;
|
|
331
|
+
calculateLayout(): void;
|
|
332
|
+
resize(width: number, height: number): void;
|
|
333
|
+
}
|
|
334
|
+
export {};
|
|
@@ -0,0 +1,126 @@
|
|
|
1
|
+
import type { CliRenderer } from "../renderer";
|
|
2
|
+
export interface TimelineOptions {
|
|
3
|
+
duration?: number;
|
|
4
|
+
loop?: boolean;
|
|
5
|
+
autoplay?: boolean;
|
|
6
|
+
onComplete?: () => void;
|
|
7
|
+
onPause?: () => void;
|
|
8
|
+
}
|
|
9
|
+
export interface AnimationOptions {
|
|
10
|
+
duration: number;
|
|
11
|
+
ease?: EasingFunctions;
|
|
12
|
+
onUpdate?: (animation: JSAnimation) => void;
|
|
13
|
+
onComplete?: () => void;
|
|
14
|
+
onStart?: () => void;
|
|
15
|
+
onLoop?: () => void;
|
|
16
|
+
loop?: boolean | number;
|
|
17
|
+
loopDelay?: number;
|
|
18
|
+
alternate?: boolean;
|
|
19
|
+
once?: boolean;
|
|
20
|
+
[key: string]: any;
|
|
21
|
+
}
|
|
22
|
+
export interface JSAnimation {
|
|
23
|
+
targets: any[];
|
|
24
|
+
deltaTime: number;
|
|
25
|
+
progress: number;
|
|
26
|
+
currentTime: number;
|
|
27
|
+
}
|
|
28
|
+
interface TimelineItem {
|
|
29
|
+
type: "animation" | "callback" | "timeline";
|
|
30
|
+
startTime: number;
|
|
31
|
+
}
|
|
32
|
+
interface TimelineTimelineItem extends TimelineItem {
|
|
33
|
+
type: "timeline";
|
|
34
|
+
timeline: Timeline;
|
|
35
|
+
timelineStarted?: boolean;
|
|
36
|
+
}
|
|
37
|
+
interface TimelineCallbackItem extends TimelineItem {
|
|
38
|
+
type: "callback";
|
|
39
|
+
callback: () => void;
|
|
40
|
+
executed: boolean;
|
|
41
|
+
}
|
|
42
|
+
interface TimelineAnimationItem extends TimelineItem {
|
|
43
|
+
type: "animation";
|
|
44
|
+
target: any[];
|
|
45
|
+
properties?: Record<string, number>;
|
|
46
|
+
initialValues?: Record<string, number>[];
|
|
47
|
+
duration?: number;
|
|
48
|
+
ease?: keyof typeof easingFunctions;
|
|
49
|
+
loop?: boolean | number;
|
|
50
|
+
loopDelay?: number;
|
|
51
|
+
alternate?: boolean;
|
|
52
|
+
onUpdate?: (animation: JSAnimation) => void;
|
|
53
|
+
onComplete?: () => void;
|
|
54
|
+
onStart?: () => void;
|
|
55
|
+
onLoop?: () => void;
|
|
56
|
+
completed?: boolean;
|
|
57
|
+
started?: boolean;
|
|
58
|
+
currentLoop?: number;
|
|
59
|
+
once?: boolean;
|
|
60
|
+
}
|
|
61
|
+
export type EasingFunctions = keyof typeof easingFunctions;
|
|
62
|
+
declare const easingFunctions: {
|
|
63
|
+
linear: (t: number) => number;
|
|
64
|
+
inQuad: (t: number) => number;
|
|
65
|
+
outQuad: (t: number) => number;
|
|
66
|
+
inOutQuad: (t: number) => number;
|
|
67
|
+
inExpo: (t: number) => number;
|
|
68
|
+
outExpo: (t: number) => number;
|
|
69
|
+
inOutSine: (t: number) => number;
|
|
70
|
+
outBounce: (t: number) => number;
|
|
71
|
+
outElastic: (t: number) => number;
|
|
72
|
+
inBounce: (t: number) => number;
|
|
73
|
+
inCirc: (t: number) => number;
|
|
74
|
+
outCirc: (t: number) => number;
|
|
75
|
+
inOutCirc: (t: number) => number;
|
|
76
|
+
inBack: (t: number, s?: number) => number;
|
|
77
|
+
outBack: (t: number, s?: number) => number;
|
|
78
|
+
inOutBack: (t: number, s?: number) => number;
|
|
79
|
+
};
|
|
80
|
+
export declare class Timeline {
|
|
81
|
+
items: (TimelineAnimationItem | TimelineCallbackItem)[];
|
|
82
|
+
subTimelines: TimelineTimelineItem[];
|
|
83
|
+
currentTime: number;
|
|
84
|
+
isPlaying: boolean;
|
|
85
|
+
isComplete: boolean;
|
|
86
|
+
duration: number;
|
|
87
|
+
loop: boolean;
|
|
88
|
+
synced: boolean;
|
|
89
|
+
private autoplay;
|
|
90
|
+
private onComplete?;
|
|
91
|
+
private onPause?;
|
|
92
|
+
private stateChangeListeners;
|
|
93
|
+
constructor(options?: TimelineOptions);
|
|
94
|
+
addStateChangeListener(listener: (timeline: Timeline) => void): void;
|
|
95
|
+
removeStateChangeListener(listener: (timeline: Timeline) => void): void;
|
|
96
|
+
private notifyStateChange;
|
|
97
|
+
add(target: any, properties: AnimationOptions, startTime?: number | string): this;
|
|
98
|
+
once(target: any, properties: AnimationOptions): this;
|
|
99
|
+
call(callback: () => void, startTime?: number | string): this;
|
|
100
|
+
sync(timeline: Timeline, startTime?: number): this;
|
|
101
|
+
play(): this;
|
|
102
|
+
pause(): this;
|
|
103
|
+
resetItems(): void;
|
|
104
|
+
restart(): this;
|
|
105
|
+
update(deltaTime: number): void;
|
|
106
|
+
}
|
|
107
|
+
declare class TimelineEngine {
|
|
108
|
+
private timelines;
|
|
109
|
+
private renderer;
|
|
110
|
+
private frameCallback;
|
|
111
|
+
private isLive;
|
|
112
|
+
defaults: {
|
|
113
|
+
frameRate: number;
|
|
114
|
+
};
|
|
115
|
+
attach(renderer: CliRenderer): void;
|
|
116
|
+
detach(): void;
|
|
117
|
+
private updateLiveState;
|
|
118
|
+
private onTimelineStateChange;
|
|
119
|
+
register(timeline: Timeline): void;
|
|
120
|
+
unregister(timeline: Timeline): void;
|
|
121
|
+
clear(): void;
|
|
122
|
+
update(deltaTime: number): void;
|
|
123
|
+
}
|
|
124
|
+
export declare const engine: TimelineEngine;
|
|
125
|
+
export declare function createTimeline(options?: TimelineOptions): Timeline;
|
|
126
|
+
export {};
|
package/ansi.d.ts
ADDED
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
export declare const ANSI: {
|
|
2
|
+
switchToAlternateScreen: string;
|
|
3
|
+
switchToMainScreen: string;
|
|
4
|
+
reset: string;
|
|
5
|
+
scrollDown: (lines: number) => string;
|
|
6
|
+
scrollUp: (lines: number) => string;
|
|
7
|
+
moveCursor: (row: number, col: number) => string;
|
|
8
|
+
moveCursorAndClear: (row: number, col: number) => string;
|
|
9
|
+
setRgbBackground: (r: number, g: number, b: number) => string;
|
|
10
|
+
resetBackground: string;
|
|
11
|
+
bracketedPasteStart: string;
|
|
12
|
+
bracketedPasteEnd: string;
|
|
13
|
+
};
|