@object-ui/plugin-dashboard 4.0.10 → 4.0.12

package/CHANGELOG.md

@@ -1,5 +1,28 @@
 # @object-ui/plugin-dashboard
 
+## 4.0.12
+
+### Patch Changes
+
+- @object-ui/types@4.0.12
+- @object-ui/core@4.0.12
+- @object-ui/i18n@4.0.12
+- @object-ui/react@4.0.12
+- @object-ui/components@4.0.12
+- @object-ui/fields@4.0.12
+
+## 4.0.11
+
+### Patch Changes
+
+- Updated dependencies [1909bc3]
+  - @object-ui/i18n@4.0.11
+  - @object-ui/components@4.0.11
+  - @object-ui/fields@4.0.11
+  - @object-ui/react@4.0.11
+  - @object-ui/types@4.0.11
+  - @object-ui/core@4.0.11
+
 ## 4.0.10
 
 ### Patch Changes

package/README.md

@@ -270,6 +270,50 @@ auto-detection.
 }
 ```
 
+## DashboardGridLayout — persisting drag / resize edits
+
+### DashboardRenderer — design-mode widget reorder
+
+When `DashboardRenderer` is used in design mode (`designMode={true}` plus an
+`onWidgetsReorder` callback), widgets become sortable via
+[**@dnd-kit**](https://dndkit.com/). Dragging a widget over another inserts
+it at that index (insertion semantics, not swap) — the array order *is* the
+visual order because widgets render with `gridColumn: span W`. The renderer
+calls `onWidgetsReorder(nextWidgets)` with the reordered array; the host (e.g.
+`DashboardView`) is responsible for persisting the change via its DataSource.
+
+A 5px pointer-activation distance keeps click-to-select working on the same
+widget surface.
+
+## DashboardGridLayout — persisting drag / resize edits
+
+`DashboardGridLayout` (registered as schema `type: 'dashboard-grid'`) has an
+inline **"Edit Layout"** mode that lets users drag and resize widgets via
+`react-grid-layout`. When the user clicks **Save Layout**, the new grid
+coordinates are merged back into `schema.widgets[].layout` and handed off
+through the `onSchemaChange` callback.
+
+```tsx
+<DashboardGridLayout
+  schema={dashboard}
+  // ✅ Preferred — write the updated schema through your data adapter.
+  onSchemaChange={(next) => client.meta.saveItem('dashboard', next.name, next)}
+/>
+```
+
+If `onSchemaChange` is **not** provided, layout edits stay in component
+state and are lost on refresh — a `console.warn` is emitted in development
+to flag the missing wiring. The component never writes to `localStorage`
+or any other storage on its own: persistence is the parent's concern,
+delegated to whatever data adapter you have injected (REST, ObjectQL,
+file system, …) per the protocol-agnostic architecture rule.
+
+> ⚠️ **Removed in 3.4:** the legacy `persistLayoutKey` prop and its
+> built-in localStorage fallback have been removed. Previously a shared
+> default key `'dashboard-layout'` caused layouts to bleed across
+> dashboards. If you still want a browser-local cache for a demo, do it
+> in the parent inside `onSchemaChange`.
+
 <!-- release-metadata:v3.3.0 -->
 
 ## Compatibility