@particle-academy/fancy-echarts 3.0.1 → 4.0.0

package/README.md

@@ -1,6 +1,8 @@
 # @particle-academy/fancy-echarts
 
-React component library wrapping [Apache ECharts](https://echarts.apache.org/) with typed components for every chart type — 2D, 3D, and graphic layers.
+Typed React wrapper around [Apache ECharts](https://echarts.apache.org/) — every chart type from a single `<EChart>` component, lazy module registration, four built-in themes.
+
+> **Breaking change in 4.0** — the hand-rolled diagram subsystem (`<Diagram>`, `<DataDiagram>`, `<OrgChart>`, `<Mindmap>`, `<Flowchart>` and their types) is removed. ECharts and react-flow each own their domain: charts here, node-edge graphs in [`@particle-academy/fancy-flow`](https://github.com/Particle-Academy/fancy-flow). If you used the diagram presets, migrate to fancy-flow — its `<FlowEditor>` + `defineNode` + `<NodePort>` covers org charts, flowcharts, ERDs, and mindmaps cleanly. Real Sankey / sunburst / radial visualizations stay here as proper ECharts series.
 
 ## Installation
 
@@ -261,6 +263,24 @@ import { DataDiagram, Flowchart, Mindmap, OrgChart } from "@particle-academy/fan
 
 See [docs/Diagram.md](docs/Diagram.md) for schemas, props, and layout details.
 
+## Inertia.js integration
+
+If your app uses Inertia, install [`@particle-academy/fancy-inertia`](https://github.com/Particle-Academy/fancy-inertia). Three things to know:
+
+1. **`<FancyAppRoot withECharts>`** auto-calls `registerAll()` and `registerBuiltinThemes()` on the client only — drop it once at app entry and every page below it has charts ready.
+2. **SSR**: every fancy-echarts component (`<EChart>`, `<EChart3D>`, `<EChartGraphic>`, and the diagram presets) needs `window` to initialize. Wrap in `<FancyClientOnly>` if Inertia SSR is enabled.
+3. **Schema mode**: pass `withECharts: true` to `registerFancyComponents()` and your fancy-screens schemas can reference `EChart`, `DataDiagram`, `Flowchart`, `Mindmap`, `OrgChart` by name from server-supplied JSON.
+
+```tsx
+import { FancyAppRoot, FancyClientOnly } from "@particle-academy/fancy-inertia";
+
+<FancyAppRoot withECharts>
+  <FancyClientOnly fallback={<div className="h-80 animate-pulse rounded bg-zinc-100" />}>
+    <EChart option={option} />
+  </FancyClientOnly>
+</FancyAppRoot>
+```
+
 ## Documentation
 
 Full component documentation is available in the [docs/](docs/) folder: