@interopio/workspaces-api 3.5.0 → 3.5.2

package/workspaces.d.ts

@@ -235,6 +235,9 @@ export namespace IOConnectWorkspaces {
     /** The possible window states for a workspaces frame. */
     export type FrameState = "maximized" | "minimized" | "normal";
 
+    /** The possible types of window dragging inside a workspaces frame */
+    export type WindowDragMode = "keepInside" | "autoEject";
+
     /** An object describing the options of the builder. */
     export interface BuilderConfig {
         /** A string defining the type of the builder. */
@@ -252,7 +255,10 @@ export namespace IOConnectWorkspaces {
         /** Position of the workspace in relation to it's siblings in the frame. */
         position?: number;
 
-        /** Provides the opportunity to open a workspace with no tab header */
+        /** 
+         * Provides the opportunity to open a workspace with no tab header
+         * @default false
+         */
         noTabHeader?: boolean;
 
         /** Used for replacing the specified workspace instead of creating a new one */
@@ -261,53 +267,99 @@ export namespace IOConnectWorkspaces {
         /** Controls when the windows inside this workspace should load when the workspace is created or restored */
         loadStrategy?: LoadingStrategy;
 
-        /** Controls the users ability to drop outside windows in the workspace */
+        /**
+         * Controls the users ability to drop outside windows in the workspace
+         * @default true
+         */
         allowDrop?: boolean;
 
-        /** Controls the users ability to drop windows in the left-most zone of the workspace */
+        /**
+         * Controls the users ability to drop windows in the left-most zone of the workspace
+         * @default true
+         */
         allowDropLeft?: boolean;
 
-        /** Controls the users ability to drop windows in the top-most zone of the workspace */
+        /** 
+         * Controls the users ability to drop windows in the top-most zone of the workspace
+         * @default true
+         */
         allowDropTop?: boolean;
 
-        /** Controls the users ability to drop windows in the right-most zone of the workspace */
+        /** 
+         * Controls the users ability to drop windows in the right-most zone of the workspace
+         * @default true
+         */
         allowDropRight?: boolean;
 
-        /** Controls the users ability to drop windows in the bottom-most zone of the workspace */
+        /** 
+         * Controls the users ability to drop windows in the bottom-most zone of the workspace
+         * @default true
+         */
         allowDropBottom?: boolean;
 
-        /** Controls the users ability to extract windows from the workspace */
+        /** 
+         * Controls the users ability to extract windows from the workspace
+         * @default true
+         */
         allowExtract?: boolean;
 
-        /** Control the users ability to reorder windows in the workspace */
+        /** 
+         * Control the users ability to reorder windows in the workspace
+         * @default true
+         */
         allowWindowReorder?: boolean;
 
-        /** Controls the visibility of the save workspace button located in the workspace tab */
+        /** 
+         * Controls the visibility of the save workspace button located in the workspace tab
+         * @default true
+         */
         showSaveButton?: boolean;
 
-        /** Controls whether a workspace tab can be reordered in the frame */
+        /** 
+         * Controls whether a workspace tab can be reordered in the frame
+         * @default true
+         */
         allowWorkspaceTabReorder?: boolean;
 
-        /** Controls whether a workspace tab can be extracted from the frame (available only for **io.Connect Desktop**). */
+        /** 
+         * Controls whether a workspace tab can be extracted from the frame (available only for **io.Connect Desktop**).
+         * @default true
+         */
         allowWorkspaceTabExtract?: boolean;
 
-        /** Controls the visibility of the close button located in the workspaces tab */
+        /** 
+         * Controls the visibility of the close button located in the workspaces tab
+         * @default true
+         */
         showCloseButton?: boolean;
 
-        /** Prevents the splitters for being draggable, so the windows cannot be resized */
+        /** 
+         * Prevents the splitters for being draggable, so the windows cannot be resized
+         * @default true
+         */
         allowSplitters?: boolean;
 
-        /** Controls the visibility of all close button located in the windows' tab elements */
+        /** 
+         * Controls the visibility of all close button located in the windows' tab elements
+         * @default true
+         */
         showWindowCloseButtons?: boolean;
 
-        /** Controls the visibility of all eject buttons located in the groups' headers */
+        /** 
+         * Controls the visibility of all eject buttons located in the groups' headers
+         * @default true
+         */
         showEjectButtons?: boolean;
 
-        /** Controls the visibility of all the add window buttons (the ones with the plus icon) located in the group headers */
+        /** 
+         * Controls the visibility of all the add window buttons (the ones with the plus icon) located in the group headers
+         * @default true
+         */
         showAddWindowButtons?: boolean;
 
         /**
          * Controls whether the workspace will be opened in a pinned or in a normal state
+         * @default false
          */
         isPinned?: boolean;
 
@@ -318,6 +370,7 @@ export namespace IOConnectWorkspaces {
 
         /**
          * Controls whether the workspace will be focused or not in the frame when opened
+         * @default true
          */
         isSelected?: boolean;
 
@@ -325,6 +378,12 @@ export namespace IOConnectWorkspaces {
         * Specifies where in the frame should the workspace be placed
         */
         positionIndex?: number;
+
+        /**
+         * Mode for dragging the windows that are part of the Workspace. If set to `"autoEject"` (available only for **io.Connect Desktop**), when the user drags a Workspace window, it will be ejected from the Workspace during the dragging operation and the user will be able to drop it back inside the Workspace, or out of the Workspace.
+         * If set to `"keepInside"`, the window won't be ejected from the Workspace when being dragged and the user will be able to drop it only inside the Workspace.
+         */
+        windowDragMode?: "keepInside" | "autoEject";
     }
 
     /** A config object which provides fine grain control when locking a workspace */
@@ -1153,6 +1212,13 @@ export namespace IOConnectWorkspaces {
          */
         lock(config?: WorkspaceLockConfig | ((config: WorkspaceLockConfig) => WorkspaceLockConfig)): Promise<void>;
 
+        /**
+         * Sets the mode for dragging the windows that are part of the Workspace. *Available only for **io.Connect Desktop**.*
+         * @param mode Mode for dragging the Workspace windows. If set to `"autoEject"`, when the user drags a Workspace window, it will be ejected from the Workspace during the dragging operation and the user will be able to drop it back inside the Workspace, or out of the Workspace.
+         * If set to `"keepInside"`, the window won't be ejected from the Workspace when being dragged and the user will be able to drop it only inside the Workspace.
+         */
+        setWindowDragMode(mode: "keepInside" | "autoEject"): Promise<void>;
+
         /**
          * Notifies when this workspace is closed.
          * @param callback Callback function to handle the event.
@@ -1210,6 +1276,12 @@ export namespace IOConnectWorkspaces {
          */
         isPinned?: boolean;
 
+        /**
+         * Mode for dragging the windows that are part of the Workspace. If set to `"autoEject"` (available only for **io.Connect Desktop**), when the user drags a Workspace window, it will be ejected from the Workspace during the dragging operation and the user will be able to drop it back inside the Workspace, or out of the Workspace.
+         * If set to `"keepInside"`, the window won't be ejected from the Workspace when being dragged and the user will be able to drop it only inside the Workspace.
+         */
+        windowDragMode?: "keepInside" | "autoEject";
+
         /**
          * The icon related to the workspace in the same format as it was passed
          */