@netless/fastboard-ui 0.3.15-canary.1 → 0.3.15

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (5) hide show
  1. package/dist/index.d.ts +9 -1
  2. package/dist/lite.d.ts +9 -1
  3. package/package.json +4 -4
  4. package/src/components/Fastboard/Fastboard.svelte.d.ts +4 -0
  5. package/src/typings.ts +5 -1
package/dist/index.d.ts CHANGED
@@ -23,7 +23,11 @@ interface ToolbarConfig {
23
23
  placement?: "left" | "right";
24
24
  /** @default ["clicker", "selector", "pencil", "text", "shapes", "eraser", "clear"] */
25
25
  items?: ToolbarItem[];
26
- /** @default false */
26
+ /**
27
+ * Note: updating this option does not take effect when the element was mounted.
28
+ * Make sure to set this option in `UI.mount(div, { configs: { toolbar: { collapsed: true } } })`.
29
+ * @default false
30
+ */
27
31
  collapsed?: boolean;
28
32
  /** Control the last button which opens apps stock on toolbar. */
29
33
  apps?: {
@@ -109,6 +113,10 @@ declare interface FastboardProps {
109
113
  app?: FastboardApp | null;
110
114
  theme?: Theme;
111
115
  language?: Language;
116
+ /**
117
+ * Note: updating this option does not take effect when the element was mounted.
118
+ * Make sure to set this option in `UI.mount(div, { containerRef })`.
119
+ */
112
120
  containerRef?: (container: HTMLDivElement | null) => void;
113
121
  config?: FastboardUIConfig;
114
122
  }
package/dist/lite.d.ts CHANGED
@@ -23,7 +23,11 @@ interface ToolbarConfig {
23
23
  placement?: "left" | "right";
24
24
  /** @default ["clicker", "selector", "pencil", "text", "shapes", "eraser", "clear"] */
25
25
  items?: ToolbarItem[];
26
- /** @default false */
26
+ /**
27
+ * Note: updating this option does not take effect when the element was mounted.
28
+ * Make sure to set this option in `UI.mount(div, { configs: { toolbar: { collapsed: true } } })`.
29
+ * @default false
30
+ */
27
31
  collapsed?: boolean;
28
32
  /** Control the last button which opens apps stock on toolbar. */
29
33
  apps?: {
@@ -109,6 +113,10 @@ declare interface FastboardProps {
109
113
  app?: FastboardApp | null;
110
114
  theme?: Theme;
111
115
  language?: Language;
116
+ /**
117
+ * Note: updating this option does not take effect when the element was mounted.
118
+ * Make sure to set this option in `UI.mount(div, { containerRef })`.
119
+ */
112
120
  containerRef?: (container: HTMLDivElement | null) => void;
113
121
  config?: FastboardUIConfig;
114
122
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@netless/fastboard-ui",
3
- "version": "0.3.15-canary.1",
3
+ "version": "0.3.15",
4
4
  "description": "The front-end of @netless/fastboard-core.",
5
5
  "main": "dist/index.js",
6
6
  "svelte": "dist/index.svelte.mjs",
@@ -11,15 +11,15 @@
11
11
  ],
12
12
  "repository": "netless-io/fastboard",
13
13
  "peerDependencies": {
14
- "@netless/fastboard-core": "0.3.15-canary.1"
14
+ "@netless/fastboard-core": "0.3.15"
15
15
  },
16
16
  "dependencies": {
17
17
  "tippy.js": "^6.3.7"
18
18
  },
19
19
  "devDependencies": {
20
20
  "@netless/buildtool": "0.1.0",
21
- "@netless/fastboard-core": "0.3.15-canary.1",
22
- "@netless/esbuild-plugin-inline-sass": "0.1.0"
21
+ "@netless/esbuild-plugin-inline-sass": "0.1.0",
22
+ "@netless/fastboard-core": "0.3.15"
23
23
  },
24
24
  "scripts": {
25
25
  "cleanup": "rimraf dist",
package/src/components/Fastboard/Fastboard.svelte.d.ts CHANGED
@@ -6,6 +6,10 @@ export declare interface FastboardProps {
6
6
  app?: FastboardApp | null;
7
7
  theme?: Theme;
8
8
  language?: Language;
9
+ /**
10
+ * Note: updating this option does not take effect when the element was mounted.
11
+ * Make sure to set this option in `UI.mount(div, { containerRef })`.
12
+ */
9
13
  containerRef?: (container: HTMLDivElement | null) => void;
10
14
  config?: FastboardUIConfig;
11
15
  }
package/src/typings.ts CHANGED
@@ -39,7 +39,11 @@ export interface ToolbarConfig {
39
39
  placement?: "left" | "right";
40
40
  /** @default ["clicker", "selector", "pencil", "text", "shapes", "eraser", "clear"] */
41
41
  items?: ToolbarItem[];
42
- /** @default false */
42
+ /**
43
+ * Note: updating this option does not take effect when the element was mounted.
44
+ * Make sure to set this option in `UI.mount(div, { configs: { toolbar: { collapsed: true } } })`.
45
+ * @default false
46
+ */
43
47
  collapsed?: boolean;
44
48
  /** Control the last button which opens apps stock on toolbar. */
45
49
  apps?: { enable?: boolean };