@ea-lab/reactive-json-docs 0.1.10 → 0.1.11
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/package.json +2 -2
- package/public/rjbuild/docs/chartjs/overview.yaml +1 -1
- package/public/rjbuild/docs/core/element/special/ReactiveJsonSubroot.md +2 -2
- package/public/rjbuild/docs/core/element/special/ReactiveJsonSubroot.yaml +5 -5
- package/public/rjbuild/docs/install.md +3 -3
- package/public/rjbuild/docs/install.yaml +6 -6
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@ea-lab/reactive-json-docs",
|
|
3
|
-
"version": "0.1.
|
|
3
|
+
"version": "0.1.11",
|
|
4
4
|
"description": "Complete documentation for Reactive-JSON - Components, examples and LLM-parsable guides",
|
|
5
5
|
"main": "public/rjbuild/docs/index.yaml",
|
|
6
6
|
"files": [
|
|
@@ -26,7 +26,7 @@
|
|
|
26
26
|
"private": false,
|
|
27
27
|
"devDependencies": {
|
|
28
28
|
"@craco/craco": "^7.1.0",
|
|
29
|
-
"@ea-lab/reactive-json": "^0.0.
|
|
29
|
+
"@ea-lab/reactive-json": "^0.0.45",
|
|
30
30
|
"@ea-lab/reactive-json-chartjs": "^0.0.23",
|
|
31
31
|
"@npmcli/fs": "^4.0.0",
|
|
32
32
|
"@reduxjs/toolkit": "^2.6.1",
|
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
The `ReactiveJsonSubroot` component allows you to render a new Reactive-JSON root inside an existing application. It is useful for embedding a sub-application, isolating a part of the data tree, or rendering a separate rjbuild with its own options.
|
|
6
6
|
|
|
7
7
|
## Properties
|
|
8
|
-
- `rjOptions` (object, required): Options to pass to the subroot (such as `
|
|
8
|
+
- `rjOptions` (object, required): Options to pass to the subroot (such as `rjBuildUrl`, `data`, `renderView`, etc.)
|
|
9
9
|
- Other properties are passed to the underlying `ReactiveJsonRoot`
|
|
10
10
|
|
|
11
11
|
## Behavior
|
|
@@ -19,7 +19,7 @@ The `ReactiveJsonSubroot` component allows you to render a new Reactive-JSON roo
|
|
|
19
19
|
renderView:
|
|
20
20
|
- type: ReactiveJsonSubroot
|
|
21
21
|
rjOptions:
|
|
22
|
-
|
|
22
|
+
rjBuildUrl: "/rjs-build/home.yaml"
|
|
23
23
|
```
|
|
24
24
|
|
|
25
25
|
## Limitations
|
|
@@ -6,7 +6,7 @@ renderView:
|
|
|
6
6
|
The `ReactiveJsonSubroot` component allows you to render a new Reactive-JSON root inside an existing application. It is useful for embedding a sub-application, isolating a part of the data tree, or rendering a separate rjbuild with its own options.
|
|
7
7
|
|
|
8
8
|
## Properties
|
|
9
|
-
- `rjOptions` (object, required): Options to pass to the subroot (such as `
|
|
9
|
+
- `rjOptions` (object, required): Options to pass to the subroot (such as `rjBuildUrl`, `data`, `renderView`, etc.)
|
|
10
10
|
- Other properties are passed to the underlying `ReactiveJsonRoot`
|
|
11
11
|
|
|
12
12
|
## Behavior
|
|
@@ -22,16 +22,16 @@ renderView:
|
|
|
22
22
|
renderView:
|
|
23
23
|
- type: ReactiveJsonSubroot
|
|
24
24
|
rjOptions:
|
|
25
|
-
|
|
25
|
+
rjBuildUrl: "/rjbuild/component/message.yaml"
|
|
26
26
|
|
|
27
27
|
- type: RjBuildDescriber
|
|
28
28
|
title: Example with inline JSON data
|
|
29
|
-
description: This example demonstrates two approaches for using ReactiveJsonSubroot with inline data. The first shows passing JSON data directly as a string via
|
|
29
|
+
description: This example demonstrates two approaches for using ReactiveJsonSubroot with inline data. The first shows passing JSON data directly as a string via maybeRawAppRjBuild. The second shows loading subroot options dynamically from the main RjBuild's data using template interpolation. Both approaches are useful for embedding sub-applications without external files.
|
|
30
30
|
toDescribe:
|
|
31
31
|
renderView:
|
|
32
32
|
- type: ReactiveJsonSubroot
|
|
33
33
|
rjOptions:
|
|
34
|
-
|
|
34
|
+
maybeRawAppRjBuild: '{"data":{"userName":"Alice","messageCount":3},"renderView":[{"type":"div","attributes":{"style":{"padding":"1rem","border":"1px solid #ddd","borderRadius":"8px","backgroundColor":"#f9f9f9"}},"content":[{"type":"h3","content":"~~.userName"},{"type":"p","content":["You have ","~~.messageCount"," new messages."]},{"type":"button","content":"Mark as read","attributes":{"style":{"backgroundColor":"#007bff","color":"white","border":"none","padding":"0.5rem 1rem","borderRadius":"4px"}}}]}]}'
|
|
35
35
|
|
|
36
36
|
- type: hr
|
|
37
37
|
|
|
@@ -39,7 +39,7 @@ renderView:
|
|
|
39
39
|
rjOptions: ~~.subrootToLoad
|
|
40
40
|
data:
|
|
41
41
|
subrootToLoad:
|
|
42
|
-
|
|
42
|
+
maybeRawAppRjBuild:
|
|
43
43
|
renderView:
|
|
44
44
|
- type: div
|
|
45
45
|
content: This second subroot is loaded from the "data" key of the main root.
|
|
@@ -243,7 +243,7 @@ import { ReactiveJsonRoot } from '@ea-lab/reactive-json'
|
|
|
243
243
|
import 'bootstrap/dist/css/bootstrap.min.css'
|
|
244
244
|
|
|
245
245
|
function App() {
|
|
246
|
-
return <ReactiveJsonRoot
|
|
246
|
+
return <ReactiveJsonRoot rjBuildUrl="/config.yaml" rjBuildFetchMethod="GET" />
|
|
247
247
|
}
|
|
248
248
|
|
|
249
249
|
export default App
|
|
@@ -350,8 +350,8 @@ function App() {
|
|
|
350
350
|
path={route.path}
|
|
351
351
|
element={
|
|
352
352
|
<ReactiveJsonRoot
|
|
353
|
-
|
|
354
|
-
|
|
353
|
+
rjBuildUrl={route.rjbuild}
|
|
354
|
+
rjBuildFetchMethod="GET"
|
|
355
355
|
/>
|
|
356
356
|
}
|
|
357
357
|
/>
|
|
@@ -248,7 +248,7 @@ renderView:
|
|
|
248
248
|
import 'bootstrap/dist/css/bootstrap.min.css'
|
|
249
249
|
|
|
250
250
|
function App() {
|
|
251
|
-
return <ReactiveJsonRoot
|
|
251
|
+
return <ReactiveJsonRoot rjBuildUrl="/config.yaml" rjBuildFetchMethod="GET" />
|
|
252
252
|
}
|
|
253
253
|
|
|
254
254
|
export default App
|
|
@@ -355,8 +355,8 @@ renderView:
|
|
|
355
355
|
path={route.path}
|
|
356
356
|
element={
|
|
357
357
|
<ReactiveJsonRoot
|
|
358
|
-
|
|
359
|
-
|
|
358
|
+
rjBuildUrl={route.rjbuild}
|
|
359
|
+
rjBuildFetchMethod="GET"
|
|
360
360
|
/>
|
|
361
361
|
}
|
|
362
362
|
/>
|
|
@@ -663,7 +663,7 @@ renderView:
|
|
|
663
663
|
import 'bootstrap/dist/css/bootstrap.min.css'
|
|
664
664
|
|
|
665
665
|
function App() {
|
|
666
|
-
return <ReactiveJsonRoot
|
|
666
|
+
return <ReactiveJsonRoot rjBuildUrl="/config.yaml" rjBuildFetchMethod="GET" />
|
|
667
667
|
}
|
|
668
668
|
|
|
669
669
|
export default App
|
|
@@ -784,8 +784,8 @@ renderView:
|
|
|
784
784
|
path={route.path}
|
|
785
785
|
element={
|
|
786
786
|
<ReactiveJsonRoot
|
|
787
|
-
|
|
788
|
-
|
|
787
|
+
rjBuildUrl={route.rjbuild}
|
|
788
|
+
rjBuildFetchMethod="GET"
|
|
789
789
|
/>
|
|
790
790
|
}
|
|
791
791
|
/>
|