@superblocksteam/library-shared 2.0.20 → 2.0.21-next.1

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 (4) hide show
  1. package/dist/props/prop-types.d.ts +6 -6
  2. package/dist/types/register-component.d.ts +20 -6
  3. package/dist/types/register-component.d.ts.map +1 -1
  4. package/package.json +1 -1
package/dist/props/prop-types.d.ts CHANGED
@@ -21,15 +21,15 @@ export type PropertyForData<T extends DataType> = {
21
21
  description: string;
22
22
  };
23
23
  /**
24
- * By default, all your properties are readable from anywhere in Superblocks using dot notation
25
- * (e.g. `myComponent.myProperty`). If you want to hide a property from the outside world,
26
- * set this to false
27
- * @default true
24
+ * By default, all your properties are not readable from anywhere in Superblocks using dot notation
25
+ * (e.g. `myComponent.myProperty`). If you want to show a property from the outside world,
26
+ * set this to true
27
+ * @default false
28
28
  */
29
29
  isExternallyReadable?: boolean;
30
30
  /**
31
- * By default, all properties can have be used with Set Component Property and Reset Component to Default.
32
- * @default true
31
+ * By default, all properties can't be used with Set Component Property and Reset Component to Default.
32
+ * @default false
33
33
  **/
34
34
  isExternallySettable?: boolean;
35
35
  /** if prop in meta section */
package/dist/types/register-component.d.ts CHANGED
@@ -46,9 +46,9 @@ export interface EditorConfig<TProps = any> {
46
46
  icon?: ComponentIcon | SvgDataUri;
47
47
  /**
48
48
  * The path that defines the layout property of the component, for container-style components.
49
- * Uses "layout" by default.
50
- *
51
49
  * Used for editor's UX when dragging & dropping components.
50
+ *
51
+ * @default "layout"
52
52
  */
53
53
  layoutPropertyPath?: string;
54
54
  /**
@@ -57,16 +57,15 @@ export interface EditorConfig<TProps = any> {
57
57
  isDroppable?: boolean;
58
58
  /**
59
59
  * Whether the component is draggable.
60
- * Defaults to true.
60
+ * @default true
61
61
  */
62
62
  isDraggable?: boolean;
63
63
  /**
64
64
  * Whether the component can be dragged by clicking on its area (vs clicking the name pill).
65
- * Defaults to true.
66
- *
67
65
  * Useful for full width/height components like sections, columns.
68
- *
69
66
  * Note: `isDraggable` must be true for this to take effect.
67
+ *
68
+ * @default true
70
69
  */
71
70
  isContentDraggable?: boolean;
72
71
  isResizable?: {
@@ -76,6 +75,21 @@ export interface EditorConfig<TProps = any> {
76
75
  width: boolean;
77
76
  height: boolean;
78
77
  }) | boolean;
78
+ /**
79
+ * Whether the component is detached from the canvas.
80
+ *
81
+ * A detached component implies that:
82
+ * - It's not part of the main canvas.
83
+ * - It's a drop area.
84
+ * - It has an open/close state.
85
+ *
86
+ * Useful for dialogs, slideouts, modals.
87
+ *
88
+ * Note: You might also want to set `createAt: root` on the editor template for detached components.
89
+ *
90
+ * @default false
91
+ */
92
+ isDetached?: boolean;
79
93
  }
80
94
  /**
81
95
  * Editor metadata shown for each component before users drag/add them to their applications.
package/dist/types/register-component.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"register-component.d.ts","sourceRoot":"","sources":["../../src/types/register-component.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,eAAO,MAAM,cAAc;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAoCjB,CAAC;AAEX,MAAM,MAAM,aAAa,GACvB,CAAC,OAAO,cAAc,CAAC,CAAC,MAAM,OAAO,cAAc,CAAC,CAAC;AAEvD,MAAM,MAAM,UAAU,GAAG,sBAAsB,MAAM,EAAE,CAAC;AACxD,MAAM,WAAW,YAAY,CAAC,MAAM,GAAG,GAAG;IACxC,IAAI,CAAC,EAAE,aAAa,GAAG,UAAU,CAAC;IAClC;;;;;OAKG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAE5B;;OAEG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;IAEtB;;;OAGG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;IAEtB;;;;;;;OAOG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAE7B,WAAW,CAAC,EACV;QAAE,KAAK,CAAC,EAAE,OAAO,CAAC;QAAC,MAAM,CAAC,EAAE,OAAO,CAAA;KAAE,GACnC,CAAC,CAAC,KAAK,EAAE,MAAM,KAAK;QAAE,KAAK,EAAE,OAAO,CAAC;QAAC,MAAM,EAAE,OAAO,CAAA;KAAE,CAAC,GACxD,OAAO,CAAC;CACb;AAED;;GAEG;AACH,MAAM,MAAM,OAAO,GAAG;IACpB,WAAW,EAAE,MAAM,CAAC;IACpB,QAAQ,EAAE,QAAQ,GAAG,OAAO,GAAG,YAAY,GAAG,OAAO,GAAG,UAAU,GAAG,MAAM,CAAC;IAC5E,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB,CAAC;AAEF,MAAM,MAAM,0BAA0B,GAAG,OAAO,GAAG;IACjD,aAAa,EAAE,MAAM,CAAC;CACvB,CAAC"}
1
+ {"version":3,"file":"register-component.d.ts","sourceRoot":"","sources":["../../src/types/register-component.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,eAAO,MAAM,cAAc;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAoCjB,CAAC;AAEX,MAAM,MAAM,aAAa,GACvB,CAAC,OAAO,cAAc,CAAC,CAAC,MAAM,OAAO,cAAc,CAAC,CAAC;AAEvD,MAAM,MAAM,UAAU,GAAG,sBAAsB,MAAM,EAAE,CAAC;AACxD,MAAM,WAAW,YAAY,CAAC,MAAM,GAAG,GAAG;IACxC,IAAI,CAAC,EAAE,aAAa,GAAG,UAAU,CAAC;IAClC;;;;;OAKG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAE5B;;OAEG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;IAEtB;;;OAGG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;IAEtB;;;;;;OAMG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAO7B,WAAW,CAAC,EACR;QAAE,KAAK,CAAC,EAAE,OAAO,CAAC;QAAC,MAAM,CAAC,EAAE,OAAO,CAAA;KAAE,GACrC,CAAC,CAAC,KAAK,EAAE,MAAM,KAAK;QAAE,KAAK,EAAE,OAAO,CAAC;QAAC,MAAM,EAAE,OAAO,CAAA;KAAE,CAAC,GACxD,OAAO,CAAC;IAEZ;;;;;;;;;;;;;OAaG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;CACtB;AAED;;GAEG;AACH,MAAM,MAAM,OAAO,GAAG;IACpB,WAAW,EAAE,MAAM,CAAC;IACpB,QAAQ,EAAE,QAAQ,GAAG,OAAO,GAAG,YAAY,GAAG,OAAO,GAAG,UAAU,GAAG,MAAM,CAAC;IAC5E,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB,CAAC;AAEF,MAAM,MAAM,0BAA0B,GAAG,OAAO,GAAG;IACjD,aAAa,EAAE,MAAM,CAAC;CACvB,CAAC"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@superblocksteam/library-shared",
3
- "version": "2.0.20",
3
+ "version": "2.0.21-next.1",
4
4
  "type": "module",
5
5
  "exports": {
6
6
  ".": {