API for rete-comment-plugin package

Produces

index.ts

A union of all possible signals that can be emitted by the comment plugin

type Produces =
  | { data: Comment; type: "commentcreated" }
  | { data: Comment; type: "commentremoved" }
  | { data: Comment; type: "editcomment" }
  | { data: Comment; type: "commentselected" }
  | { data: Comment; type: "commentunselected" }
  | { data: Object; type: "commenttranslated" }
  | { data: Object; type: "commentlinktranslate" };

CommentPlugin

index.ts

A plugin that provides comments for nodes

class CommentPlugin<Schemes extends ExpectedSchemes, K extends unknown>

Extends Scope<Produces, BaseArea | K>

constructor

index.ts

constructor(props: Props): CommentPlugin<Schemes, K>

Returns CommentPlugin<Schemes, K>

addFrame

index.ts

Adds a frame comment. Represents a rectangle with a text and nodes linked to it. When user translates a comment, all linked nodes will be translated as well. When user drops a node on a comment, the node will be linked to the comment.

addFrame(text: string, links: string[]): void

Returns void

addInline

index.ts

Adds an inline comment which is represented by a block with text at certain position, which is attached to the node. When user translates a node, the comment will be translated as well. When user drops a comment on a node, the comment will be linked to the node.

addInline(text: string, position: [number, number], link: string): void

Returns void

clear

index.ts

Removes all comments

clear(): void

Returns void

delete

index.ts

Removes a comment

delete(id: string): void

Returns void

editComment

index.ts

Trigger edit form for a comment

editComment(id: string): Promise<void>

Returns Promise<void>

select

index.ts

Selects a comment

select(id: string): void

Returns void

translate

index.ts

Translates a comment

translate(id: string, dx: number, dy: number): void

Returns void

unselect

index.ts

Unselects a comment

unselect(id: string): void

Returns void

CommentExtensions

extensions/index.ts

Comment plugin extensions

selectable

extensions/selectable.ts

Enables synchronization between comments and the selector

selectable(plugin: CommentPlugin<S, K>, selector: Selector<SelectorEntity>, accumulating: { active: unknown }): void

Returns void

Props

index.ts

Comment plugin properties

type Props = { edit: Function };