The intention of this repo is to provide developers a general (yet uniform) approach to snapping and docking windows within their apps while utilizing OpenFin. By design, the approach is generic and not intended to solve specific application use cases. Many applications and application developers have varying opinions as to the behavior of window snapping and docking. Our thought here is to provide a framework for those app developers to have as a guide, but provide the flexibility and optionality to solve for their own unique use cases.

Please be aware that this is not a product and you should consider cloning this project to use it.

• This sample project is a baseline set of features for Snap and Dock
• Edge cases are not a functionality driver for this sample

• Window snapping while dragging close to other windows
• Docking snapped windows on release
• Windows snap and align both vertically and/or horizontally
• All docked windows in a group display an undock icon
• Clicking the undock icon will separate the window from the rest of the docked windows
• Clicking undock on a window in the middle of a group of docked windows will split that group, leaving separate docking groups and/or single windows
• Single window can be docked to a group of docked windows, but group of docked windows cannot join another group or window

• If docked windows are undocked off monitor, the windows off monitor(s) come back into view

• Click this OpenFin installer download
• Unzip and run the installer
• Double-click the icon it creates on your desktop

• Run npm install
  (this will give you http-server amongst other things)

• If you do not have the OpenFin CLI installer, run npm install -g openfin-cli

• Run a local web server with npm start

• Run openfin -c local-es6.json -l

• Run npm run build
  (this will create a bundled js containing the Docking.js and modules)

• Run openfin -c local-es6.json -l

1. Run npm test
   (run npm install if you have not done so already above)

1. Add DockingManager.js in your project
2. Create new instance of DockingManager, like const dockingManager = new DockingManager();
3. Register instances of Openfin Windows (fin.desktop.Window) with DockingManager: dockingManager.register(fin.desktop.Window.getCurrent());
4. If you want a window to not dock to others, but only others dock to it you can pass false as the second argument of dockingManager.register: dockingManager.register(fin.desktop.Window.getCurrent(), false)
5. To adjust aspects like docked window separation, snapping range etc
   (full example in Docking.js):
   DockingManager.getInstance().init({ spacing: 0, range: 10 })

1. You can subscribe to docking events (window-docked, window-undocked) to get notified when a child window gets docked to another window e.g.

   fin.desktop.InterApplicationBus.subscribe("*", "window-docked", onDock);
   fin.desktop.InterApplicationBus.subscribe("*", "window-undocked", onUnDock);
   

   Since these messages are sent as a broadcast to all windows, you will need to filter these by windowName key, which is sent as part of the message

2. Or to avoid mixing external bus channels in with your application messaging, you may simply listen to the OpenFin Window 'group-changed' event - a full example is included in Docking.js

3. To undock, simply call leaveGroup method on the OpenFin window e.g. fin.desktop.Window.getCurrent().leaveGroup();

External windows, such as Java windows, can also register with Docking Manager to have Snap and Dock functionalties. Please refer to Java Example as an example.

And thats all!

For more details, please have a look at the code in this project.