@opentui/core 0.6.8 → 0.8.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.
Files changed (60) hide show
  1. package/NativeScene.d.ts +14 -29
  2. package/Renderable.d.ts +47 -34
  3. package/animation/Timeline.d.ts +9 -0
  4. package/audio.d.ts +1 -0
  5. package/buffer.d.ts +6 -2
  6. package/{chunk-bun-4e5bpeqh.js → chunk-bun-6kxdhkdc.js} +1243 -1034
  7. package/chunk-bun-6kxdhkdc.js.map +70 -0
  8. package/{chunk-bun-ehr9v0n8.js → chunk-bun-x6cz4jyg.js} +514 -84
  9. package/chunk-bun-x6cz4jyg.js.map +35 -0
  10. package/{chunk-node-yyjd8p1g.js → chunk-node-q5ccgbk5.js} +1243 -1034
  11. package/chunk-node-q5ccgbk5.js.map +70 -0
  12. package/{chunk-node-jhq62x0c.js → chunk-node-y0w0hq5m.js} +514 -84
  13. package/chunk-node-y0w0hq5m.js.map +34 -0
  14. package/edit-buffer.d.ts +4 -0
  15. package/index.bun.js +1086 -549
  16. package/index.bun.js.map +15 -13
  17. package/index.d.ts +1 -1
  18. package/index.node.js +1086 -549
  19. package/index.node.js.map +16 -12
  20. package/lib/detect-links.d.ts +2 -0
  21. package/lib/extmarks.d.ts +3 -1
  22. package/lib/parse.keypress-kitty.d.ts +2 -0
  23. package/lib/scroll-chain.d.ts +16 -0
  24. package/lib/stdin-parser-native.d.ts +90 -0
  25. package/lib/stdin-parser.d.ts +2 -0
  26. package/lib/terminal-capability-detection.d.ts +6 -1
  27. package/native-abi.generated.d.ts +700 -7
  28. package/package.json +9 -9
  29. package/renderables/Box.d.ts +2 -2
  30. package/renderables/Code.d.ts +2 -1
  31. package/renderables/Diff.d.ts +2 -2
  32. package/renderables/EditBufferRenderable.d.ts +2 -2
  33. package/renderables/EmbeddedTerminal.d.ts +2 -2
  34. package/renderables/FrameBuffer.d.ts +4 -3
  35. package/renderables/Image.d.ts +2 -2
  36. package/renderables/Markdown.d.ts +2 -2
  37. package/renderables/ScrollBar.d.ts +9 -3
  38. package/renderables/ScrollBox.d.ts +87 -44
  39. package/renderables/ScrollBoxParts.d.ts +165 -0
  40. package/renderables/Slider.d.ts +2 -2
  41. package/renderables/Text.d.ts +2 -2
  42. package/renderables/TextBufferRenderable.d.ts +2 -4
  43. package/renderables/index.d.ts +1 -1
  44. package/renderer-theme-mode.d.ts +1 -6
  45. package/renderer.d.ts +30 -7
  46. package/testing/test-renderer.d.ts +4 -0
  47. package/testing.bun.js +12 -4
  48. package/testing.bun.js.map +3 -3
  49. package/testing.js +12 -4
  50. package/testing.js.map +3 -3
  51. package/types.d.ts +11 -0
  52. package/yoga.bun.js +1 -1
  53. package/yoga.internal.d.ts +3 -3
  54. package/yoga.js +1 -1
  55. package/zig-structs.d.ts +26 -0
  56. package/zig.d.ts +96 -13
  57. package/chunk-bun-4e5bpeqh.js.map +0 -69
  58. package/chunk-bun-ehr9v0n8.js.map +0 -35
  59. package/chunk-node-jhq62x0c.js.map +0 -34
  60. package/chunk-node-yyjd8p1g.js.map +0 -69
package/package.json CHANGED
@@ -4,7 +4,7 @@
4
4
  "main": "index.node.js",
5
5
  "types": "index.d.ts",
6
6
  "type": "module",
7
- "version": "0.6.8",
7
+ "version": "0.8.0",
8
8
  "description": "OpenTUI is a TypeScript library on a native Zig core for building terminal user interfaces (TUIs)",
9
9
  "license": "MIT",
10
10
  "repository": {
@@ -78,13 +78,13 @@
78
78
  "web-tree-sitter": "0.25.10"
79
79
  },
80
80
  "optionalDependencies": {
81
- "@opentui/core-darwin-x64": "0.6.8",
82
- "@opentui/core-darwin-arm64": "0.6.8",
83
- "@opentui/core-linux-x64": "0.6.8",
84
- "@opentui/core-linux-arm64": "0.6.8",
85
- "@opentui/core-win32-x64": "0.6.8",
86
- "@opentui/core-win32-arm64": "0.6.8",
87
- "@opentui/core-linux-x64-musl": "0.6.8",
88
- "@opentui/core-linux-arm64-musl": "0.6.8"
81
+ "@opentui/core-darwin-x64": "0.8.0",
82
+ "@opentui/core-darwin-arm64": "0.8.0",
83
+ "@opentui/core-linux-x64": "0.8.0",
84
+ "@opentui/core-linux-arm64": "0.8.0",
85
+ "@opentui/core-win32-x64": "0.8.0",
86
+ "@opentui/core-win32-arm64": "0.8.0",
87
+ "@opentui/core-linux-x64-musl": "0.8.0",
88
+ "@opentui/core-linux-arm64-musl": "0.8.0"
89
89
  }
