refactor: add configs comment about timing things

netless-io · Mar 26, 2024 · 9fa6a6c · 9fa6a6c
1 parent c6223da
commit 9fa6a6c
Show file tree

Hide file tree

Showing 3 changed files with 16 additions and 2 deletions.
diff --git a/packages/fastboard-ui/src/components/Fastboard/Fastboard.svelte.d.ts b/packages/fastboard-ui/src/components/Fastboard/Fastboard.svelte.d.ts
@@ -6,6 +6,10 @@ export declare interface FastboardProps {
   app?: FastboardApp | null;
   theme?: Theme;
   language?: Language;
+  /**
+   * Note: updating this option does not take effect when the element was mounted.
+   * Make sure to set this option in `UI.mount(div, { containerRef })`.
+   */
   containerRef?: (container: HTMLDivElement | null) => void;
   config?: FastboardUIConfig;
 }

diff --git a/packages/fastboard-ui/src/typings.ts b/packages/fastboard-ui/src/typings.ts
@@ -39,7 +39,11 @@ export interface ToolbarConfig {
   placement?: "left" | "right";
   /** @default ["clicker", "selector", "pencil", "text", "shapes", "eraser", "clear"] */
   items?: ToolbarItem[];
-  /** @default false */
+  /**
+   * Note: updating this option does not take effect when the element was mounted.
+   * Make sure to set this option in `UI.mount(div, { configs: { toolbar: { collapsed: true } } })`.
+   * @default false
+   */
   collapsed?: boolean;
   /** Control the last button which opens apps stock on toolbar. */
   apps?: { enable?: boolean };

diff --git a/packages/fastboard/test/main.ts b/packages/fastboard/test/main.ts
@@ -22,7 +22,13 @@ createFastboard({
   // eslint-disable-next-line @typescript-eslint/no-explicit-any
   (window as any).app = app;
   // eslint-disable-next-line @typescript-eslint/no-explicit-any
-  (window as any).ui = createUI(app, root);
+  let ui = (window as any).ui = createUI(app);
+
+  ui.mount(root, {
+    config: {
+      toolbar: { collapsed: true }
+    }
+  });
 });
 
 resizable(root, {