Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(dock-manager): add docking section #1437

Open
wants to merge 3 commits into
base: vnext
Choose a base branch
from

Conversation

igdmdimitrov
Copy link
Contributor

Closes #1418


#### Root Docking

In this type of docking, the dragged pane will become a child of the Dock Manager `RootPane`. Depending on the root docking indicator position, the orientation and other properties of the root pane, the existing root pane will be modified or will be replaced with a newly created one.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
In this type of docking, the dragged pane will become a child of the Dock Manager `RootPane`. Depending on the root docking indicator position, the orientation and other properties of the root pane, the existing root pane will be modified or will be replaced with a newly created one.
Root docking means the dragged pane will become a child of the Dock Manager `RootPane`. Depending on the root docking indicator position and the root pane's orientation and number of children, the existing root pane will be either modified or replaced with a newly created one.

@@ -294,6 +294,34 @@ this.dockManager.addEventListener('activePaneChanged', ev => {
});
```

### Docking

When you start dragging a floating pane, a different docking indicators will appear depending on the position of the dragged pane. There are four main types of docking - root docking, pane docking, document host docking and splitter docking.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
When you start dragging a floating pane, a different docking indicators will appear depending on the position of the dragged pane. There are four main types of docking - root docking, pane docking, document host docking and splitter docking.
When you start dragging a pane, different docking indicators will appear depending on the element the dragged pane is currently over. There are four main types of docking - root docking, pane docking, document host docking and splitter docking.


#### Pane Docking

Docking indicators will appear in the center of a content pane or tab group pane when dragging the floating pane over it. Depending on the docking indicator position, the orientation and other properties of the target pane, the dragged pane will either become a child of the target pane's parent split pane, the target pane will be replaced with a newly created split pane or a tab group pane will be created.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"Depending on the docking indicator position, the orientation and other properties of the target pane, the dragged pane will either become a child of the target pane's parent split pane, the target pane will be replaced with a newly created split pane or a tab group pane will be created."
This whole statement doesn't correspond to docking into a CP/TGP.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
status: awaiting-test ❌ PR ready for testing
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Describe DockManager docking functionality in more details
2 participants