From b24470fa420fc3cae11be11d722b47b339d510f2 Mon Sep 17 00:00:00 2001 From: mathuo <6710312+mathuo@users.noreply.github.com> Date: Thu, 5 Sep 2024 19:48:56 +0100 Subject: [PATCH] chore: v1.17.0 release notes --- .../docs/blog/2024-09-05-dockview-1.17.0.md | 23 +++++++++++++ packages/docs/docs/core/panels/add.mdx | 32 +++++++++++++++++++ 2 files changed, 55 insertions(+) create mode 100644 packages/docs/blog/2024-09-05-dockview-1.17.0.md diff --git a/packages/docs/blog/2024-09-05-dockview-1.17.0.md b/packages/docs/blog/2024-09-05-dockview-1.17.0.md new file mode 100644 index 000000000..9f8aa1902 --- /dev/null +++ b/packages/docs/blog/2024-09-05-dockview-1.17.0.md @@ -0,0 +1,23 @@ +--- +slug: dockview-1.17.0-release +title: Dockview 1.17.0 +tags: [release] +--- + +# Release Notes + +Please reference docs @ [dockview.dev](https://dockview.dev). + +## 🚀 Features + +- Touch Support [#698](https://github.com/mathuo/dockview/pull/698) +- Initial and bounding panel sizing [#690](https://github.com/mathuo/dockview/pull/690) +- Improve group resize logic [#693](https://github.com/mathuo/dockview/pull/693) + +## 🛠 Miscs + +- Bug: Theme Typo [#694](https://github.com/mathuo/dockview/pull/694) +- Docs [#703](https://github.com/mathuo/dockview/pull/703) + +## 🔥 Breaking changes + diff --git a/packages/docs/docs/core/panels/add.mdx b/packages/docs/docs/core/panels/add.mdx index c1c330031..b964cdc05 100644 --- a/packages/docs/docs/core/panels/add.mdx +++ b/packages/docs/docs/core/panels/add.mdx @@ -176,3 +176,35 @@ api.addPanel({ } }); ``` + +### Minimum and Maximum + +You can define both minimum and maxmium widths and heights, these are persisted with layouts. + +:::info +Since panels exist within groups there are occasions where these boundaries will be ignored to prevent overflow and clipping issues within the dock. +::: + +```ts +api.addPanel({ + id: 'panel_1', + component: 'default', + minimumWidth: 100, + maximumWidth: 100, + minimumHeight: 200, + maximumHeight: 2000 +}); +``` + +### Initial Size + +You can define an `initialWidth` and `initialHeight`. The dock will may a best attempt to obey these inputs but it may not always be possible due to the constraints of the grid. + +```ts +api.addPanel({ + id: 'panel_1', + component: 'default', + initialWidth: 100, + initialHeight: 100 +}); +```