Merge pull request #228 from mathuo/220-improve-documentation

220 improve documentation

.codesandbox/ci.json

@@ -16,9 +16,12 @@
     "/packages/docs/sandboxes/layout-dockview",
     "/packages/docs/sandboxes/nativeapp-dockview",
     "/packages/docs/sandboxes/nested-dockview",
+    "/packages/docs/sandboxes/rendering-dockview",
     "/packages/docs/sandboxes/resize-dockview",
+    "/packages/docs/sandboxes/resizecontainer-dockview",
     "/packages/docs/sandboxes/simple-dockview",
     "/packages/docs/sandboxes/updatetitle-dockview",
+    "/packages/docs/sandboxes/vanilla-dockview",
     "/packages/docs/sandboxes/watermark-dockview"
   ],
   "node": "16"

packages/docs/docs/components/dockview.mdx

@@ -22,7 +22,7 @@ import DockviewNative2 from '@site/sandboxes/nativeapp-dockview/src/app';
 import DockviewSetTitle from '@site/sandboxes/updatetitle-dockview/src/app';
 import RenderingDockview from '@site/sandboxes/rendering-dockview/src/app';
 import DockviewExternalDnd from '@site/sandboxes/externaldnd-dockview/src/app';
-import DockviewResizeContainer from '@site/sandboxes/resizeContainer-dockview/src/app';
+import DockviewResizeContainer from '@site/sandboxes/resizecontainer-dockview/src/app';
 import { attach as attachDockviewVanilla } from '@site/sandboxes/vanilla-dockview/src/app';
 
 # Dockview

packages/docs/versioned_docs/version-1.7.0/components/dockview.mdx

@@ -21,7 +21,9 @@ import DockviewNative from '@site/sandboxes/fullwidthtab-dockview/src/app';
 import DockviewNative2 from '@site/sandboxes/nativeapp-dockview/src/app';
 import DockviewSetTitle from '@site/sandboxes/updatetitle-dockview/src/app';
 import RenderingDockview from '@site/sandboxes/rendering-dockview/src/app';
-// import { attach as attachDockviewVanilla } from '@site/sandboxes/vanilla-dockview/src/app';
+import DockviewExternalDnd from '@site/sandboxes/externaldnd-dockview/src/app';
+import DockviewResizeContainer from '@site/sandboxes/resizecontainer-dockview/src/app';
+import { attach as attachDockviewVanilla } from '@site/sandboxes/vanilla-dockview/src/app';
 
 # Dockview
 
@@ -212,6 +214,8 @@ If you refresh the page you should notice your layout is loaded as you left it.
 
 ## Resizing
 
+### Panel Resizing
+
 Each Dockview contains of a number of groups and each group has a number of panels.
 Logically a user may want to resize a panel, but this translates to resizing the group which contains that panel.
 
@@ -239,6 +243,14 @@ You can see an example invoking both approaches below.
     <ResizeDockview />
 </Container>
 
+### Container Resizing
+
+The component will automatically resize to it's container.
+
+<Container sandboxId="resizeContainer-dockview">
+    <DockviewResizeContainer />
+</Container>
+
 ## Watermark
 
 When the dockview is empty you may want to display some fallback content, this is refered to as the `watermark`.
@@ -328,6 +340,14 @@ return (
     <DndDockview />
 </Container>
 
+### Third Party Dnd Libraries
+
+To be completed...
+
+<Container>
+    <DockviewExternalDnd />
+</Container>
+
 ## Panels
 
 ### Add Panel
@@ -693,7 +713,7 @@ hello 2
     <App />
 </div>
 
-<!-- ## VanillaJS
+## VanillaJS
 
 > Note: This section is experimental and support for Vanilla JS is a work in progress.
 
@@ -703,4 +723,4 @@ The core library is published as an independant package under the name `dockview
 > When using `dockview` there is no need to also install `dockview-core`.
 > `dockview-core` is a dependency of `dockview` and automatically installed during the installation process of `dockview` via `npm install dockview`.
 
-<Container injectVanillaJS={attachDockviewVanilla} /> -->
+<Container injectVanillaJS={attachDockviewVanilla} />

packages/docs/versions.json

@@ -1,3 +1,3 @@
 [
   "1.7.0"
-]
+]