Merge pull request #74 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: "5.rete-context-menu-plugin"
+      package: rete-context-menu-plugin

.gitignore

@@ -3,3 +3,4 @@ node_modules
 .vscode/
 npm-debug.log
 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",
@@ -28,7 +29,8 @@
   "devDependencies": {
     "rete": "^2.0.1",
     "rete-area-plugin": "^2.0.0",
-    "rete-cli": "^1.0.1"
+    "rete-cli": "^1.0.1",
+    "typescript": "5.0"
   },
   "dependencies": {
     "@babel/runtime": "^7.21.0"

src/index.ts

@@ -5,12 +5,22 @@ import { Item, Items, Position } from './types'
 
 export * as Presets from './presets'
 
-type Props<Schemes extends BaseSchemes> = {
+/**
+ * Context menu plugin props
+ * @priority 8
+ */
+export type Props<Schemes extends BaseSchemes> = {
+  /** delay before hiding context menu */
   delay?: number
+  /** menu items, can be produced by preset */
   items: Items<Schemes>
 }
 export type RenderMeta = { filled?: boolean }
 
+/**
+ * Signal types produced by ContextMenuPlugin instance
+ * @priority 10
+ */
 export type ContextMenuExtra =
   | RenderSignal<'contextmenu', {
     items: Item[]
@@ -23,7 +33,20 @@ type Requires<Schemes extends BaseSchemes> =
   | { type: 'unmount', data: { element: HTMLElement } }
   | { type: 'pointerdown', data: { position: Position, event: PointerEvent } }
 
+/**
+ * Plugin for context menu.
+ * Responsible for initialing rendering of context menu with predefined items.
+ * @priority 9
+ * @emits render
+ * @emits unmount
+ * @listens unmount
+ * @listens contextmenu
+ * @listens pointerdown
+ */
 export class ContextMenuPlugin<Schemes extends BaseSchemes> extends Scope<never, [Requires<Schemes> | ContextMenuExtra]> {
+  /**
+   * @param props Properties
+   */
   constructor(private props: Props<Schemes>) {
     super('context-menu')
   }

src/presets/classic/index.ts

@@ -5,6 +5,16 @@ import { Item, Items } from '../../types'
 import { createItem } from './factory'
 import { BSchemes, ItemDefinition } from './types'
 
+/**
+ * Classic context menu preset.
+ * Configures nodes/actions items for root and Delete/Clone items for nodes
+ * @param nodes List of items
+ * @example Presets.classic.setup([
+  ["Math", [
+    ["Number", () => new NumberNode()],
+  ]]
+])
+ */
 export function setup<Schemes extends BSchemes>(nodes: ItemDefinition<Schemes>[]) {
   return <Items<Schemes>>(function (context, plugin) {
     const area = plugin.parentScope<BaseAreaPlugin<Schemes, any>>(BaseAreaPlugin)

src/presets/index.ts

@@ -1 +1,6 @@
+/**
+ * Presets that create items for root and node specific context menu.
+ * @module
+*/
+
 export * as classic from './classic'

src/types.ts

@@ -4,6 +4,9 @@ import { ContextMenuPlugin } from '.'
 
 export type Position = { x: number, y: number }
 
+/**
+ * Item type of context menu
+ */
 export type Item = {
   label: string
   key: string