From d68a1c88d0d5f515c360467831a6d88568e23e8a Mon Sep 17 00:00:00 2001 From: mathuo <6710312+mathuo@users.noreply.github.com> Date: Mon, 27 Mar 2023 20:57:45 +0100 Subject: [PATCH] chore: docs --- .codesandbox/ci.json | 3 +++ packages/docs/docs/components/dockview.mdx | 2 +- .../version-1.7.0/components/dockview.mdx | 26 ++++++++++++++++--- packages/docs/versions.json | 2 +- 4 files changed, 28 insertions(+), 5 deletions(-) diff --git a/.codesandbox/ci.json b/.codesandbox/ci.json index a6946fda5..d727a6c89 100644 --- a/.codesandbox/ci.json +++ b/.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" diff --git a/packages/docs/docs/components/dockview.mdx b/packages/docs/docs/components/dockview.mdx index 8d69a0543..00edf6d6c 100644 --- a/packages/docs/docs/components/dockview.mdx +++ b/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 diff --git a/packages/docs/versioned_docs/version-1.7.0/components/dockview.mdx b/packages/docs/versioned_docs/version-1.7.0/components/dockview.mdx index 1cb4e902e..00edf6d6c 100644 --- a/packages/docs/versioned_docs/version-1.7.0/components/dockview.mdx +++ b/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. +### Container Resizing + +The component will automatically resize to it's 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 ( +### Third Party Dnd Libraries + +To be completed... + + + + + ## Panels ### Add Panel @@ -693,7 +713,7 @@ hello 2 - + diff --git a/packages/docs/versions.json b/packages/docs/versions.json index 48d03f089..48883d079 100644 --- a/packages/docs/versions.json +++ b/packages/docs/versions.json @@ -1,3 +1,3 @@ [ "1.7.0" -] \ No newline at end of file +]