@fundamental-engine/react 0.4.0 → 0.5.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/README.md +0 -5
- package/dist/index.d.ts +2 -1
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +16 -11
- package/dist/index.js.map +1 -1
- package/package.json +3 -3
package/README.md
CHANGED
|
@@ -124,11 +124,6 @@ To apply a named recipe or bind data to the field, use `applyRecipe()` / `bindDa
|
|
|
124
124
|
[`@fundamental-engine/platform`](../platform) against a ref'd container. Browse all 64 recipes at
|
|
125
125
|
[`/docs/gallery`](https://fundamental-engine.com/docs/gallery).
|
|
126
126
|
|
|
127
|
-
## Aliases
|
|
128
|
-
|
|
129
|
-
`ForcesField` / `useForcesField` and `ForcesFieldProps` are deprecated aliases of `FieldField` /
|
|
130
|
-
`useFieldField` / `FieldFieldProps`, kept for the `forces-ui` → `field-ui` rename.
|
|
131
|
-
|
|
132
127
|
## Related
|
|
133
128
|
|
|
134
129
|
[`@fundamental-engine/core`](../core) · [`@fundamental-engine/platform`](../platform) · [`@fundamental-engine/elements`](../elements)
|
package/dist/index.d.ts
CHANGED
|
@@ -20,7 +20,7 @@ export interface FieldFieldProps extends FieldOptions {
|
|
|
20
20
|
/** called once the field is created, with its handle (scan/burst/setAccent/…). */
|
|
21
21
|
onReady?: (field: FieldHandle) => void;
|
|
22
22
|
}
|
|
23
|
-
export declare function FieldField({ className, style, onReady, accent, density, waves, background, render, overlay, mass, palette, attention, causality, }: FieldFieldProps): ReactElement;
|
|
23
|
+
export declare function FieldField({ className, style, onReady, accent, density, depth, waves, background, render, overlay, overlayBackend, mass, palette, attention, causality, heatmap, dprCap, rng, now, feedbackSink, }: FieldFieldProps): ReactElement;
|
|
24
24
|
/**
|
|
25
25
|
* Hook form — returns a ref to attach to your own `<canvas>` and the live handle.
|
|
26
26
|
* Use when you need to own the canvas element (sizing, placement) yourself.
|
|
@@ -29,4 +29,5 @@ export declare function useFieldField(opts?: FieldOptions): {
|
|
|
29
29
|
canvasRef: RefObject<HTMLCanvasElement | null>;
|
|
30
30
|
fieldRef: RefObject<FieldHandle | null>;
|
|
31
31
|
};
|
|
32
|
+
export type { FieldHandle, FieldOptions, Vec2, AgentSpec, AgentHandle, AtomPayload, FeedbackSink, FeedbackChannels, } from '@fundamental-engine/core';
|
|
32
33
|
//# sourceMappingURL=index.d.ts.map
|
package/dist/index.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.tsx"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;GAaG;AAGH,OAAO,KAAK,EAAE,aAAa,EAAE,YAAY,EAAE,SAAS,EAAE,MAAM,OAAO,CAAC;AACpE,OAAO,EAAsB,KAAK,WAAW,EAAE,KAAK,YAAY,EAAqB,MAAM,0BAA0B,CAAC;AAGtH,MAAM,WAAW,eAAgB,SAAQ,YAAY;IACnD,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,KAAK,CAAC,EAAE,aAAa,CAAC;IACtB,kFAAkF;IAClF,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,WAAW,KAAK,IAAI,CAAC;CAGxC;AAKD,wBAAgB,UAAU,CAAC,EACzB,SAAS,EACT,KAAK,EACL,OAAO,EACP,MAAM,EACN,OAAO,EACP,KAAK,EACL,UAAU,EACV,MAAM,EACN,OAAO,EACP,IAAI,EACJ,OAAO,EACP,SAAS,EACT,SAAS,
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.tsx"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;GAaG;AAGH,OAAO,KAAK,EAAE,aAAa,EAAE,YAAY,EAAE,SAAS,EAAE,MAAM,OAAO,CAAC;AACpE,OAAO,EAAsB,KAAK,WAAW,EAAE,KAAK,YAAY,EAAqB,MAAM,0BAA0B,CAAC;AAGtH,MAAM,WAAW,eAAgB,SAAQ,YAAY;IACnD,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,KAAK,CAAC,EAAE,aAAa,CAAC;IACtB,kFAAkF;IAClF,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,WAAW,KAAK,IAAI,CAAC;CAGxC;AAKD,wBAAgB,UAAU,CAAC,EACzB,SAAS,EACT,KAAK,EACL,OAAO,EACP,MAAM,EACN,OAAO,EACP,KAAK,EACL,KAAK,EACL,UAAU,EACV,MAAM,EACN,OAAO,EACP,cAAc,EACd,IAAI,EACJ,OAAO,EACP,SAAS,EACT,SAAS,EACT,OAAO,EACP,MAAM,EACN,GAAG,EACH,GAAG,EACH,YAAY,GACb,EAAE,eAAe,GAAG,YAAY,CA2ChC;AAED;;;GAGG;AACH,wBAAgB,aAAa,CAAC,IAAI,GAAE,YAAiB,GAAG;IACtD,SAAS,EAAE,SAAS,CAAC,iBAAiB,GAAG,IAAI,CAAC,CAAC;IAC/C,QAAQ,EAAE,SAAS,CAAC,WAAW,GAAG,IAAI,CAAC,CAAC;CACzC,CAwCA;AAID,YAAY,EACV,WAAW,EACX,YAAY,EACZ,IAAI,EACJ,SAAS,EACT,WAAW,EACX,WAAW,EACX,YAAY,EACZ,gBAAgB,GACjB,MAAM,0BAA0B,CAAC"}
|
package/dist/index.js
CHANGED
|
@@ -18,7 +18,7 @@ import { FIELD_CANVAS_STYLE } from '@fundamental-engine/core';
|
|
|
18
18
|
import { createBrowserField } from '@fundamental-engine/platform';
|
|
19
19
|
// the fixed, click-through surface — shared with the vanilla mount via core/surface.ts.
|
|
20
20
|
const FIXED = FIELD_CANVAS_STYLE;
|
|
21
|
-
export function FieldField({ className, style, onReady, accent, density, waves, background, render, overlay, mass, palette, attention, causality, }) {
|
|
21
|
+
export function FieldField({ className, style, onReady, accent, density, depth, waves, background, render, overlay, overlayBackend, mass, palette, attention, causality, heatmap, dprCap, rng, now, feedbackSink, }) {
|
|
22
22
|
const canvasRef = useRef(null);
|
|
23
23
|
const onReadyRef = useRef(onReady);
|
|
24
24
|
onReadyRef.current = onReady;
|
|
@@ -39,9 +39,10 @@ export function FieldField({ className, style, onReady, accent, density, waves,
|
|
|
39
39
|
overlayCanvasRef.current = oc;
|
|
40
40
|
}
|
|
41
41
|
const field = createBrowserField(canvas, {
|
|
42
|
-
accent, density, waves, background, render,
|
|
43
|
-
overlay, overlayCanvas: overlayCanvasRef.current ?? undefined,
|
|
44
|
-
mass, palette, attention, causality,
|
|
42
|
+
accent, density, depth, waves, background, render,
|
|
43
|
+
overlay, overlayCanvas: overlayCanvasRef.current ?? undefined, overlayBackend,
|
|
44
|
+
mass, palette, attention, causality, heatmap, dprCap,
|
|
45
|
+
rng, now, feedbackSink,
|
|
45
46
|
});
|
|
46
47
|
onReadyRef.current?.(field);
|
|
47
48
|
return () => {
|
|
@@ -50,8 +51,10 @@ export function FieldField({ className, style, onReady, accent, density, waves,
|
|
|
50
51
|
overlayCanvasRef.current?.remove();
|
|
51
52
|
overlayCanvasRef.current = null;
|
|
52
53
|
};
|
|
53
|
-
// re-create only when
|
|
54
|
-
|
|
54
|
+
// re-create only when a declarative engine option actually changes. The determinism/feedback
|
|
55
|
+
// seams (rng/now/feedbackSink/overlayBackend) are config-set-once — forwarded above, but kept
|
|
56
|
+
// out of the dep list so an inline value passed each render doesn't thrash the field.
|
|
57
|
+
}, [accent, density, depth, waves, background, render, overlay, mass, palette, attention, causality, heatmap, dprCap]);
|
|
55
58
|
return (_jsx("canvas", { ref: canvasRef, "aria-hidden": "true", className: className, style: { ...FIXED, ...style } }));
|
|
56
59
|
}
|
|
57
60
|
/**
|
|
@@ -63,7 +66,7 @@ export function useFieldField(opts = {}) {
|
|
|
63
66
|
const fieldRef = useRef(null);
|
|
64
67
|
/** Field Surfaces: the front overlay surface this hook owns, lazily created. */
|
|
65
68
|
const overlayCanvasRef = useRef(null);
|
|
66
|
-
const { accent, density, waves, background, render, overlay, mass, palette, attention, causality } = opts;
|
|
69
|
+
const { accent, density, depth, waves, background, render, overlay, overlayBackend, mass, palette, attention, causality, heatmap, dprCap, rng, now, feedbackSink, } = opts;
|
|
67
70
|
useEffect(() => {
|
|
68
71
|
const canvas = canvasRef.current;
|
|
69
72
|
if (!canvas)
|
|
@@ -78,9 +81,10 @@ export function useFieldField(opts = {}) {
|
|
|
78
81
|
overlayCanvasRef.current = oc;
|
|
79
82
|
}
|
|
80
83
|
const field = createBrowserField(canvas, {
|
|
81
|
-
accent, density, waves, background, render,
|
|
82
|
-
overlay, overlayCanvas: overlayCanvasRef.current ?? undefined,
|
|
83
|
-
mass, palette, attention, causality,
|
|
84
|
+
accent, density, depth, waves, background, render,
|
|
85
|
+
overlay, overlayCanvas: overlayCanvasRef.current ?? undefined, overlayBackend,
|
|
86
|
+
mass, palette, attention, causality, heatmap, dprCap,
|
|
87
|
+
rng, now, feedbackSink,
|
|
84
88
|
});
|
|
85
89
|
fieldRef.current = field;
|
|
86
90
|
return () => {
|
|
@@ -90,7 +94,8 @@ export function useFieldField(opts = {}) {
|
|
|
90
94
|
overlayCanvasRef.current?.remove();
|
|
91
95
|
overlayCanvasRef.current = null;
|
|
92
96
|
};
|
|
93
|
-
|
|
97
|
+
// declarative options drive recreation; the seams (rng/now/feedbackSink/overlayBackend) forward but stay out of deps.
|
|
98
|
+
}, [accent, density, depth, waves, background, render, overlay, mass, palette, attention, causality, heatmap, dprCap]);
|
|
94
99
|
return { canvasRef, fieldRef };
|
|
95
100
|
}
|
|
96
101
|
//# sourceMappingURL=index.js.map
|
package/dist/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.tsx"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;GAaG;AAEH,OAAO,EAAE,SAAS,EAAE,MAAM,EAAE,MAAM,OAAO,CAAC;AAE1C,OAAO,EAAE,kBAAkB,EAA0D,MAAM,0BAA0B,CAAC;AACtH,OAAO,EAAE,kBAAkB,EAAE,MAAM,8BAA8B,CAAC;AAWlE,wFAAwF;AACxF,MAAM,KAAK,GAAG,kBAAmC,CAAC;AAElD,MAAM,UAAU,UAAU,CAAC,EACzB,SAAS,EACT,KAAK,EACL,OAAO,EACP,MAAM,EACN,OAAO,EACP,KAAK,EACL,UAAU,EACV,MAAM,EACN,OAAO,EACP,IAAI,EACJ,OAAO,EACP,SAAS,EACT,SAAS,
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.tsx"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;GAaG;AAEH,OAAO,EAAE,SAAS,EAAE,MAAM,EAAE,MAAM,OAAO,CAAC;AAE1C,OAAO,EAAE,kBAAkB,EAA0D,MAAM,0BAA0B,CAAC;AACtH,OAAO,EAAE,kBAAkB,EAAE,MAAM,8BAA8B,CAAC;AAWlE,wFAAwF;AACxF,MAAM,KAAK,GAAG,kBAAmC,CAAC;AAElD,MAAM,UAAU,UAAU,CAAC,EACzB,SAAS,EACT,KAAK,EACL,OAAO,EACP,MAAM,EACN,OAAO,EACP,KAAK,EACL,KAAK,EACL,UAAU,EACV,MAAM,EACN,OAAO,EACP,cAAc,EACd,IAAI,EACJ,OAAO,EACP,SAAS,EACT,SAAS,EACT,OAAO,EACP,MAAM,EACN,GAAG,EACH,GAAG,EACH,YAAY,GACI;IAChB,MAAM,SAAS,GAAG,MAAM,CAAoB,IAAI,CAAC,CAAC;IAClD,MAAM,UAAU,GAAG,MAAM,CAAC,OAAO,CAAC,CAAC;IACnC,UAAU,CAAC,OAAO,GAAG,OAAO,CAAC;IAC7B,qFAAqF;IACrF,MAAM,gBAAgB,GAAG,MAAM,CAA2B,IAAI,CAAC,CAAC;IAEhE,SAAS,CAAC,GAAG,EAAE;QACb,MAAM,MAAM,GAAG,SAAS,CAAC,OAAO,CAAC;QACjC,IAAI,CAAC,MAAM;YAAE,OAAO;QAEpB,qFAAqF;QACrF,qFAAqF;QACrF,IAAI,OAAO,KAAK,SAAS,IAAI,OAAO,KAAK,KAAK,IAAI,CAAC,gBAAgB,CAAC,OAAO,IAAI,OAAO,QAAQ,KAAK,WAAW,EAAE,CAAC;YAC/G,MAAM,EAAE,GAAG,QAAQ,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC;YAC5C,EAAE,CAAC,YAAY,CAAC,aAAa,EAAE,MAAM,CAAC,CAAC;YACvC,EAAE,CAAC,KAAK,CAAC,OAAO;gBACd,mGAAmG,CAAC;YACtG,QAAQ,CAAC,IAAI,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC;YAC9B,gBAAgB,CAAC,OAAO,GAAG,EAAE,CAAC;QAChC,CAAC;QAED,MAAM,KAAK,GAAG,kBAAkB,CAAC,MAAM,EAAE;YACvC,MAAM,EAAE,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,UAAU,EAAE,MAAM;YACjD,OAAO,EAAE,aAAa,EAAE,gBAAgB,CAAC,OAAO,IAAI,SAAS,EAAE,cAAc;YAC7E,IAAI,EAAE,OAAO,EAAE,SAAS,EAAE,SAAS,EAAE,OAAO,EAAE,MAAM;YACpD,GAAG,EAAE,GAAG,EAAE,YAAY;SACvB,CAAC,CAAC;QACH,UAAU,CAAC,OAAO,EAAE,CAAC,KAAK,CAAC,CAAC;QAC5B,OAAO,GAAG,EAAE;YACV,KAAK,CAAC,OAAO,EAAE,CAAC;YAChB,6EAA6E;YAC7E,gBAAgB,CAAC,OAAO,EAAE,MAAM,EAAE,CAAC;YACnC,gBAAgB,CAAC,OAAO,GAAG,IAAI,CAAC;QAClC,CAAC,CAAC;QACF,6FAA6F;QAC7F,8FAA8F;QAC9F,sFAAsF;IACxF,CAAC,EAAE,CAAC,MAAM,EAAE,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,UAAU,EAAE,MAAM,EAAE,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,SAAS,EAAE,SAAS,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC,CAAC;IAEvH,OAAO,CACL,iBAAQ,GAAG,EAAE,SAAS,iBAAc,MAAM,EAAC,SAAS,EAAE,SAAS,EAAE,KAAK,EAAE,EAAE,GAAG,KAAK,EAAE,GAAG,KAAK,EAAE,GAAI,CACnG,CAAC;AACJ,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,aAAa,CAAC,OAAqB,EAAE;IAInD,MAAM,SAAS,GAAG,MAAM,CAAoB,IAAI,CAAC,CAAC;IAClD,MAAM,QAAQ,GAAG,MAAM,CAAqB,IAAI,CAAC,CAAC;IAClD,gFAAgF;IAChF,MAAM,gBAAgB,GAAG,MAAM,CAA2B,IAAI,CAAC,CAAC;IAChE,MAAM,EACJ,MAAM,EAAE,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,UAAU,EAAE,MAAM,EAAE,OAAO,EAAE,cAAc,EAC1E,IAAI,EAAE,OAAO,EAAE,SAAS,EAAE,SAAS,EAAE,OAAO,EAAE,MAAM,EAAE,GAAG,EAAE,GAAG,EAAE,YAAY,GAC7E,GAAG,IAAI,CAAC;IACT,SAAS,CAAC,GAAG,EAAE;QACb,MAAM,MAAM,GAAG,SAAS,CAAC,OAAO,CAAC;QACjC,IAAI,CAAC,MAAM;YAAE,OAAO;QAEpB,yFAAyF;QACzF,IAAI,OAAO,KAAK,SAAS,IAAI,OAAO,KAAK,KAAK,IAAI,CAAC,gBAAgB,CAAC,OAAO,IAAI,OAAO,QAAQ,KAAK,WAAW,EAAE,CAAC;YAC/G,MAAM,EAAE,GAAG,QAAQ,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC;YAC5C,EAAE,CAAC,YAAY,CAAC,aAAa,EAAE,MAAM,CAAC,CAAC;YACvC,EAAE,CAAC,KAAK,CAAC,OAAO;gBACd,mGAAmG,CAAC;YACtG,QAAQ,CAAC,IAAI,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC;YAC9B,gBAAgB,CAAC,OAAO,GAAG,EAAE,CAAC;QAChC,CAAC;QAED,MAAM,KAAK,GAAG,kBAAkB,CAAC,MAAM,EAAE;YACvC,MAAM,EAAE,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,UAAU,EAAE,MAAM;YACjD,OAAO,EAAE,aAAa,EAAE,gBAAgB,CAAC,OAAO,IAAI,SAAS,EAAE,cAAc;YAC7E,IAAI,EAAE,OAAO,EAAE,SAAS,EAAE,SAAS,EAAE,OAAO,EAAE,MAAM;YACpD,GAAG,EAAE,GAAG,EAAE,YAAY;SACvB,CAAC,CAAC;QACH,QAAQ,CAAC,OAAO,GAAG,KAAK,CAAC;QACzB,OAAO,GAAG,EAAE;YACV,KAAK,CAAC,OAAO,EAAE,CAAC;YAChB,QAAQ,CAAC,OAAO,GAAG,IAAI,CAAC;YACxB,wEAAwE;YACxE,gBAAgB,CAAC,OAAO,EAAE,MAAM,EAAE,CAAC;YACnC,gBAAgB,CAAC,OAAO,GAAG,IAAI,CAAC;QAClC,CAAC,CAAC;QACF,sHAAsH;IACxH,CAAC,EAAE,CAAC,MAAM,EAAE,OAAO,EAAE,KAAK,EAAE,KAAK,EAAE,UAAU,EAAE,MAAM,EAAE,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,SAAS,EAAE,SAAS,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC,CAAC;IACvH,OAAO,EAAE,SAAS,EAAE,QAAQ,EAAE,CAAC;AACjC,CAAC"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@fundamental-engine/react",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.5.1",
|
|
4
4
|
"description": "React adapter for Fundamental — a reciprocal DOM-physics field as a <FieldField> component + useFieldField hook.",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"license": "MIT",
|
|
@@ -45,8 +45,8 @@
|
|
|
45
45
|
"access": "public"
|
|
46
46
|
},
|
|
47
47
|
"dependencies": {
|
|
48
|
-
"@fundamental-engine/
|
|
49
|
-
"@fundamental-engine/
|
|
48
|
+
"@fundamental-engine/core": "0.5.1",
|
|
49
|
+
"@fundamental-engine/platform": "0.5.1"
|
|
50
50
|
},
|
|
51
51
|
"peerDependencies": {
|
|
52
52
|
"react": ">=18"
|