@kabel-project/kabel 1.0.7
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.
- package/(1.0.7)kabel.md +18 -0
- package/README.md +96 -0
- package/_READ_ME_MEDIA_/documentation/docs.md +293 -0
- package/_READ_ME_MEDIA_/workspace.png +0 -0
- package/comment-renderer/renderer.ts +228 -0
- package/controllers/base.ts +186 -0
- package/controllers/wasd.ts +132 -0
- package/docs/README.md +98 -0
- package/docs/_media/docs.md +289 -0
- package/docs/_media/index.html +168 -0
- package/docs/_media/workspace.png +0 -0
- package/docs/classes/CommentModel.md +271 -0
- package/docs/classes/CommentRenderer.md +457 -0
- package/docs/classes/ConnectableField.md +597 -0
- package/docs/classes/Connection.md +191 -0
- package/docs/classes/ContextMenuHTML.md +163 -0
- package/docs/classes/Coordinates.md +187 -0
- package/docs/classes/DropdownContainer.md +300 -0
- package/docs/classes/DummyField.md +393 -0
- package/docs/classes/Eventer.md +185 -0
- package/docs/classes/Field.md +461 -0
- package/docs/classes/InjectMsg.md +85 -0
- package/docs/classes/NodeSvg.md +1011 -0
- package/docs/classes/NumberField.md +559 -0
- package/docs/classes/OptConnectField.md +624 -0
- package/docs/classes/Renderer.md +1636 -0
- package/docs/classes/RendererConstants.md +343 -0
- package/docs/classes/Representer.md +95 -0
- package/docs/classes/RepresenterNode.md +175 -0
- package/docs/classes/TextField.md +559 -0
- package/docs/classes/Toolbox.md +172 -0
- package/docs/classes/WASDController.md +616 -0
- package/docs/classes/Widget.md +195 -0
- package/docs/classes/WorkspaceController.md +385 -0
- package/docs/classes/WorkspaceCoords.md +218 -0
- package/docs/classes/WorkspaceSvg.md +1380 -0
- package/docs/functions/clearMainWorkspace.md +20 -0
- package/docs/functions/getMainWorkspace.md +19 -0
- package/docs/functions/inject.md +35 -0
- package/docs/functions/setMainWorkspace.md +28 -0
- package/docs/globals.md +95 -0
- package/docs/interfaces/ColorStyle.md +43 -0
- package/docs/interfaces/ConnectorToFrom.md +57 -0
- package/docs/interfaces/DrawState.md +81 -0
- package/docs/interfaces/FieldConnectionData.md +25 -0
- package/docs/interfaces/FieldOptions.md +63 -0
- package/docs/interfaces/FieldRawBoxData.md +25 -0
- package/docs/interfaces/FieldVisualInfo.md +65 -0
- package/docs/interfaces/GridOptions.md +61 -0
- package/docs/interfaces/InjectOptions.md +133 -0
- package/docs/interfaces/InputFieldJson.md +50 -0
- package/docs/interfaces/KabelCommentRendering.md +31 -0
- package/docs/interfaces/KabelInterface.md +469 -0
- package/docs/interfaces/KabelNodeRendering.md +77 -0
- package/docs/interfaces/KabelUIX.md +105 -0
- package/docs/interfaces/KabelUtils.md +215 -0
- package/docs/interfaces/NodeEvents.md +42 -0
- package/docs/interfaces/NodeJson.md +104 -0
- package/docs/interfaces/NodePrototype.md +82 -0
- package/docs/interfaces/RegisteredEl.md +53 -0
- package/docs/interfaces/SerializedNode.md +128 -0
- package/docs/interfaces/TblxCategoryStruct.md +41 -0
- package/docs/interfaces/TblxFieldStruct.md +28 -0
- package/docs/interfaces/TblxNodeStruct.md +35 -0
- package/docs/interfaces/WidgetOptions.md +115 -0
- package/docs/interfaces/WidgetPrototypeList.md +15 -0
- package/docs/type-aliases/AnyField.md +13 -0
- package/docs/type-aliases/AnyFieldCls.md +13 -0
- package/docs/type-aliases/Color.md +13 -0
- package/docs/type-aliases/Connectable.md +13 -0
- package/docs/type-aliases/EventArgs.md +11 -0
- package/docs/type-aliases/EventSetupFn.md +25 -0
- package/docs/type-aliases/Hex.md +13 -0
- package/docs/type-aliases/RGBObject.md +37 -0
- package/docs/type-aliases/RGBString.md +13 -0
- package/docs/type-aliases/RGBTuple.md +13 -0
- package/docs/type-aliases/TblxObjStruct.md +52 -0
- package/docs/variables/CategoryColors.md +29 -0
- package/docs/variables/FieldMap.md +41 -0
- package/docs/variables/NodePrototypes.md +18 -0
- package/docs/variables/default.md +11 -0
- package/events/comment-drag-handle.ts +61 -0
- package/events/comment-input.ts +291 -0
- package/events/connection-line.ts +68 -0
- package/events/connector.ts +116 -0
- package/events/draggable.ts +119 -0
- package/events/events.ts +7 -0
- package/events/input-box.ts +213 -0
- package/events/node-x-btn.ts +25 -0
- package/index.d.ts +4 -0
- package/package.json +49 -0
- package/renderers/apollo/apollo.ts +21 -0
- package/renderers/apollo/constants.ts +40 -0
- package/renderers/apollo/renderer.ts +331 -0
- package/renderers/atlas/atlas.ts +15 -0
- package/renderers/constants.ts +87 -0
- package/renderers/renderer.ts +1288 -0
- package/renderers/representer-node.ts +52 -0
- package/renderers/representer.ts +25 -0
- package/src/category.ts +107 -0
- package/src/colors.ts +20 -0
- package/src/comment.ts +142 -0
- package/src/connection.ts +114 -0
- package/src/context-menu.ts +194 -0
- package/src/coordinates.ts +74 -0
- package/src/core.ts +202 -0
- package/src/ctx-menu-registry.ts +143 -0
- package/src/dropdown-menu.ts +215 -0
- package/src/field.ts +595 -0
- package/src/flyout.ts +165 -0
- package/src/fonts-manager.ts +38 -0
- package/src/grid.ts +162 -0
- package/src/headless-node.ts +27 -0
- package/src/index.ts +115 -0
- package/src/inject-headless.ts +18 -0
- package/src/inject.ts +213 -0
- package/src/main-workspace.ts +51 -0
- package/src/mutator.ts +40 -0
- package/src/node-types.ts +27 -0
- package/src/nodesvg.ts +756 -0
- package/src/prototypes.ts +9 -0
- package/src/renderer-map.ts +86 -0
- package/src/styles.css +224 -0
- package/src/toolbox.ts +125 -0
- package/src/types.ts +205 -0
- package/src/undo-redo.ts +87 -0
- package/src/visual-types.ts +29 -0
- package/src/widget-prototypes.ts +11 -0
- package/src/widget.ts +139 -0
- package/src/workspace-coords.ts +14 -0
- package/src/workspace-svg.ts +736 -0
- package/src/workspace.ts +155 -0
- package/test-server.js +61 -0
- package/themes/dark.ts +32 -0
- package/themes/default.ts +28 -0
- package/themes/themes.ts +9 -0
- package/tsconfig.json +25 -0
- package/typedoc.json +10 -0
- package/util/emitter.ts +33 -0
- package/util/env.ts +11 -0
- package/util/escape-html.ts +22 -0
- package/util/eventer.ts +108 -0
- package/util/has-prop.ts +4 -0
- package/util/parse-color.ts +42 -0
- package/util/path.ts +99 -0
- package/util/styler.ts +41 -0
- package/util/uid.ts +184 -0
- package/util/unescape-html.ts +22 -0
- package/util/user-state.ts +68 -0
- package/util/wait-anim-frames.ts +24 -0
- package/util/window-listeners.ts +62 -0
- package/webpack.config.js +80 -0
|
@@ -0,0 +1,128 @@
|
|
|
1
|
+
[**Kabel Project Docs v1.0.6**](../README.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[Kabel Project Docs](../globals.md) / SerializedNode
|
|
6
|
+
|
|
7
|
+
# Interface: SerializedNode
|
|
8
|
+
|
|
9
|
+
Defined in: [src/nodesvg.ts:81](https://github.com/FentFentFent/Kabel/blob/6a658c7afa967c18ecfb5cdff24af90b7d7319c3/src/nodesvg.ts#L81)
|
|
10
|
+
|
|
11
|
+
Represents a fully serialized node including its fields, colors, coordinates, connections, and optional comment.
|
|
12
|
+
Used for saving or transferring node data.
|
|
13
|
+
|
|
14
|
+
## Properties
|
|
15
|
+
|
|
16
|
+
### colors
|
|
17
|
+
|
|
18
|
+
> **colors**: [`ColorStyle`](ColorStyle.md)
|
|
19
|
+
|
|
20
|
+
Defined in: [src/nodesvg.ts:92](https://github.com/FentFentFent/Kabel/blob/6a658c7afa967c18ecfb5cdff24af90b7d7319c3/src/nodesvg.ts#L92)
|
|
21
|
+
|
|
22
|
+
Node colors including primary, secondary, tertiary, and category
|
|
23
|
+
|
|
24
|
+
***
|
|
25
|
+
|
|
26
|
+
### comment?
|
|
27
|
+
|
|
28
|
+
> `optional` **comment**: `CommentSerialized`
|
|
29
|
+
|
|
30
|
+
Defined in: [src/nodesvg.ts:98](https://github.com/FentFentFent/Kabel/blob/6a658c7afa967c18ecfb5cdff24af90b7d7319c3/src/nodesvg.ts#L98)
|
|
31
|
+
|
|
32
|
+
Optional comment text attached to the node
|
|
33
|
+
|
|
34
|
+
***
|
|
35
|
+
|
|
36
|
+
### fields?
|
|
37
|
+
|
|
38
|
+
> `optional` **fields**: `any`[]
|
|
39
|
+
|
|
40
|
+
Defined in: [src/nodesvg.ts:101](https://github.com/FentFentFent/Kabel/blob/6a658c7afa967c18ecfb5cdff24af90b7d7319c3/src/nodesvg.ts#L101)
|
|
41
|
+
|
|
42
|
+
Array of serialized fields, may contain any field-specific structure
|
|
43
|
+
|
|
44
|
+
***
|
|
45
|
+
|
|
46
|
+
### id
|
|
47
|
+
|
|
48
|
+
> **id**: `string`
|
|
49
|
+
|
|
50
|
+
Defined in: [src/nodesvg.ts:86](https://github.com/FentFentFent/Kabel/blob/6a658c7afa967c18ecfb5cdff24af90b7d7319c3/src/nodesvg.ts#L86)
|
|
51
|
+
|
|
52
|
+
Unique node ID
|
|
53
|
+
|
|
54
|
+
***
|
|
55
|
+
|
|
56
|
+
### label
|
|
57
|
+
|
|
58
|
+
> **label**: `string`
|
|
59
|
+
|
|
60
|
+
Defined in: [src/nodesvg.ts:89](https://github.com/FentFentFent/Kabel/blob/6a658c7afa967c18ecfb5cdff24af90b7d7319c3/src/nodesvg.ts#L89)
|
|
61
|
+
|
|
62
|
+
Display label of the node
|
|
63
|
+
|
|
64
|
+
***
|
|
65
|
+
|
|
66
|
+
### nextConnection?
|
|
67
|
+
|
|
68
|
+
> `optional` **nextConnection**: `object`
|
|
69
|
+
|
|
70
|
+
Defined in: [src/nodesvg.ts:113](https://github.com/FentFentFent/Kabel/blob/6a658c7afa967c18ecfb5cdff24af90b7d7319c3/src/nodesvg.ts#L113)
|
|
71
|
+
|
|
72
|
+
Serialized representation of the next connection.
|
|
73
|
+
If `field` is true, the connection originates from a field rather than a node.
|
|
74
|
+
|
|
75
|
+
#### field?
|
|
76
|
+
|
|
77
|
+
> `optional` **field**: `boolean`
|
|
78
|
+
|
|
79
|
+
#### node?
|
|
80
|
+
|
|
81
|
+
> `optional` **node**: `SerializedNode`
|
|
82
|
+
|
|
83
|
+
***
|
|
84
|
+
|
|
85
|
+
### previousConnection?
|
|
86
|
+
|
|
87
|
+
> `optional` **previousConnection**: `object`
|
|
88
|
+
|
|
89
|
+
Defined in: [src/nodesvg.ts:107](https://github.com/FentFentFent/Kabel/blob/6a658c7afa967c18ecfb5cdff24af90b7d7319c3/src/nodesvg.ts#L107)
|
|
90
|
+
|
|
91
|
+
Serialized representation of the previous connection.
|
|
92
|
+
If `field` is true, the connection originates from a field rather than a node.
|
|
93
|
+
|
|
94
|
+
#### field?
|
|
95
|
+
|
|
96
|
+
> `optional` **field**: `boolean`
|
|
97
|
+
|
|
98
|
+
#### node?
|
|
99
|
+
|
|
100
|
+
> `optional` **node**: `SerializedNode`
|
|
101
|
+
|
|
102
|
+
***
|
|
103
|
+
|
|
104
|
+
### relativeCoords
|
|
105
|
+
|
|
106
|
+
> **relativeCoords**: `object`
|
|
107
|
+
|
|
108
|
+
Defined in: [src/nodesvg.ts:95](https://github.com/FentFentFent/Kabel/blob/6a658c7afa967c18ecfb5cdff24af90b7d7319c3/src/nodesvg.ts#L95)
|
|
109
|
+
|
|
110
|
+
Coordinates of the node relative to its workspace
|
|
111
|
+
|
|
112
|
+
#### x
|
|
113
|
+
|
|
114
|
+
> **x**: `number`
|
|
115
|
+
|
|
116
|
+
#### y
|
|
117
|
+
|
|
118
|
+
> **y**: `number`
|
|
119
|
+
|
|
120
|
+
***
|
|
121
|
+
|
|
122
|
+
### type
|
|
123
|
+
|
|
124
|
+
> **type**: `string`
|
|
125
|
+
|
|
126
|
+
Defined in: [src/nodesvg.ts:83](https://github.com/FentFentFent/Kabel/blob/6a658c7afa967c18ecfb5cdff24af90b7d7319c3/src/nodesvg.ts#L83)
|
|
127
|
+
|
|
128
|
+
Node type string
|
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
[**Kabel Project Docs v1.0.6**](../README.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[Kabel Project Docs](../globals.md) / TblxCategoryStruct
|
|
6
|
+
|
|
7
|
+
# Interface: TblxCategoryStruct
|
|
8
|
+
|
|
9
|
+
Defined in: [src/inject.ts:43](https://github.com/FentFentFent/Kabel/blob/6a658c7afa967c18ecfb5cdff24af90b7d7319c3/src/inject.ts#L43)
|
|
10
|
+
|
|
11
|
+
Represents a category in the toolbox, which contains multiple nodes.
|
|
12
|
+
|
|
13
|
+
## Properties
|
|
14
|
+
|
|
15
|
+
### color
|
|
16
|
+
|
|
17
|
+
> **color**: [`Color`](../type-aliases/Color.md)
|
|
18
|
+
|
|
19
|
+
Defined in: [src/inject.ts:48](https://github.com/FentFentFent/Kabel/blob/6a658c7afa967c18ecfb5cdff24af90b7d7319c3/src/inject.ts#L48)
|
|
20
|
+
|
|
21
|
+
Category color
|
|
22
|
+
|
|
23
|
+
***
|
|
24
|
+
|
|
25
|
+
### contents
|
|
26
|
+
|
|
27
|
+
> **contents**: [`TblxNodeStruct`](TblxNodeStruct.md)[]
|
|
28
|
+
|
|
29
|
+
Defined in: [src/inject.ts:51](https://github.com/FentFentFent/Kabel/blob/6a658c7afa967c18ecfb5cdff24af90b7d7319c3/src/inject.ts#L51)
|
|
30
|
+
|
|
31
|
+
Nodes contained in this category
|
|
32
|
+
|
|
33
|
+
***
|
|
34
|
+
|
|
35
|
+
### name
|
|
36
|
+
|
|
37
|
+
> **name**: `string`
|
|
38
|
+
|
|
39
|
+
Defined in: [src/inject.ts:45](https://github.com/FentFentFent/Kabel/blob/6a658c7afa967c18ecfb5cdff24af90b7d7319c3/src/inject.ts#L45)
|
|
40
|
+
|
|
41
|
+
Category name
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
[**Kabel Project Docs v1.0.6**](../README.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[Kabel Project Docs](../globals.md) / TblxFieldStruct
|
|
6
|
+
|
|
7
|
+
# Interface: TblxFieldStruct
|
|
8
|
+
|
|
9
|
+
Defined in: [src/inject.ts:19](https://github.com/FentFentFent/Kabel/blob/6a658c7afa967c18ecfb5cdff24af90b7d7319c3/src/inject.ts#L19)
|
|
10
|
+
|
|
11
|
+
Represents a field in a toolbox node.
|
|
12
|
+
Can contain any extra properties as needed by the field type.
|
|
13
|
+
|
|
14
|
+
## Indexable
|
|
15
|
+
|
|
16
|
+
\[`key`: `string`\]: `any`
|
|
17
|
+
|
|
18
|
+
Additional field-specific properties
|
|
19
|
+
|
|
20
|
+
## Properties
|
|
21
|
+
|
|
22
|
+
### value
|
|
23
|
+
|
|
24
|
+
> **value**: `any`
|
|
25
|
+
|
|
26
|
+
Defined in: [src/inject.ts:21](https://github.com/FentFentFent/Kabel/blob/6a658c7afa967c18ecfb5cdff24af90b7d7319c3/src/inject.ts#L21)
|
|
27
|
+
|
|
28
|
+
Field value
|
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
[**Kabel Project Docs v1.0.6**](../README.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[Kabel Project Docs](../globals.md) / TblxNodeStruct
|
|
6
|
+
|
|
7
|
+
# Interface: TblxNodeStruct
|
|
8
|
+
|
|
9
|
+
Defined in: [src/inject.ts:30](https://github.com/FentFentFent/Kabel/blob/6a658c7afa967c18ecfb5cdff24af90b7d7319c3/src/inject.ts#L30)
|
|
10
|
+
|
|
11
|
+
Represents a node in a toolbox.
|
|
12
|
+
|
|
13
|
+
## Properties
|
|
14
|
+
|
|
15
|
+
### arguments
|
|
16
|
+
|
|
17
|
+
> **arguments**: `object`
|
|
18
|
+
|
|
19
|
+
Defined in: [src/inject.ts:35](https://github.com/FentFentFent/Kabel/blob/6a658c7afa967c18ecfb5cdff24af90b7d7319c3/src/inject.ts#L35)
|
|
20
|
+
|
|
21
|
+
Map of field names to field data
|
|
22
|
+
|
|
23
|
+
#### Index Signature
|
|
24
|
+
|
|
25
|
+
\[`key`: `string`\]: [`TblxFieldStruct`](TblxFieldStruct.md)
|
|
26
|
+
|
|
27
|
+
***
|
|
28
|
+
|
|
29
|
+
### type
|
|
30
|
+
|
|
31
|
+
> **type**: `string` \| `number`
|
|
32
|
+
|
|
33
|
+
Defined in: [src/inject.ts:32](https://github.com/FentFentFent/Kabel/blob/6a658c7afa967c18ecfb5cdff24af90b7d7319c3/src/inject.ts#L32)
|
|
34
|
+
|
|
35
|
+
Node type (matches NodePrototypes key or arbitrary string)
|
|
@@ -0,0 +1,115 @@
|
|
|
1
|
+
[**Kabel Project Docs v1.0.6**](../README.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[Kabel Project Docs](../globals.md) / WidgetOptions
|
|
6
|
+
|
|
7
|
+
# Interface: WidgetOptions
|
|
8
|
+
|
|
9
|
+
Defined in: [src/widget.ts:6](https://github.com/FentFentFent/Kabel/blob/6a658c7afa967c18ecfb5cdff24af90b7d7319c3/src/widget.ts#L6)
|
|
10
|
+
|
|
11
|
+
## Properties
|
|
12
|
+
|
|
13
|
+
### className?
|
|
14
|
+
|
|
15
|
+
> `optional` **className**: `string`
|
|
16
|
+
|
|
17
|
+
Defined in: [src/widget.ts:26](https://github.com/FentFentFent/Kabel/blob/6a658c7afa967c18ecfb5cdff24af90b7d7319c3/src/widget.ts#L26)
|
|
18
|
+
|
|
19
|
+
Class to give the widget's html container.
|
|
20
|
+
|
|
21
|
+
***
|
|
22
|
+
|
|
23
|
+
### cls?
|
|
24
|
+
|
|
25
|
+
> `optional` **cls**: *typeof* [`Widget`](../classes/Widget.md)
|
|
26
|
+
|
|
27
|
+
Defined in: [src/widget.ts:10](https://github.com/FentFentFent/Kabel/blob/6a658c7afa967c18ecfb5cdff24af90b7d7319c3/src/widget.ts#L10)
|
|
28
|
+
|
|
29
|
+
Widget class to instantiate for the widget, by default it uses Kabel's
|
|
30
|
+
|
|
31
|
+
***
|
|
32
|
+
|
|
33
|
+
### coords?
|
|
34
|
+
|
|
35
|
+
> `optional` **coords**: [`Coordinates`](../classes/Coordinates.md)
|
|
36
|
+
|
|
37
|
+
Defined in: [src/widget.ts:14](https://github.com/FentFentFent/Kabel/blob/6a658c7afa967c18ecfb5cdff24af90b7d7319c3/src/widget.ts#L14)
|
|
38
|
+
|
|
39
|
+
Coordinates to spawn the widget at.
|
|
40
|
+
|
|
41
|
+
***
|
|
42
|
+
|
|
43
|
+
### height?
|
|
44
|
+
|
|
45
|
+
> `optional` **height**: `number`
|
|
46
|
+
|
|
47
|
+
Defined in: [src/widget.ts:22](https://github.com/FentFentFent/Kabel/blob/6a658c7afa967c18ecfb5cdff24af90b7d7319c3/src/widget.ts#L22)
|
|
48
|
+
|
|
49
|
+
Height of the widget.
|
|
50
|
+
|
|
51
|
+
***
|
|
52
|
+
|
|
53
|
+
### html?
|
|
54
|
+
|
|
55
|
+
> `optional` **html**: `string`
|
|
56
|
+
|
|
57
|
+
Defined in: [src/widget.ts:30](https://github.com/FentFentFent/Kabel/blob/6a658c7afa967c18ecfb5cdff24af90b7d7319c3/src/widget.ts#L30)
|
|
58
|
+
|
|
59
|
+
Widget inner HTML default content.
|
|
60
|
+
|
|
61
|
+
***
|
|
62
|
+
|
|
63
|
+
### init()?
|
|
64
|
+
|
|
65
|
+
> `optional` **init**: (`this`, `widget`, `html`) => `void`
|
|
66
|
+
|
|
67
|
+
Defined in: [src/widget.ts:42](https://github.com/FentFentFent/Kabel/blob/6a658c7afa967c18ecfb5cdff24af90b7d7319c3/src/widget.ts#L42)
|
|
68
|
+
|
|
69
|
+
Sets up a new widget of this type
|
|
70
|
+
|
|
71
|
+
#### Parameters
|
|
72
|
+
|
|
73
|
+
##### this
|
|
74
|
+
|
|
75
|
+
`WidgetOptions`
|
|
76
|
+
|
|
77
|
+
This context of the function points to widget.
|
|
78
|
+
|
|
79
|
+
##### widget
|
|
80
|
+
|
|
81
|
+
[`Widget`](../classes/Widget.md)
|
|
82
|
+
|
|
83
|
+
The widget this function is called on.
|
|
84
|
+
|
|
85
|
+
##### html
|
|
86
|
+
|
|
87
|
+
`HTMLElement`
|
|
88
|
+
|
|
89
|
+
The html container of the widget.
|
|
90
|
+
|
|
91
|
+
#### Returns
|
|
92
|
+
|
|
93
|
+
`void`
|
|
94
|
+
|
|
95
|
+
- Void.
|
|
96
|
+
|
|
97
|
+
***
|
|
98
|
+
|
|
99
|
+
### name
|
|
100
|
+
|
|
101
|
+
> **name**: `string`
|
|
102
|
+
|
|
103
|
+
Defined in: [src/widget.ts:34](https://github.com/FentFentFent/Kabel/blob/6a658c7afa967c18ecfb5cdff24af90b7d7319c3/src/widget.ts#L34)
|
|
104
|
+
|
|
105
|
+
Widget name
|
|
106
|
+
|
|
107
|
+
***
|
|
108
|
+
|
|
109
|
+
### width?
|
|
110
|
+
|
|
111
|
+
> `optional` **width**: `number`
|
|
112
|
+
|
|
113
|
+
Defined in: [src/widget.ts:18](https://github.com/FentFentFent/Kabel/blob/6a658c7afa967c18ecfb5cdff24af90b7d7319c3/src/widget.ts#L18)
|
|
114
|
+
|
|
115
|
+
Width of the widget
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
[**Kabel Project Docs v1.0.6**](../README.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[Kabel Project Docs](../globals.md) / WidgetPrototypeList
|
|
6
|
+
|
|
7
|
+
# Interface: WidgetPrototypeList
|
|
8
|
+
|
|
9
|
+
Defined in: [src/widget-prototypes.ts:6](https://github.com/FentFentFent/Kabel/blob/6a658c7afa967c18ecfb5cdff24af90b7d7319c3/src/widget-prototypes.ts#L6)
|
|
10
|
+
|
|
11
|
+
A list of prototypes for widgets.
|
|
12
|
+
|
|
13
|
+
## Indexable
|
|
14
|
+
|
|
15
|
+
\[`key`: `string`\]: [`WidgetOptions`](WidgetOptions.md)
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
[**Kabel Project Docs v1.0.6**](../README.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[Kabel Project Docs](../globals.md) / AnyField
|
|
6
|
+
|
|
7
|
+
# Type Alias: AnyField
|
|
8
|
+
|
|
9
|
+
> **AnyField** = [`Field`](../classes/Field.md) \| [`OptConnectField`](../classes/OptConnectField.md) \| [`NumberField`](../classes/NumberField.md) \| [`TextField`](../classes/TextField.md) \| [`DummyField`](../classes/DummyField.md) \| [`ConnectableField`](../classes/ConnectableField.md)
|
|
10
|
+
|
|
11
|
+
Defined in: [src/field.ts:571](https://github.com/FentFentFent/Kabel/blob/6a658c7afa967c18ecfb5cdff24af90b7d7319c3/src/field.ts#L571)
|
|
12
|
+
|
|
13
|
+
Any field instance type
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
[**Kabel Project Docs v1.0.6**](../README.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[Kabel Project Docs](../globals.md) / AnyFieldCls
|
|
6
|
+
|
|
7
|
+
# Type Alias: AnyFieldCls
|
|
8
|
+
|
|
9
|
+
> **AnyFieldCls** = *typeof* [`Field`](../classes/Field.md) \| *typeof* [`OptConnectField`](../classes/OptConnectField.md) \| *typeof* [`ConnectableField`](../classes/ConnectableField.md) \| *typeof* [`NumberField`](../classes/NumberField.md) \| *typeof* [`TextField`](../classes/TextField.md) \| *typeof* [`DummyField`](../classes/DummyField.md)
|
|
10
|
+
|
|
11
|
+
Defined in: [src/field.ts:575](https://github.com/FentFentFent/Kabel/blob/6a658c7afa967c18ecfb5cdff24af90b7d7319c3/src/field.ts#L575)
|
|
12
|
+
|
|
13
|
+
Any field class type
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
[**Kabel Project Docs v1.0.6**](../README.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[Kabel Project Docs](../globals.md) / Color
|
|
6
|
+
|
|
7
|
+
# Type Alias: Color
|
|
8
|
+
|
|
9
|
+
> **Color** = [`RGBObject`](RGBObject.md) \| [`RGBString`](RGBString.md) \| [`RGBTuple`](RGBTuple.md) \| [`Hex`](Hex.md)
|
|
10
|
+
|
|
11
|
+
Defined in: [src/visual-types.ts:20](https://github.com/FentFentFent/Kabel/blob/6a658c7afa967c18ecfb5cdff24af90b7d7319c3/src/visual-types.ts#L20)
|
|
12
|
+
|
|
13
|
+
A color, whether it be #ffffff, {r, g, b}, 'r, g, b', or [r, g, b]
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
[**Kabel Project Docs v1.0.6**](../README.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[Kabel Project Docs](../globals.md) / Connectable
|
|
6
|
+
|
|
7
|
+
# Type Alias: Connectable
|
|
8
|
+
|
|
9
|
+
> **Connectable** = [`NodeSvg`](../classes/NodeSvg.md) \| `null` \| [`Field`](../classes/Field.md)
|
|
10
|
+
|
|
11
|
+
Defined in: [src/connection.ts:7](https://github.com/FentFentFent/Kabel/blob/6a658c7afa967c18ecfb5cdff24af90b7d7319c3/src/connection.ts#L7)
|
|
12
|
+
|
|
13
|
+
A node or field that can participate in a connection.
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
[**Kabel Project Docs v1.0.6**](../README.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[Kabel Project Docs](../globals.md) / EventArgs
|
|
6
|
+
|
|
7
|
+
# Type Alias: EventArgs
|
|
8
|
+
|
|
9
|
+
> **EventArgs** = `Record`\<`string`, `any`\>
|
|
10
|
+
|
|
11
|
+
Defined in: [util/eventer.ts:4](https://github.com/FentFentFent/Kabel/blob/6a658c7afa967c18ecfb5cdff24af90b7d7319c3/util/eventer.ts#L4)
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
[**Kabel Project Docs v1.0.6**](../README.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[Kabel Project Docs](../globals.md) / EventSetupFn
|
|
6
|
+
|
|
7
|
+
# Type Alias: EventSetupFn()
|
|
8
|
+
|
|
9
|
+
> **EventSetupFn** = (`el`, `args?`) => () => `void` \| `void`
|
|
10
|
+
|
|
11
|
+
Defined in: [util/eventer.ts:5](https://github.com/FentFentFent/Kabel/blob/6a658c7afa967c18ecfb5cdff24af90b7d7319c3/util/eventer.ts#L5)
|
|
12
|
+
|
|
13
|
+
## Parameters
|
|
14
|
+
|
|
15
|
+
### el
|
|
16
|
+
|
|
17
|
+
`Element`
|
|
18
|
+
|
|
19
|
+
### args?
|
|
20
|
+
|
|
21
|
+
[`EventArgs`](EventArgs.md)
|
|
22
|
+
|
|
23
|
+
## Returns
|
|
24
|
+
|
|
25
|
+
() => `void` \| `void`
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
[**Kabel Project Docs v1.0.6**](../README.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[Kabel Project Docs](../globals.md) / Hex
|
|
6
|
+
|
|
7
|
+
# Type Alias: Hex
|
|
8
|
+
|
|
9
|
+
> **Hex** = `` `#${string}` ``
|
|
10
|
+
|
|
11
|
+
Defined in: [src/visual-types.ts:16](https://github.com/FentFentFent/Kabel/blob/6a658c7afa967c18ecfb5cdff24af90b7d7319c3/src/visual-types.ts#L16)
|
|
12
|
+
|
|
13
|
+
A hex color
|
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
[**Kabel Project Docs v1.0.6**](../README.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[Kabel Project Docs](../globals.md) / RGBObject
|
|
6
|
+
|
|
7
|
+
# Type Alias: RGBObject
|
|
8
|
+
|
|
9
|
+
> **RGBObject** = `object`
|
|
10
|
+
|
|
11
|
+
Defined in: [src/visual-types.ts:4](https://github.com/FentFentFent/Kabel/blob/6a658c7afa967c18ecfb5cdff24af90b7d7319c3/src/visual-types.ts#L4)
|
|
12
|
+
|
|
13
|
+
A RGB array (ex: {r: 255, g: 255, b: 255})
|
|
14
|
+
|
|
15
|
+
## Properties
|
|
16
|
+
|
|
17
|
+
### b
|
|
18
|
+
|
|
19
|
+
> **b**: `number`
|
|
20
|
+
|
|
21
|
+
Defined in: [src/visual-types.ts:4](https://github.com/FentFentFent/Kabel/blob/6a658c7afa967c18ecfb5cdff24af90b7d7319c3/src/visual-types.ts#L4)
|
|
22
|
+
|
|
23
|
+
***
|
|
24
|
+
|
|
25
|
+
### g
|
|
26
|
+
|
|
27
|
+
> **g**: `number`
|
|
28
|
+
|
|
29
|
+
Defined in: [src/visual-types.ts:4](https://github.com/FentFentFent/Kabel/blob/6a658c7afa967c18ecfb5cdff24af90b7d7319c3/src/visual-types.ts#L4)
|
|
30
|
+
|
|
31
|
+
***
|
|
32
|
+
|
|
33
|
+
### r
|
|
34
|
+
|
|
35
|
+
> **r**: `number`
|
|
36
|
+
|
|
37
|
+
Defined in: [src/visual-types.ts:4](https://github.com/FentFentFent/Kabel/blob/6a658c7afa967c18ecfb5cdff24af90b7d7319c3/src/visual-types.ts#L4)
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
[**Kabel Project Docs v1.0.6**](../README.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[Kabel Project Docs](../globals.md) / RGBString
|
|
6
|
+
|
|
7
|
+
# Type Alias: RGBString
|
|
8
|
+
|
|
9
|
+
> **RGBString** = `` `${number}, ${number}, ${number}` ``
|
|
10
|
+
|
|
11
|
+
Defined in: [src/visual-types.ts:12](https://github.com/FentFentFent/Kabel/blob/6a658c7afa967c18ecfb5cdff24af90b7d7319c3/src/visual-types.ts#L12)
|
|
12
|
+
|
|
13
|
+
A RGB string (ex: '255, 255, 255')
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
[**Kabel Project Docs v1.0.6**](../README.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[Kabel Project Docs](../globals.md) / RGBTuple
|
|
6
|
+
|
|
7
|
+
# Type Alias: RGBTuple
|
|
8
|
+
|
|
9
|
+
> **RGBTuple** = \[`number`, `number`, `number`\]
|
|
10
|
+
|
|
11
|
+
Defined in: [src/visual-types.ts:8](https://github.com/FentFentFent/Kabel/blob/6a658c7afa967c18ecfb5cdff24af90b7d7319c3/src/visual-types.ts#L8)
|
|
12
|
+
|
|
13
|
+
A RGB tuple (ex: [255, 255, 255])
|
|
@@ -0,0 +1,52 @@
|
|
|
1
|
+
[**Kabel Project Docs v1.0.6**](../README.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[Kabel Project Docs](../globals.md) / TblxObjStruct
|
|
6
|
+
|
|
7
|
+
# Type Alias: TblxObjStruct
|
|
8
|
+
|
|
9
|
+
> **TblxObjStruct** = \{ `contents`: [`TblxNodeStruct`](../interfaces/TblxNodeStruct.md)[]; `type`: `"flyout"`; \} \| \{ `contents`: [`TblxCategoryStruct`](../interfaces/TblxCategoryStruct.md)[]; `type?`: `"category"`; \} \| \{ `contents`: [`TblxCategoryStruct`](../interfaces/TblxCategoryStruct.md)[]; `type?`: `undefined`; \}
|
|
10
|
+
|
|
11
|
+
Defined in: [src/inject.ts:58](https://github.com/FentFentFent/Kabel/blob/6a658c7afa967c18ecfb5cdff24af90b7d7319c3/src/inject.ts#L58)
|
|
12
|
+
|
|
13
|
+
Discriminated union type representing possible toolbox structures.
|
|
14
|
+
Can be a flyout (list of nodes) or a categorized toolbox.
|
|
15
|
+
|
|
16
|
+
## Type Declaration
|
|
17
|
+
|
|
18
|
+
\{ `contents`: [`TblxNodeStruct`](../interfaces/TblxNodeStruct.md)[]; `type`: `"flyout"`; \}
|
|
19
|
+
|
|
20
|
+
### contents
|
|
21
|
+
|
|
22
|
+
> **contents**: [`TblxNodeStruct`](../interfaces/TblxNodeStruct.md)[]
|
|
23
|
+
|
|
24
|
+
### type
|
|
25
|
+
|
|
26
|
+
> **type**: `"flyout"`
|
|
27
|
+
|
|
28
|
+
Flyout toolbox type
|
|
29
|
+
|
|
30
|
+
\{ `contents`: [`TblxCategoryStruct`](../interfaces/TblxCategoryStruct.md)[]; `type?`: `"category"`; \}
|
|
31
|
+
|
|
32
|
+
### contents
|
|
33
|
+
|
|
34
|
+
> **contents**: [`TblxCategoryStruct`](../interfaces/TblxCategoryStruct.md)[]
|
|
35
|
+
|
|
36
|
+
### type?
|
|
37
|
+
|
|
38
|
+
> `optional` **type**: `"category"`
|
|
39
|
+
|
|
40
|
+
Categorized toolbox type
|
|
41
|
+
|
|
42
|
+
\{ `contents`: [`TblxCategoryStruct`](../interfaces/TblxCategoryStruct.md)[]; `type?`: `undefined`; \}
|
|
43
|
+
|
|
44
|
+
### contents
|
|
45
|
+
|
|
46
|
+
> **contents**: [`TblxCategoryStruct`](../interfaces/TblxCategoryStruct.md)[]
|
|
47
|
+
|
|
48
|
+
### type?
|
|
49
|
+
|
|
50
|
+
> `optional` **type**: `undefined`
|
|
51
|
+
|
|
52
|
+
When type is omitted, defaults to categories
|
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
[**Kabel Project Docs v1.0.6**](../README.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[Kabel Project Docs](../globals.md) / CategoryColors
|
|
6
|
+
|
|
7
|
+
# Variable: CategoryColors
|
|
8
|
+
|
|
9
|
+
> `const` **CategoryColors**: `object` = `{}`
|
|
10
|
+
|
|
11
|
+
Defined in: [src/colors.ts:18](https://github.com/FentFentFent/Kabel/blob/6a658c7afa967c18ecfb5cdff24af90b7d7319c3/src/colors.ts#L18)
|
|
12
|
+
|
|
13
|
+
Stores color styles for node categories.
|
|
14
|
+
|
|
15
|
+
Each key is a category name, and the value is a ColorStyle object
|
|
16
|
+
containing colors like primary, secondary, and tertiary.
|
|
17
|
+
|
|
18
|
+
Example:
|
|
19
|
+
```ts
|
|
20
|
+
CategoryColors["logic"] = {
|
|
21
|
+
primary: "#FF0000",
|
|
22
|
+
secondary: "#00FF00",
|
|
23
|
+
tertiary: "#0000FF"
|
|
24
|
+
};
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
## Index Signature
|
|
28
|
+
|
|
29
|
+
\[`key`: `string`\]: [`ColorStyle`](../interfaces/ColorStyle.md)
|
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
[**Kabel Project Docs v1.0.6**](../README.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[Kabel Project Docs](../globals.md) / FieldMap
|
|
6
|
+
|
|
7
|
+
# Variable: FieldMap
|
|
8
|
+
|
|
9
|
+
> `const` **FieldMap**: `object`
|
|
10
|
+
|
|
11
|
+
Defined in: [src/field.ts:576](https://github.com/FentFentFent/Kabel/blob/6a658c7afa967c18ecfb5cdff24af90b7d7319c3/src/field.ts#L576)
|
|
12
|
+
|
|
13
|
+
## Type Declaration
|
|
14
|
+
|
|
15
|
+
## Index Signature
|
|
16
|
+
|
|
17
|
+
\[`key`: `string`\]: [`AnyFieldCls`](../type-aliases/AnyFieldCls.md)
|
|
18
|
+
|
|
19
|
+
### connection
|
|
20
|
+
|
|
21
|
+
> **connection**: *typeof* [`ConnectableField`](../classes/ConnectableField.md)
|
|
22
|
+
|
|
23
|
+
### field\_both
|
|
24
|
+
|
|
25
|
+
> **field\_both**: *typeof* [`OptConnectField`](../classes/OptConnectField.md)
|
|
26
|
+
|
|
27
|
+
### field\_dummy
|
|
28
|
+
|
|
29
|
+
> **field\_dummy**: *typeof* [`DummyField`](../classes/DummyField.md)
|
|
30
|
+
|
|
31
|
+
### field\_num
|
|
32
|
+
|
|
33
|
+
> **field\_num**: *typeof* [`NumberField`](../classes/NumberField.md)
|
|
34
|
+
|
|
35
|
+
### field\_str
|
|
36
|
+
|
|
37
|
+
> **field\_str**: *typeof* [`TextField`](../classes/TextField.md)
|
|
38
|
+
|
|
39
|
+
### field\_string
|
|
40
|
+
|
|
41
|
+
> **field\_string**: *typeof* [`TextField`](../classes/TextField.md)
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
[**Kabel Project Docs v1.0.6**](../README.md)
|
|
2
|
+
|
|
3
|
+
***
|
|
4
|
+
|
|
5
|
+
[Kabel Project Docs](../globals.md) / NodePrototypes
|
|
6
|
+
|
|
7
|
+
# Variable: NodePrototypes
|
|
8
|
+
|
|
9
|
+
> `const` **NodePrototypes**: `object` = `{}`
|
|
10
|
+
|
|
11
|
+
Defined in: [src/prototypes.ts:7](https://github.com/FentFentFent/Kabel/blob/6a658c7afa967c18ecfb5cdff24af90b7d7319c3/src/prototypes.ts#L7)
|
|
12
|
+
|
|
13
|
+
A registry of all node prototypes by name.
|
|
14
|
+
Maps a string key (node type name) to a NodePrototype object
|
|
15
|
+
|
|
16
|
+
## Index Signature
|
|
17
|
+
|
|
18
|
+
\[`key`: `string`\]: [`NodePrototype`](../interfaces/NodePrototype.md)
|