Merge pull request #25 from retejs/add-docs

Add docs

.github/workflows/update-docs.yml

@@ -3,12 +3,12 @@ name: Update docs
 on:
   workflow_dispatch:
   push:
-    branches: [ "main" ]
+    branches: ["main"]
 
 jobs:
   pull:
     uses: retejs/.github/.github/workflows/update-docs.yml@main
     secrets: inherit
     with:
-      filename: '1.rete'
-      package: rete
+      filename: "12.rete-dock-plugin"
+      package: rete-dock-plugin

.gitignore

@@ -2,3 +2,4 @@ node_modules
 .idea/
 .vscode/
 dist
+docs

package.json

@@ -4,7 +4,8 @@
   "description": "",
   "scripts": {
     "build": "rete build -c rete.config.ts",
-    "lint": "rete lint"
+    "lint": "rete lint",
+    "doc": "rete doc"
   },
   "author": "Vitaliy Stoliarov",
   "license": "MIT",
@@ -26,6 +27,7 @@
     "rete-area-plugin": "^2.0.0"
   },
   "devDependencies": {
+    "@types/node": "^20.4.2",
     "rete": "^2.0.1",
     "rete-area-plugin": "^2.0.0",
     "rete-cli": "^1.0.1",

src/index.ts

@@ -8,6 +8,11 @@ import { Strategy } from './strategy'
 
 export * as DockPresets from './presets'
 
+/**
+ * Dock plugin. Allows to create nodes from the dock by dragging or clicking.
+ * @priority 10
+ * @emits render
+ */
 export class DockPlugin<Schemes extends BaseSchemes> extends Scope<never, Area2DInherited<Schemes, never>> {
   nodes = new Map<() => Schemes['Node'], { preset: Preset, element: HTMLElement }>()
   clickStrategy!: Strategy
@@ -28,6 +33,11 @@ export class DockPlugin<Schemes extends BaseSchemes> extends Scope<never, Area2D
     this.dropStrategy = new DropStrategy(editor, area)
   }
 
+  /**
+   * Add node to the dock.
+   * @param create Function that creates node.
+   * @param index Index of the node in the dock, optional.
+   */
   add(create: () => Schemes['Node'], index?: number) {
     if (!this.presets.length) throw new Error('presets not found')
 
@@ -52,6 +62,10 @@ export class DockPlugin<Schemes extends BaseSchemes> extends Scope<never, Area2D
     }
   }
 
+  /**
+   * Remove node from the dock.
+   * @param create Function that creates node. Must be the same as in `add` method.
+   */
   remove(create: () => Schemes['Node']) {
     const item = this.nodes.get(create)
 
@@ -60,6 +74,10 @@ export class DockPlugin<Schemes extends BaseSchemes> extends Scope<never, Area2D
     }
   }
 
+  /**
+   * Add preset to the dock plugin.
+   * @param preset Preset that will manage dock items.
+   */
   addPreset(preset: Preset) {
     this.presets.push(preset)
   }

src/presets/classic/index.ts

@@ -52,6 +52,14 @@ function getNodeContainer(size: number, scale: number) {
   return element
 }
 
+/**
+ * Classic preset for the dock plugin.
+ * Creates container for list of nodes and containers each node.
+ * @param props Preset properties
+ * @param props.size Size of a node
+ * @param props.scale Scale of a node
+ * @param props.area Area plugin instance
+ */
 export function setup<T>(props: { size?: number, scale?: number, area: AreaPlugin<BaseSchemes, T> }): Preset {
   const size = typeof props.size === 'undefined' ? 100 : props.size
   const scale = typeof props.scale === 'undefined' ? 0.7 : props.scale

src/presets/index.ts

@@ -1 +1,6 @@
+/**
+ * Presets for the dock plugin
+ * @module
+ */
+
 export * as classic from './classic'