90
90
  }
@@ -1,4 +1,4 @@
1
- import { type RenderableOptions, Renderable } from "../Renderable.js";
1
+ import { type RenderableOptions, Renderable, type NativeRenderableIntegration } from "../Renderable.js";
2
2
  import type { OptimizedBuffer } from "../buffer.js";
3
3
  import { type BorderCharacters, type BorderSides, type BorderSidesConfig, type BorderStyle } from "../lib/index.js";
4
4
  import { type ColorInput, RGBA } from "../lib/RGBA.js";
@@ -23,7 +23,7 @@ export interface BoxOptions<TRenderable extends Renderable = BoxRenderable> exte
23
23
  columnGap?: number | `${number}%`;
24
24
  }
25
25
  export declare class BoxRenderable extends Renderable {
26
- static readonly nativeIntegration: import("../Renderable.js").NativeRenderableIntegration;
26
+ static readonly nativeIntegration: NativeRenderableIntegration;
27
27
  protected _backgroundColor: RGBA;
28
28
  protected _border: boolean | BorderSides[];
29
29
  protected _borderStyle: BorderStyle;
@@ -3,6 +3,7 @@ import { StyledText } from "../lib/styled-text.js";
3
3
  import { SyntaxStyle } from "../syntax-style.js";
4
4
  import { TreeSitterClient } from "../lib/tree-sitter/index.js";
5
5
  import { TextBufferRenderable, type TextBufferOptions } from "./TextBufferRenderable.js";
6
+ import type { NativeRenderableIntegration } from "../Renderable.js";
6
7
  import type { OptimizedBuffer } from "../buffer.js";
7
8
  import type { SimpleHighlight } from "../lib/tree-sitter/types.js";
8
9
  import type { TextChunk } from "../text-buffer.js";
@@ -34,7 +35,7 @@ export interface CodeOptions extends TextBufferOptions {
34
35
  onChunks?: OnChunksCallback;
35
36
  }
36
37
  export declare class CodeRenderable extends TextBufferRenderable {
37
- static readonly nativeIntegration: import("../Renderable.js").NativeRenderableIntegration;
38
+ static readonly nativeIntegration: NativeRenderableIntegration;
38
39
  private _content;
39
40
  private _filetype?;
40
41
  private _syntaxStyle;
@@ -1,4 +1,4 @@
1
- import { Renderable, type RenderableOptions } from "../Renderable.js";
1
+ import { Renderable, type RenderableOptions, type NativeRenderableIntegration } from "../Renderable.js";
2
2
  import type { RenderContext } from "../types.js";
3
3
  import { type LineColorConfig } from "./LineNumberRenderable.js";
4
4
  import { RGBA } from "../lib/RGBA.js";
@@ -44,7 +44,7 @@ export interface DiffRenderableOptions extends RenderableOptions<DiffRenderable>
44
44
  removedLineNumberBg?: string | RGBA;
45
45
  }
46
46
  export declare class DiffRenderable extends Renderable {
47
- static readonly nativeIntegration: import("../Renderable.js").NativeRenderableIntegration;
47
+ static readonly nativeIntegration: NativeRenderableIntegration;
48
48
  private _diff;
49
49
  private _syncScroll;
50
50
  private _view;
@@ -1,4 +1,4 @@
1
- import { Renderable, type RenderableOptions } from "../Renderable.js";
1
+ import { Renderable, type RenderableOptions, type NativeRenderableIntegration } from "../Renderable.js";
2
2
  import { Selection, type LocalSelectionBounds } from "../lib/selection.js";
3
3
  import { EditBuffer, type LogicalCursor } from "../edit-buffer.js";
4
4
  import { EditorView, type VisualCursor } from "../editor-view.js";
@@ -44,7 +44,7 @@ export interface EditBufferOptions extends RenderableOptions<EditBufferRenderabl
44
44
  onContentChange?: (event: ContentChangeEvent) => void;
45
45
  }
46
46
  export declare abstract class EditBufferRenderable extends Renderable implements LineInfoProvider {
47
- static readonly nativeIntegration: import("../Renderable.js").NativeRenderableIntegration;
47
+ static readonly nativeIntegration: NativeRenderableIntegration;
48
48
  [BrandedEditBufferRenderable]: boolean;
49
49
  protected static readonly defaultFocusable = true;
50
50
  private _traits;
@@ -1,4 +1,4 @@
1
- import { type RenderableOptions, Renderable } from "../Renderable.js";
1
+ import { type RenderableOptions, Renderable, type NativeRenderableIntegration } from "../Renderable.js";
2
2
  import type { KeyEvent, PasteEvent } from "../lib/KeyHandler.js";
3
3
  import type { RenderContext } from "../types.js";
4
4
  import type { OptimizedBuffer } from "../buffer.js";
@@ -26,7 +26,7 @@ export type EmbeddedTerminalScreen = {
26
26
  };
27
27
  };
28
28
  export declare class EmbeddedTerminalRenderable extends Renderable {
29
- static readonly nativeIntegration: import("../Renderable.js").NativeRenderableIntegration;
29
+ static readonly nativeIntegration: NativeRenderableIntegration;
30
30
  selectable: boolean;
31
31
  private readonly lib;
32
32
  private handle;
@@ -1,17 +1,18 @@
1
- import { type RenderableOptions, Renderable } from "../Renderable.js";
1
+ import { type RenderableOptions, Renderable, type NativeRenderableIntegration } from "../Renderable.js";
2
2
  import { OptimizedBuffer } from "../buffer.js";
3
3
  import type { RenderContext } from "../types.js";
4
4
  export interface FrameBufferOptions extends RenderableOptions<FrameBufferRenderable> {
5
5
  width: number;
6
6
  height: number;
7
+ /** Blend the buffer's cells into the frame. Without it, the cells are copied, transparent ones too. */
7
8
  respectAlpha?: boolean;
8
9
  }
9
10
  export declare class FrameBufferRenderable extends Renderable {
10
- static readonly nativeIntegration: import("../Renderable.js").NativeRenderableIntegration;
11
+ static readonly nativeIntegration: NativeRenderableIntegration;
11
12
  frameBuffer: OptimizedBuffer;
12
13
  protected respectAlpha: boolean;
13
14
  constructor(ctx: RenderContext, options: FrameBufferOptions);
14
- /** @internal Native class fields can replace the accessor after this constructor returns. */
15
+ /** @internal A subclass field can replace the accessor after this constructor returns; refreshHooks() rebinds it. */
15
16
  _refreshNativeSceneSurface(): void;
16
17
  protected onResize(width: number, height: number): void;
17
18
  protected renderSelf(buffer: OptimizedBuffer): void;
@@ -1,4 +1,4 @@
1
- import { Renderable, type RenderableOptions } from "../Renderable.js";
1
+ import { Renderable, type RenderableOptions, type NativeRenderableIntegration } from "../Renderable.js";
2
2
  import { NativeImage, type ImageSource } from "../image.js";
3
3
  import type { OptimizedBuffer } from "../buffer.js";
4
4
  import type { ImageRenderProtocol, RenderContext, TerminalCapabilities } from "../types.js";
@@ -13,7 +13,7 @@ export interface ImageRenderableOptions extends RenderableOptions<ImageRenderabl
13
13
  }
14
14
  export declare function resolveImageRenderProtocol(requested: ImageRenderProtocol, capabilities: TerminalCapabilities | null, hasResolution: boolean): Exclude<ImageRenderProtocol, "auto">;
15
15
  export declare class ImageRenderable extends Renderable {
16
- static readonly nativeIntegration: import("../Renderable.js").NativeRenderableIntegration;
16
+ static readonly nativeIntegration: NativeRenderableIntegration;
17
17
  private _source;
18
18
  private _image;
19
19
  private _pendingImage;
@@ -1,4 +1,4 @@
1
- import { Renderable, type RenderableOptions } from "../Renderable.js";
1
+ import { Renderable, type RenderableOptions, type NativeRenderableIntegration } from "../Renderable.js";
2
2
  import { type RenderContext } from "../types.js";
3
3
  import { SyntaxStyle } from "../syntax-style.js";
4
4
  import type { BorderStyle } from "../lib/border.js";
@@ -131,7 +131,7 @@ export interface BlockState {
131
131
  }
132
132
  export type { ParseState };
133
133
  export declare class MarkdownRenderable extends Renderable {
134
- static readonly nativeIntegration: import("../Renderable.js").NativeRenderableIntegration;
134
+ static readonly nativeIntegration: NativeRenderableIntegration;
135
135
  private static _capabilitySubscriptions;
136
136
  private _content;
137
137
  private _syntaxStyle;
@@ -1,7 +1,7 @@
1
1
  import type { OptimizedBuffer } from "../buffer.js";
2
2
  import { RGBA, type ColorInput } from "../lib/index.js";
3
3
  import type { KeyEvent } from "../lib/KeyHandler.js";
4
- import { Renderable, type RenderableOptions } from "../Renderable.js";
4
+ import { Renderable, type RenderableOptions, type NativeRenderableIntegration } from "../Renderable.js";
5
5
  import type { RenderContext } from "../types.js";
6
6
  import { SliderRenderable, type SliderOptions } from "./Slider.js";
7
7
  export interface ScrollBarOptions extends RenderableOptions<ScrollBarRenderable> {
@@ -13,7 +13,7 @@ export interface ScrollBarOptions extends RenderableOptions<ScrollBarRenderable>
13
13
  }
14
14
  export type ScrollUnit = "absolute" | "viewport" | "content" | "step";
15
15
  export declare class ScrollBarRenderable extends Renderable {
16
- static readonly nativeIntegration: import("../Renderable.js").NativeRenderableIntegration;
16
+ static readonly nativeIntegration: NativeRenderableIntegration;
17
17
  readonly slider: SliderRenderable;
18
18
  readonly startArrow: ArrowRenderable;
19
19
  readonly endArrow: ArrowRenderable;
@@ -61,7 +61,7 @@ export interface ArrowOptions extends RenderableOptions<ArrowRenderable> {
61
61
  };
62
62
  }
63
63
  export declare class ArrowRenderable extends Renderable {
64
- static readonly nativeIntegration: import("../Renderable.js").NativeRenderableIntegration;
64
+ static readonly nativeIntegration: NativeRenderableIntegration;
65
65
  private _direction;
66
66
  private _foregroundColor;
67
67
  private _backgroundColor;
@@ -83,3 +83,9 @@ export declare class ArrowRenderable extends Renderable {
83
83
  private glyphWidth;
84
84
  private getArrowChar;
85
85
  }
86
+ /** @internal Cells per unit of a scrollbar's `scrollBy`. */
87
+ export declare function scrollUnitSize(bar: {
88
+ viewportSize: number;
89
+ scrollSize: number;
90
+ scrollStep?: number | null;
91
+ }, unit: ScrollUnit): number;
@@ -1,19 +1,14 @@
1
1
  import { type KeyEvent } from "../lib/index.js";
2
2
  import { type ScrollAcceleration } from "../lib/scroll-acceleration.js";
3
- import type { BaseRenderable, Renderable, RenderableOptions } from "../Renderable.js";
3
+ import type { NativeRenderableIntegration, Renderable } from "../Renderable.js";
4
4
  import type { MouseEvent } from "../renderer.js";
5
5
  import type { RenderContext } from "../types.js";
6
+ import type { NativeScene } from "../NativeScene.js";
7
+ import { type NativeSceneRect, type NativeSceneScrollState } from "../zig.js";
6
8
  import { BoxRenderable, type BoxOptions } from "./Box.js";
7
- import type { VNode } from "./composition/vnode.js";
8
- import { ScrollBarRenderable, type ScrollBarOptions, type ScrollUnit } from "./ScrollBar.js";
9
- export declare class ContentRenderable extends BoxRenderable {
10
- static readonly nativeIntegration: import("../Renderable.js").NativeRenderableIntegration;
11
- private viewport;
12
- private _viewportCulling;
13
- constructor(ctx: RenderContext, viewport: BoxRenderable, viewportCulling: boolean, options: RenderableOptions<BoxRenderable>);
14
- get viewportCulling(): boolean;
15
- set viewportCulling(value: boolean);
16
- }
9
+ import type { ScrollBarOptions, ScrollUnit } from "./ScrollBar.js";
10
+ import { ScrollBoxBar, ScrollBoxContent, ScrollBoxViewport, ScrollBoxWrapper, type SceneStyleNode } from "./ScrollBoxParts.js";
11
+ export { ScrollBoxBar, ScrollBoxContent, ScrollBoxViewport, ScrollBoxWrapper } from "./ScrollBoxParts.js";
17
12
  export interface ScrollBoxOptions extends BoxOptions<ScrollBoxRenderable> {
18
13
  rootOptions?: BoxOptions;
19
14
  wrapperOptions?: BoxOptions;
@@ -29,15 +24,16 @@ export interface ScrollBoxOptions extends BoxOptions<ScrollBoxRenderable> {
29
24
  scrollAcceleration?: ScrollAcceleration;
30
25
  viewportCulling?: boolean;
31
26
  }
27
+ /** A box whose scroll offset, range, sticky edge and scrollbars are native state of its scene node. The
28
+ * `wrapper`, `viewport`, `content` and scrollbar fields are facades over that state, not renderables; the
29
+ * box's children are the scrolled content. */
32
30
  export declare class ScrollBoxRenderable extends BoxRenderable {
33
- static readonly nativeIntegration: import("../Renderable.js").NativeRenderableIntegration;
34
- static idCounter: number;
35
- private internalId;
36
- readonly wrapper: BoxRenderable;
37
- readonly viewport: BoxRenderable;
38
- readonly content: ContentRenderable;
39
- readonly horizontalScrollBar: ScrollBarRenderable;
40
- readonly verticalScrollBar: ScrollBarRenderable;
31
+ static readonly nativeIntegration: NativeRenderableIntegration;
32
+ readonly wrapper: ScrollBoxWrapper;
33
+ readonly viewport: ScrollBoxViewport;
34
+ readonly content: ScrollBoxContent;
35
+ readonly horizontalScrollBar: ScrollBoxBar;
36
+ readonly verticalScrollBar: ScrollBoxBar;
41
37
  protected static readonly defaultFocusable = true;
42
38
  private selectionListener?;
43
39
  private autoScrollMouseX;
@@ -54,46 +50,98 @@ export declare class ScrollBoxRenderable extends BoxRenderable {
54
50
  private scrollAccumulatorX;
55
51
  private scrollAccumulatorY;
56
52
  private _stickyScroll;
57
- private _stickyScrollTop;
58
- private _stickyScrollBottom;
59
- private _stickyScrollLeft;
60
- private _stickyScrollRight;
61
53
  private _stickyStart?;
62
- private _hasManualScroll;
63
- private _isApplyingStickyScroll;
64
54
  private scrollAccel;
55
+ private readonly axes;
56
+ private _viewportCulling;
57
+ private state;
58
+ private stateRevision?;
59
+ private scrollHook;
60
+ private configured;
61
+ private barPress?;
62
+ private layoutCallbacks;
63
+ private anchorToken?;
65
64
  get stickyScroll(): boolean;
66
65
  set stickyScroll(value: boolean);
67
66
  get stickyStart(): "bottom" | "top" | "left" | "right" | undefined;
68
67
  set stickyStart(value: "bottom" | "top" | "left" | "right" | undefined);
68
+ /** Native validates the options; a rejected write keeps the accepted values. */
69
+ private setScrollOption;
70
+ /** Whether the box scrolls sideways; on an axis that does not scroll, the content is at most as wide as the viewport. */
71
+ get scrollX(): boolean;
72
+ set scrollX(value: boolean);
73
+ get scrollY(): boolean;
74
+ set scrollY(value: boolean);
69
75
  get scrollTop(): number;
70
76
  set scrollTop(value: number);
71
77
  get scrollLeft(): number;
72
78
  set scrollLeft(value: number);
73
79
  get scrollWidth(): number;
74
80
  get scrollHeight(): number;
75
- private updateStickyState;
76
- private syncManualScrollState;
77
- private applyStickyStart;
78
81
  constructor(ctx: RenderContext, options: ScrollBoxOptions);
82
+ /** @internal */
83
+ _applyScrollOptions(): void;
84
+ /** @internal */
85
+ _applyScrollArrows(axis: number): void;
86
+ /** @internal Writes a style of the hidden content node. */
87
+ _setContentStyle(apply: (scene: NativeScene, node: SceneStyleNode) => void): void;
88
+ /** @internal The scroll state of the last prepared frame or explicit scroll. */
89
+ _scrollState(): NativeSceneScrollState;
90
+ /** @internal The box's inner rect without the vertical bar's gutter, as today's wrapper box. */
91
+ _wrapperRect(): NativeSceneRect;
92
+ /** @internal An explicit scroll on one axis; `"change"` reaches listeners at once. With `reapply` it applies again
93
+ * after the next frame's layout. */
94
+ _scrollAxis(axis: number, value: number, relative: boolean, reapply?: boolean): void;
95
+ private commitScroll;
96
+ /** `moved` holds bit 1 for x and bit 2 for y, as native's change bits. */
97
+ private notifyOffsets;
98
+ private listening;
99
+ /** @internal Ask for SCROLL requests only while a part has a listener; `adding` counts one about to be added.
100
+ * Native reports changes from the moment the request is turned on. */
101
+ _refreshScrollHook(adding?: boolean): void;
102
+ /** A SCROLL request: offsets first, as a sticky follow inside a resize hook did, then sizes, then the callbacks
103
+ * waiting for layout. */
104
+ private notifyScroll;
105
+ /** Runs `callback` once in the next frame, after its layout and before it paints: layout reads in it are current,
106
+ * and a scroll it makes shows in that frame. Asked during a frame, it runs in the frame after. It waits while the box
107
+ * is hidden; destroying the box drops it. */
108
+ afterLayout(callback: () => void): void;
109
+ /** Keeps `node`, a descendant, at its place in the viewport through layout changes, over sticky follow, until the
110
+ * returned function runs or the node leaves the box. A scroll moves the place it keeps; a scroll to the end or a later
111
+ * anchor ends it. Release takes effect at once: to keep the place through a change made just before, release in
112
+ * `afterLayout`. */
113
+ anchor(node: Renderable): () => void;
114
+ get primaryAxis(): "row" | "column";
79
115
  protected onUpdate(deltaTime: number): void;
80
116
  scrollBy(delta: number | {
81
117
  x: number;
82
118
  y: number;
83
119
  }, unit?: ScrollUnit): void;
84
- scrollChildIntoView(childId: string): void;
120
+ /** Scrolls a descendant (by id, or the node) into view now, and again after the next frame's layout. `"nearest"`
121
+ * moves the least; `"start"` and `"end"` put that edge of the node at the viewport's, `inset` cells inside. */
122
+ scrollChildIntoView(child: string | Renderable, options?: {
123
+ align?: "nearest" | "start" | "end";
124
+ inset?: number;
125
+ }): void;
126
+ /** Scrolls now, and again after the next frame's layout, so a position past the current range lands there once the
127
+ * content grows, and one at or past the end (`scrollHeight`, `Infinity`) stays at the end. */
85
128
  scrollTo(position: number | {
86
129
  x: number;
87
130
  y: number;
88
131
  }): void;
89
- private isAtStickyPosition;
90
- private isAtStickyReengagePoint;
91
- add(obj: Renderable | VNode<any, any[]>, index?: number): number;
92
- insertBefore(obj: Renderable | VNode<any, any[]> | unknown, anchor?: Renderable | unknown): number;
93
- remove(child: BaseRenderable): void;
94
- getChildren(): Renderable[];
95
- getRenderable(id: string): Renderable | undefined;
132
+ /** Takes a wheel step when the box can still move that way. Acceleration and the fractional remainder belong to the
133
+ * box that takes the step; a reversal or an edge clamp drops the remainder. */
134
+ private scrollByWheel;
96
135
  protected onMouseEvent(event: MouseEvent): void;
136
+ /** Bar cells hit the box: a press on an arrow scrolls and repeats, one on the track jumps there, and a drag that
137
+ * started on the track or thumb moves the thumb with the pointer. */
138
+ private handleBarMouse;
139
+ private pressArrow;
140
+ /** Thumb geometry is in half cells along the track, as the native slider's. */
141
+ private thumbPointer;
142
+ private pressTrack;
143
+ private dragThumb;
144
+ private endBarPress;
97
145
  handleKeyPress(key: KeyEvent): boolean;
98
146
  private resetScrollAccumulators;
99
147
  startAutoScroll(mouseX: number, mouseY: number): void;
@@ -103,14 +151,6 @@ export declare class ScrollBoxRenderable extends BoxRenderable {
103
151
  private getAutoScrollDirectionX;
104
152
  private getAutoScrollDirectionY;
105
153
  private getAutoScrollSpeed;
106
- private recalculateBarProps;
107
- set padding(value: number | `${number}%` | null | undefined);
108
- set paddingX(value: number | `${number}%` | null | undefined);
109
- set paddingY(value: number | `${number}%` | null | undefined);
110
- set paddingTop(value: number | `${number}%` | null | undefined);
111
- set paddingRight(value: number | `${number}%` | null | undefined);
112
- set paddingBottom(value: number | `${number}%` | null | undefined);
113
- set paddingLeft(value: number | `${number}%` | null | undefined);
114
154
  set rootOptions(options: ScrollBoxOptions["rootOptions"]);
115
155
  set wrapperOptions(options: ScrollBoxOptions["wrapperOptions"]);
116
156
  set viewportOptions(options: ScrollBoxOptions["viewportOptions"]);
@@ -122,5 +162,8 @@ export declare class ScrollBoxRenderable extends BoxRenderable {
122
162
  set scrollAcceleration(value: ScrollAcceleration);
123
163
  get viewportCulling(): boolean;
124
164
  set viewportCulling(value: boolean);
165
+ get overflow(): "hidden";
166
+ /** The box clips like its viewport; other values are ignored. */
167
+ set overflow(_value: unknown);
125
168
  protected destroySelf(): void;
126
169
  }
@@ -0,0 +1,165 @@
1
+ import { EventEmitter } from "events";
2
+ import type { KeyEvent } from "../lib/KeyHandler.js";
3
+ import { RGBA, type ColorInput } from "../lib/RGBA.js";
4
+ import type { BaseRenderable, Renderable } from "../Renderable.js";
5
+ import type { NativeScene } from "../NativeScene.js";
6
+ import { type NativeSceneRect, type NativeSceneScrollBarOptions, type SceneNodeHandle } from "../zig.js";
7
+ import type { BoxOptions } from "./Box.js";
8
+ import type { VNode } from "./composition/vnode.js";
9
+ import { type ArrowOptions, type ScrollUnit } from "./ScrollBar.js";
10
+ import type { ScrollBoxRenderable } from "./ScrollBox.js";
11
+ export type SceneStyleNode = {
12
+ _getSceneHandle(owner: NativeScene): SceneNodeHandle;
13
+ };
14
+ /** A ScrollBox part: plain geometry and events over the box's native scroll state, not a renderable. */
15
+ declare abstract class ScrollBoxPart extends EventEmitter {
16
+ protected readonly box: ScrollBoxRenderable;
17
+ /** `event` is the notification this part emits, if any. */
18
+ constructor(box: ScrollBoxRenderable, event?: string);
19
+ protected abstract rect(): NativeSceneRect;
20
+ /** A part lives as long as its box. */
21
+ get isDestroyed(): boolean;
22
+ get x(): number;
23
+ get y(): number;
24
+ get screenX(): number;
25
+ get screenY(): number;
26
+ get width(): number;
27
+ get height(): number;
28
+ /** @internal Whether a listener needs the box's SCROLL request. */
29
+ abstract _listening(): boolean;
30
+ removeAllListeners(event?: string | symbol): this;
31
+ /** @internal Apply the option keys a part keeps, in order; the others are ignored. */
32
+ _assign(options: object | undefined, keys: readonly string[]): void;
33
+ }
34
+ /** A fill color, as `backgroundColor` on today's part boxes; transparent paints nothing. */
35
+ declare abstract class ScrollBoxFilledPart extends ScrollBoxPart {
36
+ private _backgroundColor?;
37
+ get backgroundColor(): RGBA;
38
+ set backgroundColor(value: ColorInput | null | undefined);
39
+ /** @internal */
40
+ _fill(): RGBA | undefined;
41
+ }
42
+ /** A part whose size changes reach `"resize"` listeners and `onSizeChange`. */
43
+ declare abstract class ScrollBoxSizedPart extends ScrollBoxFilledPart {
44
+ private _onSizeChange?;
45
+ constructor(box: ScrollBoxRenderable);
46
+ get onSizeChange(): (() => void) | undefined;
47
+ set onSizeChange(handler: (() => void) | null | undefined);
48
+ _listening(): boolean;
49
+ /** @internal */
50
+ _emitResize(): void;
51
+ }
52
+ /** The box's inner rect minus the vertical bar's gutter. */
53
+ export declare class ScrollBoxWrapper extends ScrollBoxFilledPart {
54
+ static readonly keys: readonly ["backgroundColor"];
55
+ _listening(): boolean;
56
+ protected rect(): NativeSceneRect;
57
+ }
58
+ /** The hidden viewport node: the culling window and the children's clip, with the viewport padding in cells. */
59
+ export declare class ScrollBoxViewport extends ScrollBoxSizedPart {
60
+ static readonly keys: string[];
61
+ private readonly paddings;
62
+ constructor(box: ScrollBoxRenderable);
63
+ protected rect(): NativeSceneRect;
64
+ private setPadding;
65
+ /** @internal Left, top, right, bottom, resolved like Yoga edges: an edge, then its axis, then all. */
66
+ _edges(): number[];
67
+ }
68
+ export interface ScrollBoxViewport {
69
+ padding: number | null | undefined;
70
+ paddingX: number | null | undefined;
71
+ paddingY: number | null | undefined;
72
+ get paddingLeft(): number;
73
+ set paddingLeft(value: number | null | undefined);
74
+ get paddingTop(): number;
75
+ set paddingTop(value: number | null | undefined);
76
+ get paddingRight(): number;
77
+ set paddingRight(value: number | null | undefined);
78
+ get paddingBottom(): number;
79
+ set paddingBottom(value: number | null | undefined);
80
+ }
81
+ /** The hidden content node: the box's children lay out in it, and it moves with the offset. */
82
+ export declare class ScrollBoxContent extends ScrollBoxSizedPart {
83
+ static readonly keys: string[];
84
+ private readonly styles;
85
+ constructor(box: ScrollBoxRenderable);
86
+ protected rect(): NativeSceneRect;
87
+ private setStyle;
88
+ /** @internal Whether children lay out in a row, by the direction native was given. */
89
+ get _row(): boolean;
90
+ get viewportCulling(): boolean;
91
+ set viewportCulling(value: boolean);
92
+ add(obj: Renderable | VNode<any, any[]>, index?: number): number;
93
+ insertBefore(obj: Renderable | VNode<any, any[]> | unknown, anchor?: Renderable | unknown): number;
94
+ remove(child: BaseRenderable): void;
95
+ getChildren(): Renderable[];
96
+ getChildrenCount(): number;
97
+ getRenderable(id: string): Renderable | undefined;
98
+ findDescendantById(id: string): Renderable | undefined;
99
+ }
100
+ /** A scrollbar: its track, thumb and arrows paint natively from the box's scroll state. */
101
+ export declare class ScrollBoxBar extends ScrollBoxPart {
102
+ static readonly keys: readonly ["visible", "showArrows", "arrowOptions", "trackOptions", "onChange", "width", "height", "paddingLeft", "paddingTop", "position", "scrollStep"];
103
+ readonly orientation: "vertical" | "horizontal";
104
+ scrollStep: number | undefined | null;
105
+ private readonly axis;
106
+ private policy;
107
+ private _showArrows;
108
+ private _arrowOptions;
109
+ private trackForeground;
110
+ private trackBackground;
111
+ private thickness;
112
+ private gap;
113
+ private overlay;
114
+ private _onChange?;
115
+ constructor(box: ScrollBoxRenderable, orientation: "vertical" | "horizontal");
116
+ protected rect(): NativeSceneRect;
117
+ _listening(): boolean;
118
+ /** @internal */
119
+ _native(): NativeSceneScrollBarOptions;
120
+ /** @internal The start and end arrows as native arrow options. */
121
+ _arrows(): {
122
+ attributes: number;
123
+ foregroundColor: RGBA;
124
+ backgroundColor: RGBA;
125
+ text?: string;
126
+ }[];
127
+ /** @internal */
128
+ _emitChange(position: number): void;
129
+ get visible(): boolean;
130
+ /** True and false hold the bar shown or hidden; a nullish write lets it follow the range again. */
131
+ set visible(value: boolean | null | undefined);
132
+ resetVisibilityControl(): void;
133
+ get onChange(): ((position: number) => void) | undefined;
134
+ set onChange(handler: ((position: number) => void) | null | undefined);
135
+ get showArrows(): boolean;
136
+ set showArrows(value: boolean | null | undefined);
137
+ set arrowOptions(options: Omit<ArrowOptions, "direction"> | null | undefined);
138
+ set trackOptions(options: {
139
+ foregroundColor?: ColorInput;
140
+ backgroundColor?: ColorInput;
141
+ } | null | undefined);
142
+ get width(): number;
143
+ set width(value: number | string | null | undefined);
144
+ get height(): number;
145
+ set height(value: number | string | null | undefined);
146
+ set paddingLeft(value: number | null | undefined);
147
+ set paddingTop(value: number | null | undefined);
148
+ /** An absolute bar overlays the content's edge instead of taking a gutter. */
149
+ set position(value: "absolute" | "relative" | null | undefined);
150
+ private setOption;
151
+ get scrollSize(): number;
152
+ get viewportSize(): number;
153
+ get scrollPosition(): number;
154
+ set scrollPosition(value: number);
155
+ scrollBy(delta: number, unit?: ScrollUnit): void;
156
+ handleKeyPress(key: KeyEvent): boolean;
157
+ }
158
+ type Edges = "" | "X" | "Y" | "Top" | "Right" | "Bottom" | "Left";
159
+ type ContentLayoutKey = "flexDirection" | "flexWrap" | "alignItems" | "justifyContent" | "alignSelf" | "flexGrow" | "flexShrink" | "flexBasis" | `${"min" | "max"}${"Width" | "Height"}` | `${"padding" | "margin"}${Edges}` | "gap" | "rowGap" | "columnGap";
160
+ export interface ScrollBoxContent extends ContentLayout {
161
+ }
162
+ type ContentLayout = {
163
+ [K in ContentLayoutKey]?: BoxOptions[K] | null;
164
+ };
165
+ export {};
@@ -1,4 +1,4 @@
1
- import { type RenderableOptions, Renderable } from "../Renderable.js";
1
+ import { type RenderableOptions, Renderable, type NativeRenderableIntegration } from "../Renderable.js";
2
2
  import { type RenderContext } from "../types.js";
3
3
  import { type ColorInput, RGBA } from "../lib/RGBA.js";
4
4
  import { OptimizedBuffer } from "../buffer.js";
@@ -13,7 +13,7 @@ export interface SliderOptions extends RenderableOptions<SliderRenderable> {
13
13
  onChange?: (value: number) => void;
14
14
  }
15
15
  export declare class SliderRenderable extends Renderable {
16
- static readonly nativeIntegration: import("../Renderable.js").NativeRenderableIntegration;
16
+ static readonly nativeIntegration: NativeRenderableIntegration;
17
17
  private _orientation;
18
18
  private _value;
19
19
  private _min;
@@ -1,4 +1,4 @@
1
- import { BaseRenderable } from "../Renderable.js";
1
+ import { BaseRenderable, type NativeRenderableIntegration } from "../Renderable.js";
2
2
  import { StyledText } from "../lib/styled-text.js";
3
3
  import { type TextChunk } from "../text-buffer.js";
4
4
  import { RGBA } from "../lib/RGBA.js";
@@ -9,7 +9,7 @@ export interface TextOptions extends TextBufferOptions {
9
9
  content?: StyledText | string;
10
10
  }
11
11
  export declare class TextRenderable extends TextBufferRenderable {
12
- static readonly nativeIntegration: import("../Renderable.js").NativeRenderableIntegration;
12
+ static readonly nativeIntegration: NativeRenderableIntegration;
13
13
  private _text;
14
14
  private _hasManualStyledText;
15
15
  protected rootTextNode: RootTextNodeRenderable;
@@ -1,4 +1,4 @@
1
- import { Renderable, type RenderableOptions } from "../Renderable.js";
1
+ import { Renderable, type RenderableOptions, type NativeRenderableIntegration } from "../Renderable.js";
2
2
  import { Selection, type LocalSelectionBounds } from "../lib/selection.js";
3
3
  import { TextBuffer } from "../text-buffer.js";
4
4
  import { TextBufferView } from "../text-buffer-view.js";
@@ -6,7 +6,6 @@ import { RGBA } from "../lib/RGBA.js";
6
6
  import { type RenderContext, type LineInfoProvider } from "../types.js";
7
7
  import type { OptimizedBuffer } from "../buffer.js";
8
8
  import type { LineInfo } from "../zig.js";
9
- import { SyntaxStyle } from "../syntax-style.js";
10
9
  export interface TextBufferOptions extends RenderableOptions<TextBufferRenderable> {
11
10
  fg?: string | RGBA;
12
11
  bg?: string | RGBA;
@@ -21,7 +20,7 @@ export interface TextBufferOptions extends RenderableOptions<TextBufferRenderabl
21
20
  truncate?: boolean;
22
21
  }
23
22
  export declare abstract class TextBufferRenderable extends Renderable implements LineInfoProvider {
24
- static readonly nativeIntegration: import("../Renderable.js").NativeRenderableIntegration;
23
+ static readonly nativeIntegration: NativeRenderableIntegration;
25
24
  protected _defaultFg: RGBA;
26
25
  protected _defaultBg: RGBA;
27
26
  protected _defaultAttributes: number;
@@ -38,7 +37,6 @@ export declare abstract class TextBufferRenderable extends Renderable implements
38
37
  protected _firstLineOffset: number;
39
38
  protected textBuffer: TextBuffer;
40
39
  protected textBufferView: TextBufferView;
41
- protected _textBufferSyntaxStyle: SyntaxStyle;
42
40
  private readonly nativeTextScene;
43
41
  protected _defaultOptions: {
44
42
  fg: RGBA;
@@ -13,7 +13,7 @@ export * from "./Image.js";
13
13
  export * from "./LineNumberRenderable.js";
14
14
  export * from "./Markdown.js";
15
15
  export * from "./ScrollBar.js";
16
- export { ScrollBoxRenderable, type ScrollBoxOptions } from "./ScrollBox.js";
16
+ export { ScrollBoxRenderable, ScrollBoxBar, ScrollBoxContent, ScrollBoxViewport, ScrollBoxWrapper, type ScrollBoxOptions, } from "./ScrollBox.js";
17
17
  export * from "./Select.js";
18
18
  export * from "./Slider.js";
19
19
  export * from "./TextTable.js";