react-dockable-desktop 7.0.0 → 7.0.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 +3 -3
- package/dist/index.cjs +5 -5
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +21 -2
- package/dist/index.d.ts +21 -2
- package/dist/index.js +5 -5
- package/dist/index.js.map +1 -1
- package/package.json +1 -1
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)
|
|
@@ -247,7 +247,7 @@ workspace.setDirection('ltr' | 'rtl')
|
|
|
247
247
|
|
|
248
248
|
## PanelHandle Reference
|
|
249
249
|
|
|
250
|
-
`usePanel()` returns a `PanelHandle` — in docked panels, floating windows, modals and side drawers alike:
|
|
250
|
+
`usePanel()` returns a `PanelHandle` — in docked panels, floating windows, modals and side drawers alike. Its actions never change identity; the handle object does (it carries live state), so depend on the actions, never on the handle, in dependency arrays:
|
|
251
251
|
|
|
252
252
|
| Member | Type | Description |
|
|
253
253
|
| :--- | :--- | :--- |
|
|
@@ -259,7 +259,7 @@ workspace.setDirection('ltr' | 'rtl')
|
|
|
259
259
|
| `minimize()` | `() => void` | Minimize this panel to the taskbar; no effect in a modal or drawer |
|
|
260
260
|
| `setDirty(dirty, options?)` | `(dirty: boolean, options?: DirtyStateOptions) => void` | Mark unsaved changes; triggers confirmation dialog on close |
|
|
261
261
|
| `setTitle(title)` | `(title: string \| MessageDescriptor) => void` | Change the tab/window title dynamically |
|
|
262
|
-
| `setIcon(icon)` | `(icon: ReactNode) => void` | Change
|
|
262
|
+
| `setIcon(icon)` | `(icon: ReactNode) => void` | Change a modal's or drawer's header icon. A docked or floating panel shows its registration's `defaultOptions.icon` |
|
|
263
263
|
|
|
264
264
|
### ContainerType
|
|
265
265
|
|