From af5ce5bbfdb14695e0b6ce157978a408ee3daebe Mon Sep 17 00:00:00 2001
From: mathuo <6710312+mathuo@users.noreply.github.com>
Date: Mon, 5 Aug 2024 21:17:39 +0100
Subject: [PATCH] chore: fix documentation
---
packages/docs/docs/core/panels/add.mdx | 16 ++++++++++++----
1 file changed, 12 insertions(+), 4 deletions(-)
diff --git a/packages/docs/docs/core/panels/add.mdx b/packages/docs/docs/core/panels/add.mdx
index 8418c3d27..c1c330031 100644
--- a/packages/docs/docs/core/panels/add.mdx
+++ b/packages/docs/docs/core/panels/add.mdx
@@ -155,16 +155,24 @@ const panel = api.addPanel({
You should specific the `floating` option which can be either `true` or an object describing the position of the floating group.
+:::info
+The `position` property of the `floating` object accepts combinations of `top`, `left`, `bottom` and `right`.
+:::
+
```ts
api.addPanel({
id: 'panel_1',
component: 'default',
- floating: true,
+ floating: true
});
api.addPanel({
- id: 'panel_2',
- component: 'default',
- floating: { left: 10, top: 10, width: 300, height: 300 },
+ id: 'panel_2',
+ component: 'default',
+ floating: {
+ position: { left: 10, top: 10 },
+ width: 300,
+ height: 300
+ }
});
```