@opentui/solid 0.0.0-20260412-2fcfd0af → 0.0.0-20260419-49f00f96
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/dist/index.d.ts +8 -0
- package/index.js +157 -15
- package/package.json +2 -2
- package/src/elements/hooks.d.ts +37 -2
- package/src/types/elements.d.ts +1 -0
package/dist/index.d.ts
CHANGED
|
@@ -5,9 +5,13 @@ export function useTerminalDimensions(): import("solid-js").Accessor<{
|
|
|
5
5
|
}>;
|
|
6
6
|
export function useSelectionHandler(callback: any): void;
|
|
7
7
|
export function useRenderer(): any;
|
|
8
|
+
export function usePendingSequence(): import("solid-js").Accessor<readonly import("@opentui/core/extras").KeySequencePart[]>;
|
|
8
9
|
export function usePaste(callback: any): void;
|
|
10
|
+
export function useKeymap(): import("@opentui/core/extras").Keymap;
|
|
9
11
|
export function useKeyboard(callback: any, options: any): void;
|
|
10
12
|
export function useKeyHandler(callback: any, options: any): void;
|
|
13
|
+
export function useBindings(layer: any): (value: any) => void;
|
|
14
|
+
export function useActiveKeys(options: any): import("solid-js").Accessor<readonly import("@opentui/core/extras").ActiveKey[]>;
|
|
11
15
|
export function use(fn: any, element: any, arg: any): any;
|
|
12
16
|
export var textNodeKeys: string[];
|
|
13
17
|
export function testRender(node: any, renderConfig?: {}): Promise<{
|
|
@@ -22,6 +26,10 @@ export function testRender(node: any, renderConfig?: {}): Promise<{
|
|
|
22
26
|
export function spread(node: any, accessor: any, skipChildren: any): void;
|
|
23
27
|
export function setProp(node: any, name: any, value: any, prev: any): any;
|
|
24
28
|
export function render(node: any, rendererOrConfig?: {}): Promise<void>;
|
|
29
|
+
export function reactiveMatcherFromSignal(accessor: any, predicate: any): {
|
|
30
|
+
get(): any;
|
|
31
|
+
subscribe(onChange: any): () => void;
|
|
32
|
+
};
|
|
25
33
|
export function onResize(callback: any): void;
|
|
26
34
|
export function onFocus(callback: any): void;
|
|
27
35
|
export function onBlur(callback: any): void;
|
package/index.js
CHANGED
|
@@ -26,7 +26,20 @@ import {
|
|
|
26
26
|
engine,
|
|
27
27
|
Timeline
|
|
28
28
|
} from "@opentui/core";
|
|
29
|
-
import {
|
|
29
|
+
import {
|
|
30
|
+
getKeymap
|
|
31
|
+
} from "@opentui/core/extras";
|
|
32
|
+
import {
|
|
33
|
+
createContext,
|
|
34
|
+
createEffect,
|
|
35
|
+
createMemo,
|
|
36
|
+
createRoot,
|
|
37
|
+
createSignal,
|
|
38
|
+
on,
|
|
39
|
+
onCleanup,
|
|
40
|
+
onMount,
|
|
41
|
+
useContext
|
|
42
|
+
} from "solid-js";
|
|
30
43
|
var RendererContext = createContext();
|
|
31
44
|
var useRenderer = () => {
|
|
32
45
|
const renderer = useContext(RendererContext);
|
|
@@ -79,6 +92,130 @@ var usePaste = (callback) => {
|
|
|
79
92
|
keyHandler.off("paste", callback);
|
|
80
93
|
});
|
|
81
94
|
};
|
|
95
|
+
function resolveBindingsTarget(target) {
|
|
96
|
+
if (typeof target === "function") {
|
|
97
|
+
return target() ?? undefined;
|
|
98
|
+
}
|
|
99
|
+
return target ?? undefined;
|
|
100
|
+
}
|
|
101
|
+
var useKeymap = () => {
|
|
102
|
+
const renderer = useRenderer();
|
|
103
|
+
return getKeymap(renderer);
|
|
104
|
+
};
|
|
105
|
+
function useKeymapStateVersion(keymap) {
|
|
106
|
+
const [version, setVersion] = createSignal(0);
|
|
107
|
+
let dispose;
|
|
108
|
+
onMount(() => {
|
|
109
|
+
dispose = keymap.on("state", () => {
|
|
110
|
+
setVersion((value) => value + 1);
|
|
111
|
+
});
|
|
112
|
+
setVersion((value) => value + 1);
|
|
113
|
+
});
|
|
114
|
+
onCleanup(() => {
|
|
115
|
+
dispose?.();
|
|
116
|
+
});
|
|
117
|
+
return version;
|
|
118
|
+
}
|
|
119
|
+
var useActiveKeys = (options) => {
|
|
120
|
+
const keymap = useKeymap();
|
|
121
|
+
const version = useKeymapStateVersion(keymap);
|
|
122
|
+
return createMemo(() => {
|
|
123
|
+
version();
|
|
124
|
+
return keymap.getActiveKeys(options);
|
|
125
|
+
});
|
|
126
|
+
};
|
|
127
|
+
var usePendingSequence = () => {
|
|
128
|
+
const keymap = useKeymap();
|
|
129
|
+
const version = useKeymapStateVersion(keymap);
|
|
130
|
+
return createMemo(() => {
|
|
131
|
+
version();
|
|
132
|
+
return keymap.getPendingSequence();
|
|
133
|
+
});
|
|
134
|
+
};
|
|
135
|
+
function useBindings(layer) {
|
|
136
|
+
const keymap = useKeymap();
|
|
137
|
+
let dispose;
|
|
138
|
+
let mounted = false;
|
|
139
|
+
let registered = false;
|
|
140
|
+
let registeredScope;
|
|
141
|
+
let refTarget;
|
|
142
|
+
const register = () => {
|
|
143
|
+
if (registered) {
|
|
144
|
+
return;
|
|
145
|
+
}
|
|
146
|
+
const explicitTarget = resolveBindingsTarget(layer.target);
|
|
147
|
+
const resolvedTarget = explicitTarget ?? refTarget;
|
|
148
|
+
const resolvedScope = layer.scope ?? (resolvedTarget ? "focus-within" : "global");
|
|
149
|
+
if (resolvedScope !== "global" && !resolvedTarget) {
|
|
150
|
+
return;
|
|
151
|
+
}
|
|
152
|
+
const { scope: _scope, target: _target, ...baseLayer } = layer;
|
|
153
|
+
let resolvedLayer;
|
|
154
|
+
if (resolvedScope === "global") {
|
|
155
|
+
resolvedLayer = {
|
|
156
|
+
...baseLayer,
|
|
157
|
+
scope: "global"
|
|
158
|
+
};
|
|
159
|
+
} else {
|
|
160
|
+
if (!resolvedTarget) {
|
|
161
|
+
return;
|
|
162
|
+
}
|
|
163
|
+
resolvedLayer = {
|
|
164
|
+
...baseLayer,
|
|
165
|
+
scope: resolvedScope,
|
|
166
|
+
target: resolvedTarget
|
|
167
|
+
};
|
|
168
|
+
}
|
|
169
|
+
dispose = keymap.registerLayer(resolvedLayer);
|
|
170
|
+
registered = true;
|
|
171
|
+
registeredScope = resolvedScope;
|
|
172
|
+
};
|
|
173
|
+
const ref = (value) => {
|
|
174
|
+
refTarget = value;
|
|
175
|
+
if (mounted) {
|
|
176
|
+
if (registered && layer.target === undefined && layer.scope === undefined && registeredScope === "global") {
|
|
177
|
+
dispose?.();
|
|
178
|
+
dispose = undefined;
|
|
179
|
+
registered = false;
|
|
180
|
+
registeredScope = undefined;
|
|
181
|
+
}
|
|
182
|
+
register();
|
|
183
|
+
}
|
|
184
|
+
};
|
|
185
|
+
onMount(() => {
|
|
186
|
+
mounted = true;
|
|
187
|
+
const resolvedTarget = resolveBindingsTarget(layer.target);
|
|
188
|
+
if (layer.target !== undefined && !resolvedTarget) {
|
|
189
|
+
throw new Error("useBindings target was not available during mount");
|
|
190
|
+
}
|
|
191
|
+
const resolvedScope = layer.scope ?? (resolvedTarget || refTarget ? "focus-within" : "global");
|
|
192
|
+
if (resolvedScope !== "global" && !resolvedTarget && !refTarget) {
|
|
193
|
+
throw new Error("useBindings local bindings need a target or the returned ref callback attached to a renderable");
|
|
194
|
+
}
|
|
195
|
+
register();
|
|
196
|
+
});
|
|
197
|
+
onCleanup(() => {
|
|
198
|
+
dispose?.();
|
|
199
|
+
dispose = undefined;
|
|
200
|
+
mounted = false;
|
|
201
|
+
registered = false;
|
|
202
|
+
registeredScope = undefined;
|
|
203
|
+
});
|
|
204
|
+
return ref;
|
|
205
|
+
}
|
|
206
|
+
function reactiveMatcherFromSignal(accessor, predicate) {
|
|
207
|
+
return {
|
|
208
|
+
get() {
|
|
209
|
+
return predicate ? predicate(accessor()) : Boolean(accessor());
|
|
210
|
+
},
|
|
211
|
+
subscribe(onChange) {
|
|
212
|
+
return createRoot((dispose) => {
|
|
213
|
+
createEffect(on(accessor, () => onChange(), { defer: true }));
|
|
214
|
+
return dispose;
|
|
215
|
+
});
|
|
216
|
+
}
|
|
217
|
+
};
|
|
218
|
+
}
|
|
82
219
|
var useKeyHandler = useKeyboard;
|
|
83
220
|
var onFocus = (callback) => {
|
|
84
221
|
const renderer = useRenderer();
|
|
@@ -122,7 +259,7 @@ var useTimeline = (options = {}) => {
|
|
|
122
259
|
return timeline;
|
|
123
260
|
};
|
|
124
261
|
// src/elements/extras.ts
|
|
125
|
-
import { createEffect, createMemo as
|
|
262
|
+
import { createEffect as createEffect2, createMemo as createMemo3, getOwner, onCleanup as onCleanup2, runWithOwner, splitProps, untrack as untrack2 } from "solid-js";
|
|
126
263
|
|
|
127
264
|
// src/reconciler.ts
|
|
128
265
|
import {
|
|
@@ -146,8 +283,8 @@ import { decodeHTML } from "entities";
|
|
|
146
283
|
import { useContext as useContext2 } from "solid-js";
|
|
147
284
|
|
|
148
285
|
// src/renderer/universal.js
|
|
149
|
-
import { createRoot, createRenderEffect, createMemo, createComponent, untrack, mergeProps } from "solid-js";
|
|
150
|
-
var memo = (fn) =>
|
|
286
|
+
import { createRoot as createRoot2, createRenderEffect, createMemo as createMemo2, createComponent, untrack, mergeProps } from "solid-js";
|
|
287
|
+
var memo = (fn) => createMemo2(() => fn());
|
|
151
288
|
function createRenderer({
|
|
152
289
|
createElement,
|
|
153
290
|
createTextNode,
|
|
@@ -374,7 +511,7 @@ function createRenderer({
|
|
|
374
511
|
return {
|
|
375
512
|
render(code, element) {
|
|
376
513
|
let disposer;
|
|
377
|
-
|
|
514
|
+
createRoot2((dispose) => {
|
|
378
515
|
disposer = dispose;
|
|
379
516
|
insert(element, code());
|
|
380
517
|
});
|
|
@@ -714,8 +851,8 @@ function Portal(props) {
|
|
|
714
851
|
const renderer = useRenderer();
|
|
715
852
|
const marker = createSlotNode(), mount = () => props.mount || renderer.root, owner = getOwner();
|
|
716
853
|
let content;
|
|
717
|
-
|
|
718
|
-
content || (content = runWithOwner(owner, () =>
|
|
854
|
+
createEffect2(() => {
|
|
855
|
+
content || (content = runWithOwner(owner, () => createMemo3(() => props.children)));
|
|
719
856
|
const el = mount();
|
|
720
857
|
const container = createElement("box"), renderRoot = container;
|
|
721
858
|
Object.defineProperty(container, "_$host", {
|
|
@@ -732,8 +869,8 @@ function Portal(props) {
|
|
|
732
869
|
return marker;
|
|
733
870
|
}
|
|
734
871
|
function createDynamic(component, props) {
|
|
735
|
-
const cached =
|
|
736
|
-
return
|
|
872
|
+
const cached = createMemo3(component);
|
|
873
|
+
return createMemo3(() => {
|
|
737
874
|
const component2 = cached();
|
|
738
875
|
switch (typeof component2) {
|
|
739
876
|
case "function":
|
|
@@ -965,7 +1102,7 @@ var TimeToFirstDraw = (props) => {
|
|
|
965
1102
|
};
|
|
966
1103
|
// src/plugins/slot.tsx
|
|
967
1104
|
import { createSlotRegistry } from "@opentui/core";
|
|
968
|
-
import { children, createMemo as
|
|
1105
|
+
import { children, createMemo as createMemo4, createSignal as createSignal2, ErrorBoundary, For, onCleanup as onCleanup3, splitProps as splitProps2 } from "solid-js";
|
|
969
1106
|
var EMPTY_ENTRY_IDS = [];
|
|
970
1107
|
function createSolidSlotRegistry(renderer, context, options = {}) {
|
|
971
1108
|
return createSlotRegistry(renderer, "solid:slot-registry", context, options);
|
|
@@ -1002,7 +1139,7 @@ function Slot(props) {
|
|
|
1002
1139
|
disposed = true;
|
|
1003
1140
|
unsubscribe();
|
|
1004
1141
|
});
|
|
1005
|
-
const entries =
|
|
1142
|
+
const entries = createMemo4((previousEntries = []) => {
|
|
1006
1143
|
version();
|
|
1007
1144
|
const resolvedEntries = registry().resolveEntries(local.name);
|
|
1008
1145
|
if (resolvedEntries.length === 0) {
|
|
@@ -1023,8 +1160,8 @@ function Slot(props) {
|
|
|
1023
1160
|
return previousEntries;
|
|
1024
1161
|
return nextEntries;
|
|
1025
1162
|
});
|
|
1026
|
-
const entryIds =
|
|
1027
|
-
const entriesById =
|
|
1163
|
+
const entryIds = createMemo4(() => entries().map((entry) => entry.id));
|
|
1164
|
+
const entriesById = createMemo4(() => new Map(entries().map((entry) => [entry.id, entry])));
|
|
1028
1165
|
const slotName = () => String(local.name);
|
|
1029
1166
|
const renderFallback = () => {
|
|
1030
1167
|
const value = children(() => local.children)();
|
|
@@ -1084,7 +1221,7 @@ function Slot(props) {
|
|
|
1084
1221
|
});
|
|
1085
1222
|
};
|
|
1086
1223
|
const AppendEntry = (appendProps) => {
|
|
1087
|
-
const entry =
|
|
1224
|
+
const entry = createMemo4(() => entriesById().get(appendProps.entryId));
|
|
1088
1225
|
return memo2(() => {
|
|
1089
1226
|
const resolvedEntry = entry();
|
|
1090
1227
|
if (!resolvedEntry) {
|
|
@@ -1093,7 +1230,7 @@ function Slot(props) {
|
|
|
1093
1230
|
return renderEntry(resolvedEntry);
|
|
1094
1231
|
});
|
|
1095
1232
|
};
|
|
1096
|
-
const appendEntryIds =
|
|
1233
|
+
const appendEntryIds = createMemo4(() => {
|
|
1097
1234
|
const mode = local.mode ?? "append";
|
|
1098
1235
|
if (mode !== "append") {
|
|
1099
1236
|
return EMPTY_ENTRY_IDS;
|
|
@@ -1206,15 +1343,20 @@ export {
|
|
|
1206
1343
|
useTerminalDimensions,
|
|
1207
1344
|
useSelectionHandler,
|
|
1208
1345
|
useRenderer,
|
|
1346
|
+
usePendingSequence,
|
|
1209
1347
|
usePaste,
|
|
1348
|
+
useKeymap,
|
|
1210
1349
|
useKeyboard,
|
|
1211
1350
|
useKeyHandler,
|
|
1351
|
+
useBindings,
|
|
1352
|
+
useActiveKeys,
|
|
1212
1353
|
use,
|
|
1213
1354
|
textNodeKeys,
|
|
1214
1355
|
testRender,
|
|
1215
1356
|
spread,
|
|
1216
1357
|
setProp,
|
|
1217
1358
|
render,
|
|
1359
|
+
reactiveMatcherFromSignal,
|
|
1218
1360
|
onResize,
|
|
1219
1361
|
onFocus,
|
|
1220
1362
|
onBlur,
|
package/package.json
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
"main": "index.js",
|
|
5
5
|
"types": "index.d.ts",
|
|
6
6
|
"type": "module",
|
|
7
|
-
"version": "0.0.0-
|
|
7
|
+
"version": "0.0.0-20260419-49f00f96",
|
|
8
8
|
"description": "SolidJS renderer for OpenTUI",
|
|
9
9
|
"license": "MIT",
|
|
10
10
|
"repository": {
|
|
@@ -35,7 +35,7 @@
|
|
|
35
35
|
"dependencies": {
|
|
36
36
|
"@babel/core": "7.28.0",
|
|
37
37
|
"@babel/preset-typescript": "7.27.1",
|
|
38
|
-
"@opentui/core": "0.0.0-
|
|
38
|
+
"@opentui/core": "0.0.0-20260419-49f00f96",
|
|
39
39
|
"babel-plugin-module-resolver": "5.0.2",
|
|
40
40
|
"babel-preset-solid": "1.9.10",
|
|
41
41
|
"entities": "7.0.1",
|
package/src/elements/hooks.d.ts
CHANGED
|
@@ -1,8 +1,10 @@
|
|
|
1
|
-
import { PasteEvent, Selection, Timeline, type CliRenderer, type KeyEvent, type TimelineOptions } from "@opentui/core";
|
|
1
|
+
import { PasteEvent, type Renderable, Selection, Timeline, type CliRenderer, type KeyEvent, type TimelineOptions } from "@opentui/core";
|
|
2
|
+
import { type ActiveKey, type ActiveKeyOptions, type LayerFields, type Keymap, type ReactiveMatcher, type KeySequencePart } from "@opentui/core/extras";
|
|
3
|
+
import { type Accessor } from "solid-js";
|
|
2
4
|
export declare const RendererContext: import("solid-js").Context<CliRenderer | undefined>;
|
|
3
5
|
export declare const useRenderer: () => CliRenderer;
|
|
4
6
|
export declare const onResize: (callback: (width: number, height: number) => void) => void;
|
|
5
|
-
export declare const useTerminalDimensions: () =>
|
|
7
|
+
export declare const useTerminalDimensions: () => Accessor<{
|
|
6
8
|
width: number;
|
|
7
9
|
height: number;
|
|
8
10
|
}>;
|
|
@@ -28,6 +30,38 @@ export interface UseKeyboardOptions {
|
|
|
28
30
|
*/
|
|
29
31
|
export declare const useKeyboard: (callback: (key: KeyEvent) => void, options?: UseKeyboardOptions) => void;
|
|
30
32
|
export declare const usePaste: (callback: (event: PasteEvent) => void) => void;
|
|
33
|
+
export type UseBindingsTarget<TRenderable extends Renderable = Renderable> = TRenderable | null | undefined | (() => TRenderable | null | undefined);
|
|
34
|
+
type UseBindingsLayerBase = LayerFields;
|
|
35
|
+
export type BindingsRef<TRenderable extends Renderable = Renderable> = (value: TRenderable) => void;
|
|
36
|
+
export interface UseGlobalBindingsLayer extends UseBindingsLayerBase {
|
|
37
|
+
scope?: "global";
|
|
38
|
+
target?: undefined;
|
|
39
|
+
}
|
|
40
|
+
export interface UseFocusBindingsLayer<TRenderable extends Renderable = Renderable> extends UseBindingsLayerBase {
|
|
41
|
+
scope: "focus";
|
|
42
|
+
target?: UseBindingsTarget<TRenderable>;
|
|
43
|
+
}
|
|
44
|
+
export interface UseFocusWithinBindingsLayer<TRenderable extends Renderable = Renderable> extends UseBindingsLayerBase {
|
|
45
|
+
scope: "focus-within";
|
|
46
|
+
target?: UseBindingsTarget<TRenderable>;
|
|
47
|
+
}
|
|
48
|
+
export interface UseInferredFocusWithinBindingsLayer<TRenderable extends Renderable = Renderable> extends UseBindingsLayerBase {
|
|
49
|
+
scope?: undefined;
|
|
50
|
+
target: UseBindingsTarget<TRenderable>;
|
|
51
|
+
}
|
|
52
|
+
export type UseTargetBindingsLayer<TRenderable extends Renderable = Renderable> = UseFocusBindingsLayer<TRenderable> | UseFocusWithinBindingsLayer<TRenderable> | UseInferredFocusWithinBindingsLayer<TRenderable>;
|
|
53
|
+
export type UseBindingsLayer<TRenderable extends Renderable = Renderable> = UseGlobalBindingsLayer | UseTargetBindingsLayer<TRenderable>;
|
|
54
|
+
export declare const useKeymap: () => Keymap;
|
|
55
|
+
export declare const useActiveKeys: (options?: ActiveKeyOptions) => Accessor<readonly ActiveKey[]>;
|
|
56
|
+
export declare const usePendingSequence: () => Accessor<readonly KeySequencePart[]>;
|
|
57
|
+
export declare function useBindings<TRenderable extends Renderable = Renderable>(layer: UseGlobalBindingsLayer): BindingsRef<TRenderable>;
|
|
58
|
+
export declare function useBindings<TRenderable extends Renderable = Renderable>(layer: UseTargetBindingsLayer<TRenderable>): BindingsRef<TRenderable>;
|
|
59
|
+
/**
|
|
60
|
+
* Adapts a Solid accessor to `ReactiveMatcher`. The subscription
|
|
61
|
+
* lives in a disposable reactive root so unregistering the layer tears it
|
|
62
|
+
* down. Pass `predicate` when the accessor value is not already boolean.
|
|
63
|
+
*/
|
|
64
|
+
export declare function reactiveMatcherFromSignal<T>(accessor: Accessor<T>, predicate?: (value: T) => boolean): ReactiveMatcher;
|
|
31
65
|
/**
|
|
32
66
|
* @deprecated renamed to useKeyboard
|
|
33
67
|
*/
|
|
@@ -36,3 +70,4 @@ export declare const onFocus: (callback: () => void) => void;
|
|
|
36
70
|
export declare const onBlur: (callback: () => void) => void;
|
|
37
71
|
export declare const useSelectionHandler: (callback: (selection: Selection) => void) => void;
|
|
38
72
|
export declare const useTimeline: (options?: TimelineOptions) => Timeline;
|
|
73
|
+
export {};
|
package/src/types/elements.d.ts
CHANGED
|
@@ -6,6 +6,7 @@ export type NonStyledProps = "id" | "buffered" | "live" | "enableLayout" | "sele
|
|
|
6
6
|
/** Solid-specific props for all components */
|
|
7
7
|
export type ElementProps<TRenderable = unknown> = {
|
|
8
8
|
ref?: Ref<TRenderable>;
|
|
9
|
+
[eventName: `on:${string}`]: ((...args: any[]) => void) | undefined;
|
|
9
10
|
};
|
|
10
11
|
/** Base type for any renderable constructor */
|
|
11
12
|
export type RenderableConstructor<TRenderable extends BaseRenderable = BaseRenderable> = new (ctx: RenderContext, options: any) => TRenderable;
|