From d9906eb802e34ecd36ab719d032e281060bb9751 Mon Sep 17 00:00:00 2001 From: mathuo <6710312+mathuo@users.noreply.github.com> Date: Sat, 10 Jun 2023 11:38:41 +0100 Subject: [PATCH] chore: prepare v1.7.4 --- .../docs/blog/2023-06-14-dockview-1.7.4.md | 20 +++++++++++ .../basics.mdx | 0 .../components/_category_.json | 0 .../components/dockview.mdx | 34 +++++++++++++++++++ .../components/gridview.mdx | 0 .../components/paneview.mdx | 0 .../components/splitview.mdx | 0 .../index.mdx | 0 .../theme.mdx | 0 ...ebars.json => version-1.7.4-sidebars.json} | 0 packages/docs/versions.json | 4 +-- 11 files changed, 56 insertions(+), 2 deletions(-) create mode 100644 packages/docs/blog/2023-06-14-dockview-1.7.4.md rename packages/docs/versioned_docs/{version-1.7.3 => version-1.7.4}/basics.mdx (100%) rename packages/docs/versioned_docs/{version-1.7.3 => version-1.7.4}/components/_category_.json (100%) rename packages/docs/versioned_docs/{version-1.7.3 => version-1.7.4}/components/dockview.mdx (98%) rename packages/docs/versioned_docs/{version-1.7.3 => version-1.7.4}/components/gridview.mdx (100%) rename packages/docs/versioned_docs/{version-1.7.3 => version-1.7.4}/components/paneview.mdx (100%) rename packages/docs/versioned_docs/{version-1.7.3 => version-1.7.4}/components/splitview.mdx (100%) rename packages/docs/versioned_docs/{version-1.7.3 => version-1.7.4}/index.mdx (100%) rename packages/docs/versioned_docs/{version-1.7.3 => version-1.7.4}/theme.mdx (100%) rename packages/docs/versioned_sidebars/{version-1.7.3-sidebars.json => version-1.7.4-sidebars.json} (100%) diff --git a/packages/docs/blog/2023-06-14-dockview-1.7.4.md b/packages/docs/blog/2023-06-14-dockview-1.7.4.md new file mode 100644 index 000000000..6e8e2fe3f --- /dev/null +++ b/packages/docs/blog/2023-06-14-dockview-1.7.4.md @@ -0,0 +1,20 @@ +--- +slug: dockview-1.7.4-release +title: Dockview 1.7.4 +tags: [release] +--- + +# Release Notes + +Please reference to docs @ [dockview.dev](https://dockview.dev). + +## 🚀 Features + +- Improvements and tests added to the panel `api.updateParameters(...)` method [#265](https://github.com/mathuo/dockview/pull/265) + +## 🛠 Miscs + +- Fix bug associated with overidding panel titles when using `api.updateParameters(...)` [#265](https://github.com/mathuo/dockview/pull/265) +- Cleanup listeners and disposables after use [#257](https://github.com/mathuo/dockview/pull/257) + +## 🔥 Breaking changes diff --git a/packages/docs/versioned_docs/version-1.7.3/basics.mdx b/packages/docs/versioned_docs/version-1.7.4/basics.mdx similarity index 100% rename from packages/docs/versioned_docs/version-1.7.3/basics.mdx rename to packages/docs/versioned_docs/version-1.7.4/basics.mdx diff --git a/packages/docs/versioned_docs/version-1.7.3/components/_category_.json b/packages/docs/versioned_docs/version-1.7.4/components/_category_.json similarity index 100% rename from packages/docs/versioned_docs/version-1.7.3/components/_category_.json rename to packages/docs/versioned_docs/version-1.7.4/components/_category_.json diff --git a/packages/docs/versioned_docs/version-1.7.3/components/dockview.mdx b/packages/docs/versioned_docs/version-1.7.4/components/dockview.mdx similarity index 98% rename from packages/docs/versioned_docs/version-1.7.3/components/dockview.mdx rename to packages/docs/versioned_docs/version-1.7.4/components/dockview.mdx index 835dee189..176f309db 100644 --- a/packages/docs/versioned_docs/version-1.7.3/components/dockview.mdx +++ b/packages/docs/versioned_docs/version-1.7.4/components/dockview.mdx @@ -435,6 +435,40 @@ const panel2 = api.addPanel({ }); ``` +### Update Panel + +You can programatically update the `params` passed through to the panel through the panal api using `api.updateParameters`. + +```ts +const panel = api.addPanel({ + id: 'panel_1', + component: 'default', + params: { + keyA: 'valueA', + }, +}); + +// ... + +panel.api.updateParameters({ + keyB: 'valueB', +}); + +// ... + +panel.api.updateParameters({ + keyA: 'anotherValueA', +}); +``` + +To delete a parameter you should pass a value of `undefined` for the key. + +```ts +panel.api.updateParameters({ + keyA: undefined, // this will delete 'keyA'. +}); +``` + ### Panel Rendering By default `DockviewReact` only adds to the DOM those panels that are visible, diff --git a/packages/docs/versioned_docs/version-1.7.3/components/gridview.mdx b/packages/docs/versioned_docs/version-1.7.4/components/gridview.mdx similarity index 100% rename from packages/docs/versioned_docs/version-1.7.3/components/gridview.mdx rename to packages/docs/versioned_docs/version-1.7.4/components/gridview.mdx diff --git a/packages/docs/versioned_docs/version-1.7.3/components/paneview.mdx b/packages/docs/versioned_docs/version-1.7.4/components/paneview.mdx similarity index 100% rename from packages/docs/versioned_docs/version-1.7.3/components/paneview.mdx rename to packages/docs/versioned_docs/version-1.7.4/components/paneview.mdx diff --git a/packages/docs/versioned_docs/version-1.7.3/components/splitview.mdx b/packages/docs/versioned_docs/version-1.7.4/components/splitview.mdx similarity index 100% rename from packages/docs/versioned_docs/version-1.7.3/components/splitview.mdx rename to packages/docs/versioned_docs/version-1.7.4/components/splitview.mdx diff --git a/packages/docs/versioned_docs/version-1.7.3/index.mdx b/packages/docs/versioned_docs/version-1.7.4/index.mdx similarity index 100% rename from packages/docs/versioned_docs/version-1.7.3/index.mdx rename to packages/docs/versioned_docs/version-1.7.4/index.mdx diff --git a/packages/docs/versioned_docs/version-1.7.3/theme.mdx b/packages/docs/versioned_docs/version-1.7.4/theme.mdx similarity index 100% rename from packages/docs/versioned_docs/version-1.7.3/theme.mdx rename to packages/docs/versioned_docs/version-1.7.4/theme.mdx diff --git a/packages/docs/versioned_sidebars/version-1.7.3-sidebars.json b/packages/docs/versioned_sidebars/version-1.7.4-sidebars.json similarity index 100% rename from packages/docs/versioned_sidebars/version-1.7.3-sidebars.json rename to packages/docs/versioned_sidebars/version-1.7.4-sidebars.json diff --git a/packages/docs/versions.json b/packages/docs/versions.json index 900dc7f77..a53923196 100644 --- a/packages/docs/versions.json +++ b/packages/docs/versions.json @@ -1,3 +1,3 @@ [ - "1.7.3" -] \ No newline at end of file + "1.7.4" +]