feat: floating group overlay rules

packages/dockview-core/src/dnd/overlay.ts

@@ -40,6 +40,14 @@ export class Overlay extends CompositeDisposable {
     private static MINIMUM_HEIGHT = 20;
     private static MINIMUM_WIDTH = 20;
 
+    set minimumInViewportWidth(value: number | undefined) {
+        this.options.minimumInViewportWidth = value;
+    }
+
+    set minimumInViewportHeight(value: number | undefined) {
+        this.options.minimumInViewportHeight = value;
+    }
+
     constructor(
         private readonly options: {
             height: number;
@@ -109,7 +117,10 @@ export class Overlay extends CompositeDisposable {
         const xOffset = Math.max(0, this.getMinimumWidth(overlayRect.width));
 
         // a minimum height of minimumViewportHeight must be inside the viewport
-        const yOffset = Math.max(0, this.getMinimumHeight(overlayRect.height));
+        const yOffset =
+            typeof this.options.minimumInViewportHeight === 'number'
+                ? Math.max(0, this.getMinimumHeight(overlayRect.height))
+                : 0;
 
         const left = clamp(
             overlayRect.left - containerRect.left,
@@ -376,7 +387,9 @@ export class Overlay extends CompositeDisposable {
 
                             height = clamp(
                                 y - top,
-                                top < 0 && this.options.minimumInViewportHeight
+                                top < 0 &&
+                                    typeof this.options
+                                        .minimumInViewportHeight === 'number'
                                     ? -top +
                                           this.options.minimumInViewportHeight
                                     : Overlay.MINIMUM_HEIGHT,
@@ -413,7 +426,9 @@ export class Overlay extends CompositeDisposable {
 
                             width = clamp(
                                 x - left,
-                                left < 0 && this.options.minimumInViewportWidth
+                                left < 0 &&
+                                    typeof this.options
+                                        .minimumInViewportWidth === 'number'
                                     ? -left +
                                           this.options.minimumInViewportWidth
                                     : Overlay.MINIMUM_WIDTH,

packages/dockview-core/src/dockview/dockviewComponent.ts

@@ -52,6 +52,8 @@ import {
     IDockviewFloatingGroupPanel,
 } from './dockviewFloatingGroupPanel';
 
+const DEFAULT_FLOATING_GROUP_OVERFLOW_SIZE = 100;
+
 export interface PanelReference {
     update: (event: { params: { [key: string]: any } }) => void;
     remove: () => void;
@@ -87,7 +89,7 @@ export type DockviewComponentUpdateOptions = Pick<
     | 'createLeftHeaderActionsElement'
     | 'createRightHeaderActionsElement'
     | 'disableFloatingGroups'
-    | 'floatingGroupsPosition'
+    | 'floatingGroupBounds'
 >;
 
 export interface DockviewDropEvent extends GroupviewDropEvent {
@@ -361,15 +363,17 @@ export class DockviewComponent
             left: overlayLeft,
             top: overlayTop,
             minimumInViewportWidth:
-                this.options.floatingGroupsPosition === 'boundedWithinViewport'
+                this.options.floatingGroupBounds === 'boundedWithinViewport'
                     ? undefined
-                    : this.options.floatingGroupsPosition
+                    : this.options.floatingGroupBounds
-                          ?.minimumWidthWithinViewport ?? 100,
+                          ?.minimumWidthWithinViewport ??
+                      DEFAULT_FLOATING_GROUP_OVERFLOW_SIZE,
             minimumInViewportHeight:
-                this.options.floatingGroupsPosition === 'boundedWithinViewport'
+                this.options.floatingGroupBounds === 'boundedWithinViewport'
                     ? undefined
-                    : this.options.floatingGroupsPosition
+                    : this.options.floatingGroupBounds
-                          ?.minimumHeightWithinViewport ?? 100,
+                          ?.minimumHeightWithinViewport ??
+                      DEFAULT_FLOATING_GROUP_OVERFLOW_SIZE,
         });
 
         const el = group.element.querySelector('.void-container');
@@ -465,6 +469,9 @@ export class DockviewComponent
         const hasOrientationChanged =
             typeof options.orientation === 'string' &&
             this.gridview.orientation !== options.orientation;
+        const hasFloatingGroupOptionsChanged =
+            typeof options.floatingGroupBounds !== undefined &&
+            options.floatingGroupBounds !== this.options.floatingGroupBounds;
 
         this._options = { ...this.options, ...options };
 
@@ -472,6 +479,30 @@ export class DockviewComponent
             this.gridview.orientation = options.orientation!;
         }
 
+        if (hasFloatingGroupOptionsChanged) {
+            for (const group of this.floatingGroups) {
+                switch (this.options.floatingGroupBounds) {
+                    case 'boundedWithinViewport':
+                        group.overlay.minimumInViewportHeight = undefined;
+                        group.overlay.minimumInViewportWidth = undefined;
+                        break;
+                    case undefined:
+                        group.overlay.minimumInViewportHeight =
+                            DEFAULT_FLOATING_GROUP_OVERFLOW_SIZE;
+                        group.overlay.minimumInViewportWidth =
+                            DEFAULT_FLOATING_GROUP_OVERFLOW_SIZE;
+                        break;
+                    default:
+                        group.overlay.minimumInViewportHeight =
+                            this.options.floatingGroupBounds?.minimumHeightWithinViewport;
+                        group.overlay.minimumInViewportWidth =
+                            this.options.floatingGroupBounds?.minimumWidthWithinViewport;
+                }
+
+                group.overlay.setBounds({});
+            }
+        }
+
         this.layout(this.gridview.width, this.gridview.height, true);
     }
 

packages/dockview-core/src/dockview/options.ts

@@ -87,7 +87,7 @@ export interface DockviewComponentOptions extends DockviewRenderFunctions {
     singleTabMode?: 'fullwidth' | 'default';
     parentElement?: HTMLElement;
     disableFloatingGroups?: boolean;
-    floatingGroupsPosition?:
+    floatingGroupBounds?:
         | 'boundedWithinViewport'
         | {
               minimumHeightWithinViewport?: number;

packages/dockview/src/dockview/dockview.tsx

@@ -69,7 +69,7 @@ export interface IDockviewReactProps {
     leftHeaderActionsComponent?: React.FunctionComponent<IDockviewHeaderActionsProps>;
     singleTabMode?: 'fullwidth' | 'default';
     disableFloatingGroups?: boolean;
-    floatingGroupsPosition?:
+    floatingGroupBounds?:
         | 'boundedWithinViewport'
         | {
               minimumHeightWithinViewport?: number;
@@ -168,7 +168,7 @@ export const DockviewReact = React.forwardRef(
                 ),
                 singleTabMode: props.singleTabMode,
                 disableFloatingGroups: props.disableFloatingGroups,
-                floatingGroupsPosition: props.floatingGroupsPosition,
+                floatingGroupBounds: props.floatingGroupBounds,
             });
 
             const { clientWidth, clientHeight } = domRef.current;
@@ -217,9 +217,9 @@ export const DockviewReact = React.forwardRef(
                 return;
             }
             dockviewRef.current.updateOptions({
-                floatingGroupsPosition: props.floatingGroupsPosition,
+                floatingGroupBounds: props.floatingGroupBounds,
             });
-        }, [props.floatingGroupsPosition]);
+        }, [props.floatingGroupBounds]);
 
         React.useEffect(() => {
             if (!dockviewRef.current) {

packages/docs/docs/components/dockview.mdx

@@ -401,6 +401,12 @@ Floating groups can be interacted with whilst holding the `shift` key activating
 Floating groups can be programatically added through the dockview `api` method `api.addFloatingGroup(...)` and you can check whether
 a group is floating via the `group.api.isFloating` property. See examples for full code.
 
+You can control the bounding box of floating groups through the optional `floatingGroupBounds` options:
+
+-   `boundedWithinViewport` will force the entire floating group to be bounded within the docks viewport.
+-   `{minimumHeightWithinViewport?: number, minimumWidthWithinViewport?: number}` sets the respective dimension minimums that must appears within the docks viewport
+-   If no options are provided the defaults of `100px` minimum height and width within the viewport are set.
+
 <MultiFrameworkContainer
     height={600}
     sandboxId="floatinggroup-dockview"

packages/docs/sandboxes/floatinggroup-dockview/src/app.tsx

@@ -155,6 +155,10 @@ export const DockviewPersistance = (props: { theme?: string }) => {
         setApi(event.api);
     };
 
+    const [options, setOptions] = React.useState<
+        'boundedWithinViewport' | undefined
+    >(undefined);
+
     return (
         <div
             style={{
@@ -197,6 +201,17 @@ export const DockviewPersistance = (props: { theme?: string }) => {
                 >
                     Add Floating Group
                 </button>
+                <button
+                    onClick={() => {
+                        setOptions(
+                            options === undefined
+                                ? 'boundedWithinViewport'
+                                : undefined
+                        );
+                    }}
+                >
+                    {`Bounds: ${options ? 'Within' : 'Overflow'}`}
+                </button>
                 <button
                     onClick={() => {
                         setDisableFloatingGroups((x) => !x);
@@ -219,6 +234,7 @@ export const DockviewPersistance = (props: { theme?: string }) => {
                     leftHeaderActionsComponent={LeftComponent}
                     rightHeaderActionsComponent={RightComponent}
                     disableFloatingGroups={disableFloatingGroups}
+                    floatingGroupBounds={options}
                     className={`${props.theme || 'dockview-theme-abyss'}`}
                 />
             </div>