react-dockable-desktop 7.7.3 → 7.7.4

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/dist/index.d.cts CHANGED
@@ -140,7 +140,7 @@ interface DropTarget {
140
140
  */
141
141
  interface LayoutGridNode {
142
142
  type: 'branch';
143
- /** Split orientation orientation indicator. */
143
+ /** Split orientation: `horizontal` places the children side by side, `vertical` stacks them. */
144
144
  orientation: SplitOrientation;
145
145
  /** Children branches or leaf panels. */
146
146
  children: LayoutNode[];
@@ -358,7 +358,7 @@ interface WorkspaceActions {
358
358
  openPanel: <P extends object = Record<string, unknown>>(id: string, component: string, options?: OpenPanelOptions<P>) => void;
359
359
  /**
360
360
  * Closes a panel immediately, bypassing dirty-state close guards.
361
- * For guarded close, use {@link requestClosePanel}.
361
+ * For guarded close, use {@link WorkspaceActions.requestClosePanel}.
362
362
  * @param id - Panel instance ID.
363
363
  */
364
364
  closePanel: (id: string) => void;
@@ -456,7 +456,7 @@ interface WorkspaceActions {
456
456
  * Serializes the entire workspace state to a JSON string.
457
457
  * Includes grid layout, floating window positions, minimized panels, panel metadata, and the
458
458
  * globally active panel (see {@link SerializedLayout.activePanelId}).
459
- * @returns JSON string suitable for storage and later restoration via {@link loadLayout}.
459
+ * @returns JSON string suitable for storage and later restoration via {@link WorkspaceActions.loadLayout}.
460
460
  * @example
461
461
  * ```ts
462
462
  * localStorage.setItem('layout', actions.saveLayout());
@@ -472,7 +472,7 @@ interface WorkspaceActions {
472
472
  * layouts saved before that field existed take). It is never seeded from an arbitrary entry in
473
473
  * `panels`.
474
474
  *
475
- * @param layoutJson - JSON string produced by {@link saveLayout}.
475
+ * @param layoutJson - JSON string produced by {@link WorkspaceActions.saveLayout}.
476
476
  * @returns `true` if the layout was successfully parsed and applied, `false` otherwise.
477
477
  */
478
478
  loadLayout: (layoutJson: string) => boolean;
@@ -1933,14 +1933,14 @@ declare const SecondarySidebar: React$1.ForwardRefExoticComponent<RddSecondarySi
1933
1933
  * Returns sidebar control functions from anywhere inside a `<RddSidebar>` tree,
1934
1934
  * including floating panels rendered via `{children}`.
1935
1935
  *
1936
- * @throws Error if used outside of a {@link Sidebar}.
1936
+ * @throws Error if used outside of an {@link RddSidebar}.
1937
1937
  */
1938
1938
  declare function useSidebar(): SidebarContextValue;
1939
1939
  /**
1940
1940
  * Returns tab-specific control functions for components rendered inside a
1941
1941
  * sidebar tab's `renderContent` tree.
1942
1942
  *
1943
- * @throws Error if used outside of a {@link Sidebar} tab's `renderContent` tree.
1943
+ * @throws Error if used outside of an {@link RddSidebar} tab's `renderContent` tree.
1944
1944
  */
1945
1945
  declare function useSidebarTab(): SidebarTabContextValue;
1946
1946
 
package/dist/index.d.ts CHANGED
@@ -140,7 +140,7 @@ interface DropTarget {
140
140
  */
141
141
  interface LayoutGridNode {
142
142
  type: 'branch';
143
- /** Split orientation orientation indicator. */
143
+ /** Split orientation: `horizontal` places the children side by side, `vertical` stacks them. */
144
144
  orientation: SplitOrientation;
145
145
  /** Children branches or leaf panels. */
146
146
  children: LayoutNode[];
@@ -358,7 +358,7 @@ interface WorkspaceActions {
358
358
  openPanel: <P extends object = Record<string, unknown>>(id: string, component: string, options?: OpenPanelOptions<P>) => void;
359
359
  /**
360
360
  * Closes a panel immediately, bypassing dirty-state close guards.
361
- * For guarded close, use {@link requestClosePanel}.
361
+ * For guarded close, use {@link WorkspaceActions.requestClosePanel}.
362
362
  * @param id - Panel instance ID.
363
363
  */
364
364
  closePanel: (id: string) => void;
@@ -456,7 +456,7 @@ interface WorkspaceActions {
456
456
  * Serializes the entire workspace state to a JSON string.
457
457
  * Includes grid layout, floating window positions, minimized panels, panel metadata, and the
458
458
  * globally active panel (see {@link SerializedLayout.activePanelId}).
459
- * @returns JSON string suitable for storage and later restoration via {@link loadLayout}.
459
+ * @returns JSON string suitable for storage and later restoration via {@link WorkspaceActions.loadLayout}.
460
460
  * @example
461
461
  * ```ts
462
462
  * localStorage.setItem('layout', actions.saveLayout());
@@ -472,7 +472,7 @@ interface WorkspaceActions {
472
472
  * layouts saved before that field existed take). It is never seeded from an arbitrary entry in
473
473
  * `panels`.
474
474
  *
475
- * @param layoutJson - JSON string produced by {@link saveLayout}.
475
+ * @param layoutJson - JSON string produced by {@link WorkspaceActions.saveLayout}.
476
476
  * @returns `true` if the layout was successfully parsed and applied, `false` otherwise.
477
477
  */
478
478
  loadLayout: (layoutJson: string) => boolean;
@@ -1933,14 +1933,14 @@ declare const SecondarySidebar: React$1.ForwardRefExoticComponent<RddSecondarySi
1933
1933
  * Returns sidebar control functions from anywhere inside a `<RddSidebar>` tree,
1934
1934
  * including floating panels rendered via `{children}`.
1935
1935
  *
1936
- * @throws Error if used outside of a {@link Sidebar}.
1936
+ * @throws Error if used outside of an {@link RddSidebar}.
1937
1937
  */
1938
1938
  declare function useSidebar(): SidebarContextValue;
1939
1939
  /**
1940
1940
  * Returns tab-specific control functions for components rendered inside a
1941
1941
  * sidebar tab's `renderContent` tree.
1942
1942
  *
1943
- * @throws Error if used outside of a {@link Sidebar} tab's `renderContent` tree.
1943
+ * @throws Error if used outside of an {@link RddSidebar} tab's `renderContent` tree.
1944
1944
  */
1945
1945
  declare function useSidebarTab(): SidebarTabContextValue;
1946
1946