react-dockable-desktop 7.7.4 → 7.8.0
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/CHANGELOG.md +50 -1
- package/README.md +5 -3
- package/dist/index.cjs +6 -6
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +39 -0
- package/dist/index.d.ts +39 -0
- package/dist/index.js +6 -6
- package/dist/index.js.map +1 -1
- package/dist/styles.css +7 -0
- package/package.json +1 -1
package/CHANGELOG.md
CHANGED
|
@@ -10,6 +10,54 @@ replacement and the version that removes the old API.
|
|
|
10
10
|
|
|
11
11
|
## [Unreleased]
|
|
12
12
|
|
|
13
|
+
## [7.8.0] — 2026-10-06
|
|
14
|
+
|
|
15
|
+
More control over how the desktop looks and where panels open, all opt-in: without the new options,
|
|
16
|
+
nothing changes. The API check confirms every change is an addition.
|
|
17
|
+
|
|
18
|
+
### Added
|
|
19
|
+
|
|
20
|
+
- **Your own empty-workspace view.** `<RddDesktop emptyWorkspace={<Welcome />}>` shows your element
|
|
21
|
+
while no panel is docked, in place of the built-in "Empty Workspace Section" message: a welcome
|
|
22
|
+
screen, a logo, "Open a file" buttons. Floating windows still show over it, and a window can still
|
|
23
|
+
be dropped onto it to dock. Other empty groups in a split keep the built-in message.
|
|
24
|
+
- **Open a panel beside another.** `openPanel(id, component, { dockTo: { panel, position, size } })`
|
|
25
|
+
docks a new panel as a tab in that panel's group (`position: 'center'`) or in a new group split off
|
|
26
|
+
on one side, taking `size` (0.1–0.9) of the split. It wins over `initialTarget`. If the target
|
|
27
|
+
panel isn't docked, the new panel is placed as usual, with a development warning.
|
|
28
|
+
- **State attributes for your CSS.** Tabs carry `data-rdd-selected` (shown in their group),
|
|
29
|
+
`data-rdd-focused` (the workspace's active panel) and `data-rdd-dirty`; floating windows carry
|
|
30
|
+
`data-rdd-focused` and `data-rdd-maximized`. Each is present only while it is true, so
|
|
31
|
+
`[data-rdd-dirty]` styles unsaved panels without relying on internal class names. The existing
|
|
32
|
+
classes are unchanged.
|
|
33
|
+
- **Per-panel-type classes.** `className` and `tabClassName` in a panel type's `defaultOptions`
|
|
34
|
+
add your class to every panel of that type (on its content element, which moves with it) and to
|
|
35
|
+
its tab.
|
|
36
|
+
- **`keepAlive: false`**, per panel type: the component unmounts while the panel is an unselected
|
|
37
|
+
tab or minimized, and mounts afresh when shown, to free what a heavy, rarely shown panel holds.
|
|
38
|
+
Its own state is lost each time; its tab, title and lifecycle continue, and `onClose` is called
|
|
39
|
+
only when it is really closed. The taskbar shows a placeholder preview for it. The default is
|
|
40
|
+
unchanged: panels stay mounted and keep their state.
|
|
41
|
+
|
|
42
|
+
### Docs
|
|
43
|
+
|
|
44
|
+
- New page, **[Using it with MUI, Bootstrap or Tailwind](https://felipecarrillo100.github.io/react-dockable-desktop/guide/ui-frameworks)**:
|
|
45
|
+
dark-mode bridging for each, the z-index of the library's layers next to the frameworks', why a
|
|
46
|
+
framework popup opened inside one of the library's modals appears behind it and the two fixes,
|
|
47
|
+
resets, and the order to try when overriding styles.
|
|
48
|
+
- Theming: **Styling by state and by panel type**. Layout: **Opening beside another panel**. Panel
|
|
49
|
+
Registry: **Freeing a hidden panel**. The `openPanel` options, `RddDesktop` props and
|
|
50
|
+
`defaultOptions` tables list the new options.
|
|
51
|
+
|
|
52
|
+
### Tests
|
|
53
|
+
|
|
54
|
+
- `ReleaseA.test.tsx` (15 tests): the empty view (shown and gone as panels dock and close; a
|
|
55
|
+
floating window can still dock into it), the state attributes on tabs and windows, `dockTo`
|
|
56
|
+
(sides, centre, size clamping, winning over `initialTarget`, the fallback and its warning, no
|
|
57
|
+
effect on an open panel), the per-type classes (also after floating), and `keepAlive: false`
|
|
58
|
+
(unmount and fresh remount, no `onClose` on hide, the placeholder preview, the default
|
|
59
|
+
unchanged, and no leak over 50 hide/show cycles). Each was seen failing with its feature broken.
|
|
60
|
+
|
|
13
61
|
## [7.7.4] — 2026-10-06
|
|
14
62
|
|
|
15
63
|
A written stability policy, and CI that enforces it. No API or behaviour change.
|
|
@@ -1058,7 +1106,8 @@ All of the above is additive and backward-compatible: every new field is optiona
|
|
|
1058
1106
|
|
|
1059
1107
|
---
|
|
1060
1108
|
|
|
1061
|
-
[Unreleased]: https://github.com/felipecarrillo100/react-dockable-desktop/compare/v7.
|
|
1109
|
+
[Unreleased]: https://github.com/felipecarrillo100/react-dockable-desktop/compare/v7.8.0...HEAD
|
|
1110
|
+
[7.8.0]: https://github.com/felipecarrillo100/react-dockable-desktop/compare/v7.7.4...v7.8.0
|
|
1062
1111
|
[7.7.4]: https://github.com/felipecarrillo100/react-dockable-desktop/compare/v7.7.3...v7.7.4
|
|
1063
1112
|
[7.7.3]: https://github.com/felipecarrillo100/react-dockable-desktop/compare/v7.7.2...v7.7.3
|
|
1064
1113
|
[7.7.2]: https://github.com/felipecarrillo100/react-dockable-desktop/compare/v7.7.1...v7.7.2
|
package/README.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# React Dockable Desktop
|
|
2
2
|
|
|
3
|
-
[](https://www.npmjs.com/package/react-dockable-desktop)
|
|
4
4
|
[](https://www.typescriptlang.org/)
|
|
5
5
|
[](#touch--mobile)
|
|
6
6
|
[](#license)
|
|
@@ -28,12 +28,13 @@ serialised layout format**, so a layout saved by either library loads in the oth
|
|
|
28
28
|
- **Floating Windows** — pop panels into freely resizable floating windows; 8-direction resize handles (N/NE/E/SE/S/SW/W/NW), maximize, minimize; drag to a workspace corner to anchor it there — anchored windows stack with 8 px gaps and reposition when the viewport resizes
|
|
29
29
|
- **Panel Overlay** — per-panel overlay layer with anchored toolbars (`RddPanelToolbar`, `RddToolbarButton`, `RddToolbarToggle`, async search) and corner-anchored floating windows that stack, drag, and dock; an axis can span the panel instead of carrying a fixed size, so a strip or column tracks the panel as it resizes — set declaratively or by dragging an edge out until it snaps; `useFloatingWidgets()` opens N named windows dynamically from data or event handlers
|
|
30
30
|
- **Touch & Mobile Ready** — full iPad and Android support: long-press to drag tabs, touch resize, 44px coarse-pointer targets throughout
|
|
31
|
-
- **Zero-Unmount DOM Persistence** — panel DOM nodes are moved, never destroyed, across docking, floating, and tab-switching alike, all by default; WebGL, maps, terminals, and forms retain full state with zero integration work
|
|
31
|
+
- **Zero-Unmount DOM Persistence** — panel DOM nodes are moved, never destroyed, across docking, floating, and tab-switching alike, all by default; WebGL, maps, terminals, and forms retain full state with zero integration work (a heavy, rarely shown panel type can opt out with `keepAlive: false`)
|
|
32
32
|
- **i18n & RTL** — full Right-to-Left layout support; `dir="rtl"` flips every control, tab order, and drop zone automatically
|
|
33
33
|
- **Inter-Panel Pub/Sub** — lightweight typed event bus for decoupled panel-to-panel communication
|
|
34
|
-
- **Imperative API** — the workspace from `createWorkspace()` opens, closes, focuses, and serializes panels from anywhere — inside or outside React
|
|
34
|
+
- **Imperative API** — the workspace from `createWorkspace()` opens, closes, focuses, and serializes panels from anywhere — inside or outside React; `dockTo` opens a panel beside another, on any side or as a tab
|
|
35
35
|
- **Layout Serialization** — save and restore the full workspace as a JSON string; survives page reloads
|
|
36
36
|
- **7 Built-in Skins** — VSCode, macOS, Chrome, Slate, Nord, Obsidian, Tokyo — all fully themeable via CSS variables
|
|
37
|
+
- **Works beside your UI framework** — MUI, Bootstrap, Tailwind and others: every class is `rdd-` prefixed, state attributes (`data-rdd-dirty`, `data-rdd-focused`, …) and per-panel-type classes to style against, and your own empty-workspace view ([guide →](https://felipecarrillo100.github.io/react-dockable-desktop/guide/ui-frameworks))
|
|
37
38
|
- **Toast Notifications** — imperative singleton `toast.info/success/warning/error/promise()` with queue, pause-on-hover, progress bar, and a `ToastAdapter` interface for delegating to a third-party notification library
|
|
38
39
|
- **Drag-Resize Primitives** — `startPointerDrag()` and `computeResizedRect()`, the same pointer-capture mechanics and 8-directional resize math the built-in resizers use, exported for building custom resizable UI inside your own panel content ([guide →](https://felipecarrillo100.github.io/react-dockable-desktop/guide/advanced#building-custom-drag-resize-interactions))
|
|
39
40
|
- **Zero extra dependencies** — no runtime dependencies beyond React itself; everything is bundled in
|
|
@@ -462,6 +463,7 @@ Complete guides, API reference, and interactive demo at:
|
|
|
462
463
|
| [Panel Overlay](https://felipecarrillo100.github.io/react-dockable-desktop/guide/panel-overlay) | `RddPanelOverlay`, panel toolbars, `RddFloatingWidget`, `useFloatingWidgets` |
|
|
463
464
|
| [Toast Notifications](https://felipecarrillo100.github.io/react-dockable-desktop/guide/toast) | `toast` singleton, `<RddToasts>`, queue behaviour, theming, `ToastAdapter` |
|
|
464
465
|
| [Migration Guide](https://felipecarrillo100.github.io/react-dockable-desktop/guide/migration) | Upgrading across major versions |
|
|
466
|
+
| [UI Frameworks](https://felipecarrillo100.github.io/react-dockable-desktop/guide/ui-frameworks) | Using it with MUI, Bootstrap or Tailwind: dark mode, z-index, overrides |
|
|
465
467
|
| [Stability & Versioning](https://felipecarrillo100.github.io/react-dockable-desktop/guide/stability) | What the public API is, deprecation and support periods |
|
|
466
468
|
| [API Reference](https://felipecarrillo100.github.io/react-dockable-desktop/api/) | Full type-level reference for all exports |
|
|
467
469
|
|