@opentui/react 0.7.0 → 0.8.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/{chunk-wfns8g9a.js → chunk-9ek0nnx3.js} +6 -3
- package/index.js +31 -18
- package/jsx-namespace.d.ts +2 -0
- package/package.json +2 -2
- package/src/components/index.d.ts +2 -1
- package/src/hooks/index.d.ts +1 -0
- package/src/hooks/use-animation-tick.d.ts +4 -0
- package/src/types/components.d.ts +3 -2
- package/test-utils.js +1 -1
|
@@ -13,7 +13,8 @@ import {
|
|
|
13
13
|
SelectRenderable,
|
|
14
14
|
TabSelectRenderable,
|
|
15
15
|
TextareaRenderable,
|
|
16
|
-
TextRenderable
|
|
16
|
+
TextRenderable,
|
|
17
|
+
VideoRenderable
|
|
17
18
|
} from "@opentui/core";
|
|
18
19
|
|
|
19
20
|
// src/components/text.ts
|
|
@@ -95,6 +96,7 @@ var baseComponents2 = {
|
|
|
95
96
|
"tab-select": TabSelectRenderable,
|
|
96
97
|
"line-number": LineNumberRenderable,
|
|
97
98
|
image: ImageRenderable,
|
|
99
|
+
video: VideoRenderable,
|
|
98
100
|
span: SpanRenderable,
|
|
99
101
|
br: LineBreakRenderable,
|
|
100
102
|
b: BoldSpanRenderable,
|
|
@@ -164,7 +166,7 @@ import { ImageRenderable as ImageRenderable2, TextNodeRenderable as TextNodeRend
|
|
|
164
166
|
// package.json
|
|
165
167
|
var package_default = {
|
|
166
168
|
name: "@opentui/react",
|
|
167
|
-
version: "0.
|
|
169
|
+
version: "0.8.1",
|
|
168
170
|
description: "React renderer for building terminal user interfaces using OpenTUI core",
|
|
169
171
|
license: "MIT",
|
|
170
172
|
repository: {
|
|
@@ -396,7 +398,8 @@ var hostConfig = {
|
|
|
396
398
|
}
|
|
397
399
|
return new components[type](rootContainerInstance.ctx, {
|
|
398
400
|
id,
|
|
399
|
-
...initialInstanceProps(type, props)
|
|
401
|
+
...initialInstanceProps(type, props),
|
|
402
|
+
..."crop" in props && { crop: undefined }
|
|
400
403
|
});
|
|
401
404
|
},
|
|
402
405
|
appendChild(parent, child) {
|
package/index.js
CHANGED
|
@@ -11,8 +11,8 @@ import {
|
|
|
11
11
|
flushSync2,
|
|
12
12
|
createPortal2,
|
|
13
13
|
createRoot2
|
|
14
|
-
} from "./chunk-
|
|
15
|
-
// src/hooks/use-
|
|
14
|
+
} from "./chunk-9ek0nnx3.js";
|
|
15
|
+
// src/hooks/use-animation-tick.ts
|
|
16
16
|
import { useEffect } from "react";
|
|
17
17
|
|
|
18
18
|
// src/hooks/use-event.ts
|
|
@@ -37,11 +37,23 @@ var useRenderer = () => {
|
|
|
37
37
|
return renderer;
|
|
38
38
|
};
|
|
39
39
|
|
|
40
|
+
// src/hooks/use-animation-tick.ts
|
|
41
|
+
var useAnimationTick = (fps, callback, options) => {
|
|
42
|
+
const renderer = useRenderer();
|
|
43
|
+
const tick = useEffectEvent(callback);
|
|
44
|
+
const tolerance = options?.tolerance;
|
|
45
|
+
useEffect(() => {
|
|
46
|
+
if (fps === undefined)
|
|
47
|
+
return;
|
|
48
|
+
return renderer.onAnimationTick(fps, (...args) => flushSync2(() => tick(...args)), { tolerance });
|
|
49
|
+
}, [renderer, fps, tolerance]);
|
|
50
|
+
};
|
|
40
51
|
// src/hooks/use-blur.ts
|
|
52
|
+
import { useEffect as useEffect2 } from "react";
|
|
41
53
|
var useBlur = (handler) => {
|
|
42
54
|
const renderer = useRenderer();
|
|
43
55
|
const stableHandler = useEffectEvent(handler);
|
|
44
|
-
|
|
56
|
+
useEffect2(() => {
|
|
45
57
|
renderer.on("blur", stableHandler);
|
|
46
58
|
return () => {
|
|
47
59
|
renderer.off("blur", stableHandler);
|
|
@@ -49,11 +61,11 @@ var useBlur = (handler) => {
|
|
|
49
61
|
}, [renderer]);
|
|
50
62
|
};
|
|
51
63
|
// src/hooks/use-focus.ts
|
|
52
|
-
import { useEffect as
|
|
64
|
+
import { useEffect as useEffect3 } from "react";
|
|
53
65
|
var useFocus = (handler) => {
|
|
54
66
|
const renderer = useRenderer();
|
|
55
67
|
const stableHandler = useEffectEvent(handler);
|
|
56
|
-
|
|
68
|
+
useEffect3(() => {
|
|
57
69
|
renderer.on("focus", stableHandler);
|
|
58
70
|
return () => {
|
|
59
71
|
renderer.off("focus", stableHandler);
|
|
@@ -61,11 +73,11 @@ var useFocus = (handler) => {
|
|
|
61
73
|
}, [renderer]);
|
|
62
74
|
};
|
|
63
75
|
// src/hooks/use-keyboard.ts
|
|
64
|
-
import { useEffect as
|
|
76
|
+
import { useEffect as useEffect4 } from "react";
|
|
65
77
|
var useKeyboard = (handler, options = { release: false }) => {
|
|
66
78
|
const { keyHandler } = useAppContext2();
|
|
67
79
|
const stableHandler = useEffectEvent(handler);
|
|
68
|
-
|
|
80
|
+
useEffect4(() => {
|
|
69
81
|
keyHandler?.on("keypress", stableHandler);
|
|
70
82
|
if (options?.release) {
|
|
71
83
|
keyHandler?.on("keyrelease", stableHandler);
|
|
@@ -79,11 +91,11 @@ var useKeyboard = (handler, options = { release: false }) => {
|
|
|
79
91
|
}, [keyHandler, options.release]);
|
|
80
92
|
};
|
|
81
93
|
// src/hooks/use-paste.ts
|
|
82
|
-
import { useEffect as
|
|
94
|
+
import { useEffect as useEffect5 } from "react";
|
|
83
95
|
var usePaste = (handler) => {
|
|
84
96
|
const { keyHandler } = useAppContext2();
|
|
85
97
|
const stableHandler = useEffectEvent(handler);
|
|
86
|
-
|
|
98
|
+
useEffect5(() => {
|
|
87
99
|
keyHandler?.on("paste", stableHandler);
|
|
88
100
|
return () => {
|
|
89
101
|
keyHandler?.off("paste", stableHandler);
|
|
@@ -91,11 +103,11 @@ var usePaste = (handler) => {
|
|
|
91
103
|
}, [keyHandler]);
|
|
92
104
|
};
|
|
93
105
|
// src/hooks/use-resize.ts
|
|
94
|
-
import { useEffect as
|
|
106
|
+
import { useEffect as useEffect6 } from "react";
|
|
95
107
|
var useOnResize = (callback) => {
|
|
96
108
|
const renderer = useRenderer();
|
|
97
109
|
const stableCallback = useEffectEvent(callback);
|
|
98
|
-
|
|
110
|
+
useEffect6(() => {
|
|
99
111
|
renderer.on("resize", stableCallback);
|
|
100
112
|
return () => {
|
|
101
113
|
renderer.off("resize", stableCallback);
|
|
@@ -104,11 +116,11 @@ var useOnResize = (callback) => {
|
|
|
104
116
|
return renderer;
|
|
105
117
|
};
|
|
106
118
|
// src/hooks/use-selection.ts
|
|
107
|
-
import { useEffect as
|
|
119
|
+
import { useEffect as useEffect7 } from "react";
|
|
108
120
|
var useSelectionHandler = (handler) => {
|
|
109
121
|
const renderer = useRenderer();
|
|
110
122
|
const stableHandler = useEffectEvent(handler);
|
|
111
|
-
|
|
123
|
+
useEffect7(() => {
|
|
112
124
|
renderer.on("selection", stableHandler);
|
|
113
125
|
return () => {
|
|
114
126
|
renderer.off("selection", stableHandler);
|
|
@@ -131,12 +143,12 @@ var useTerminalDimensions = () => {
|
|
|
131
143
|
};
|
|
132
144
|
// src/hooks/use-timeline.ts
|
|
133
145
|
import { getTimelineEngine, Timeline } from "@opentui/core";
|
|
134
|
-
import { useEffect as
|
|
146
|
+
import { useEffect as useEffect8, useState as useState2 } from "react";
|
|
135
147
|
var useTimeline = (options = {}) => {
|
|
136
148
|
const renderer = useRenderer();
|
|
137
149
|
const [timeline] = useState2(() => new Timeline(options));
|
|
138
150
|
const [autoplay] = useState2(options.autoplay !== false);
|
|
139
|
-
|
|
151
|
+
useEffect8(() => {
|
|
140
152
|
const engine = getTimelineEngine(renderer);
|
|
141
153
|
if (autoplay) {
|
|
142
154
|
timeline.play();
|
|
@@ -156,7 +168,7 @@ var useTimeline = (options = {}) => {
|
|
|
156
168
|
import {
|
|
157
169
|
createSlotRegistry
|
|
158
170
|
} from "@opentui/core";
|
|
159
|
-
import React, { Fragment as Fragment2, useEffect as
|
|
171
|
+
import React, { Fragment as Fragment2, useEffect as useEffect9, useMemo, useRef as useRef2, useState as useState3 } from "react";
|
|
160
172
|
function createReactSlotRegistry(renderer, context, options = {}) {
|
|
161
173
|
return createSlotRegistry(renderer, "react:slot-registry", context, options);
|
|
162
174
|
}
|
|
@@ -235,12 +247,12 @@ function Slot(props) {
|
|
|
235
247
|
const slotName = String(props.name);
|
|
236
248
|
const renderFailuresByPluginRef = useRef2(new Map);
|
|
237
249
|
const pendingRenderReportsRef = useRef2(new Map);
|
|
238
|
-
|
|
250
|
+
useEffect9(() => {
|
|
239
251
|
return registry.subscribe(() => {
|
|
240
252
|
setVersion((current) => current + 1);
|
|
241
253
|
});
|
|
242
254
|
}, [registry]);
|
|
243
|
-
|
|
255
|
+
useEffect9(() => {
|
|
244
256
|
if (pendingRenderReportsRef.current.size === 0) {
|
|
245
257
|
return;
|
|
246
258
|
}
|
|
@@ -383,6 +395,7 @@ export {
|
|
|
383
395
|
extend2 as extend,
|
|
384
396
|
flushSync2 as flushSync,
|
|
385
397
|
getComponentCatalogue2 as getComponentCatalogue,
|
|
398
|
+
useAnimationTick,
|
|
386
399
|
useAppContext2 as useAppContext,
|
|
387
400
|
useBlur,
|
|
388
401
|
useFocus,
|
package/jsx-namespace.d.ts
CHANGED
|
@@ -18,6 +18,7 @@ import type {
|
|
|
18
18
|
TabSelectProps,
|
|
19
19
|
TextareaProps,
|
|
20
20
|
TextProps,
|
|
21
|
+
VideoProps,
|
|
21
22
|
} from "./src/types/components.js"
|
|
22
23
|
|
|
23
24
|
export namespace JSX {
|
|
@@ -52,6 +53,7 @@ export namespace JSX {
|
|
|
52
53
|
"tab-select": TabSelectProps
|
|
53
54
|
"line-number": LineNumberProps
|
|
54
55
|
image: ImageProps
|
|
56
|
+
video: VideoProps
|
|
55
57
|
// Text modifiers
|
|
56
58
|
b: SpanProps
|
|
57
59
|
i: SpanProps
|
package/package.json
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
"main": "index.js",
|
|
5
5
|
"types": "src/index.d.ts",
|
|
6
6
|
"type": "module",
|
|
7
|
-
"version": "0.
|
|
7
|
+
"version": "0.8.1",
|
|
8
8
|
"description": "React renderer for building terminal user interfaces using OpenTUI core",
|
|
9
9
|
"license": "MIT",
|
|
10
10
|
"repository": {
|
|
@@ -52,7 +52,7 @@
|
|
|
52
52
|
}
|
|
53
53
|
},
|
|
54
54
|
"dependencies": {
|
|
55
|
-
"@opentui/core": "0.
|
|
55
|
+
"@opentui/core": "0.8.1",
|
|
56
56
|
"react-reconciler": "^0.33.0"
|
|
57
57
|
},
|
|
58
58
|
"devDependencies": {
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { ASCIIFontRenderable, BoxRenderable, CodeRenderable, DiffRenderable, ImageRenderable, InputRenderable, LineNumberRenderable, MarkdownRenderable, ScrollBoxRenderable, SelectRenderable, TabSelectRenderable, TextareaRenderable, TextRenderable } from "@opentui/core";
|
|
1
|
+
import { ASCIIFontRenderable, BoxRenderable, CodeRenderable, DiffRenderable, ImageRenderable, InputRenderable, LineNumberRenderable, MarkdownRenderable, ScrollBoxRenderable, SelectRenderable, TabSelectRenderable, TextareaRenderable, TextRenderable, VideoRenderable } from "@opentui/core";
|
|
2
2
|
import type { RenderableConstructor } from "../types/components.js";
|
|
3
3
|
import { BoldSpanRenderable, ItalicSpanRenderable, LineBreakRenderable, LinkRenderable, SpanRenderable, UnderlineSpanRenderable } from "./text.js";
|
|
4
4
|
export declare const baseComponents: {
|
|
@@ -15,6 +15,7 @@ export declare const baseComponents: {
|
|
|
15
15
|
"tab-select": typeof TabSelectRenderable;
|
|
16
16
|
"line-number": typeof LineNumberRenderable;
|
|
17
17
|
image: typeof ImageRenderable;
|
|
18
|
+
video: typeof VideoRenderable;
|
|
18
19
|
span: typeof SpanRenderable;
|
|
19
20
|
br: typeof LineBreakRenderable;
|
|
20
21
|
b: typeof BoldSpanRenderable;
|
package/src/hooks/index.d.ts
CHANGED
|
@@ -0,0 +1,4 @@
|
|
|
1
|
+
import type { AnimationTickCallback, AnimationTickOptions } from "@opentui/core";
|
|
2
|
+
/** Ticks `callback` at `fps` on the renderer's shared animation clock; an undefined rate pauses it. State updates
|
|
3
|
+
* inside the callback commit synchronously, so they draw in the tick's frame. */
|
|
4
|
+
export declare const useAnimationTick: (fps: number | undefined, callback: AnimationTickCallback, options?: AnimationTickOptions) => void;
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import type { ASCIIFontOptions, ASCIIFontRenderable, BaseRenderable, BoxOptions, BoxRenderable, CodeOptions, CodeRenderable, DiffRenderable, DiffRenderableOptions, ImageRenderable, ImageRenderableOptions, InputRenderable, InputRenderableOptions, LineNumberOptions, LineNumberRenderable, MarkdownOptions, MarkdownRenderable, RenderableOptions, RenderContext, ScrollBoxOptions, ScrollBoxRenderable, SelectOption, SelectRenderable, SelectRenderableOptions, TabSelectOption, TabSelectRenderable, TabSelectRenderableOptions, TextareaOptions, TextareaRenderable, TextNodeOptions, TextNodeRenderable, TextOptions, TextRenderable, CursorChangeEvent, ContentChangeEvent, KeyEvent } from "@opentui/core";
|
|
1
|
+
import type { ASCIIFontOptions, ASCIIFontRenderable, BaseRenderable, BoxOptions, BoxRenderable, CodeOptions, CodeRenderable, DiffRenderable, DiffRenderableOptions, ImageRenderable, ImageRenderableOptions, InputRenderable, InputRenderableOptions, LineNumberOptions, LineNumberRenderable, MarkdownOptions, MarkdownRenderable, RenderableOptions, RenderContext, ScrollBoxOptions, ScrollBoxRenderable, SelectOption, SelectRenderable, SelectRenderableOptions, TabSelectOption, TabSelectRenderable, TabSelectRenderableOptions, TextareaOptions, TextareaRenderable, TextNodeOptions, TextNodeRenderable, TextOptions, TextRenderable, VideoRenderable, VideoRenderableOptions, CursorChangeEvent, ContentChangeEvent, KeyEvent } from "@opentui/core";
|
|
2
2
|
import type React from "react";
|
|
3
3
|
/** Properties that should not be included in the style prop */
|
|
4
4
|
export type NonStyledProps = "id" | "buffered" | "live" | "enableLayout" | "selectable" | "renderAfter" | "renderBefore" | `on${string}`;
|
|
@@ -14,7 +14,7 @@ type ExtractRenderableOptions<TConstructor> = TConstructor extends new (ctx: Ren
|
|
|
14
14
|
/** Extract the renderable type from a constructor */
|
|
15
15
|
type ExtractRenderable<TConstructor> = TConstructor extends new (ctx: RenderContext, options: any) => infer TRenderable ? TRenderable : never;
|
|
16
16
|
/** Determine which properties should be excluded from styling for different renderable types */
|
|
17
|
-
export type GetNonStyledProperties<TConstructor> = TConstructor extends RenderableConstructor<TextRenderable> ? NonStyledProps | "content" : TConstructor extends RenderableConstructor<BoxRenderable> ? NonStyledProps | "title" | "bottomTitle" : TConstructor extends RenderableConstructor<ASCIIFontRenderable> ? NonStyledProps | "text" | "selectable" : TConstructor extends RenderableConstructor<InputRenderable> ? NonStyledProps | "placeholder" | "value" : TConstructor extends RenderableConstructor<TextareaRenderable> ? NonStyledProps | "placeholder" | "initialValue" : TConstructor extends RenderableConstructor<CodeRenderable> ? NonStyledProps | "content" | "filetype" | "syntaxStyle" | "treeSitterClient" | "conceal" | "drawUnstyledText" : TConstructor extends RenderableConstructor<MarkdownRenderable> ? NonStyledProps | "content" | "syntaxStyle" | "treeSitterClient" | "conceal" | "renderNode" : TConstructor extends RenderableConstructor<ImageRenderable> ? NonStyledProps | "source" : NonStyledProps;
|
|
17
|
+
export type GetNonStyledProperties<TConstructor> = TConstructor extends RenderableConstructor<TextRenderable> ? NonStyledProps | "content" : TConstructor extends RenderableConstructor<BoxRenderable> ? NonStyledProps | "title" | "bottomTitle" : TConstructor extends RenderableConstructor<ASCIIFontRenderable> ? NonStyledProps | "text" | "selectable" : TConstructor extends RenderableConstructor<InputRenderable> ? NonStyledProps | "placeholder" | "value" : TConstructor extends RenderableConstructor<TextareaRenderable> ? NonStyledProps | "placeholder" | "initialValue" : TConstructor extends RenderableConstructor<CodeRenderable> ? NonStyledProps | "content" | "filetype" | "syntaxStyle" | "treeSitterClient" | "conceal" | "drawUnstyledText" : TConstructor extends RenderableConstructor<MarkdownRenderable> ? NonStyledProps | "content" | "syntaxStyle" | "treeSitterClient" | "conceal" | "renderNode" : TConstructor extends RenderableConstructor<ImageRenderable> ? NonStyledProps | "source" : TConstructor extends RenderableConstructor<VideoRenderable> ? NonStyledProps | "source" | "autoplay" | "loop" | "audio" | "muted" | "volume" | "avSyncOffsetMs" | "maxFps" : NonStyledProps;
|
|
18
18
|
/** Base props for container components that accept children */
|
|
19
19
|
type ContainerProps<TOptions> = TOptions & {
|
|
20
20
|
children?: React.ReactNode;
|
|
@@ -53,6 +53,7 @@ export type TextareaProps = ComponentProps<TextareaOptions, TextareaRenderable>
|
|
|
53
53
|
};
|
|
54
54
|
export type CodeProps = ComponentProps<CodeOptions, CodeRenderable>;
|
|
55
55
|
export type ImageProps = ComponentProps<ImageRenderableOptions, ImageRenderable>;
|
|
56
|
+
export type VideoProps = ComponentProps<VideoRenderableOptions, VideoRenderable>;
|
|
56
57
|
export type MarkdownProps = ComponentProps<MarkdownOptions, MarkdownRenderable>;
|
|
57
58
|
export type DiffProps = ComponentProps<DiffRenderableOptions, DiffRenderable>;
|
|
58
59
|
export type SelectProps = ComponentProps<SelectRenderableOptions, SelectRenderable> & {
|