WeaveCommentsRendererPlugin

Overview

The WeaveCommentsRendererPlugin class represents a plugin that renders a set of comments (headless based on the defined Entity model) on a special layer on the stage.

The class extends the WeavePlugin class

Name

This plugin name property value is commentsRenderer.

Import

import { WeaveCommentsRendererPlugin } from "@inditextech/weave-sdk";

Instantiation

new WeaveCommentsRendererPlugin<T>(params: WeaveConnectedUsersPluginParams<T>);

TypeScript types

type WeaveCommentsRendererModel<T> = {
  getId: (comment: T) => string;
  getUser: (comment: T) => WeaveUser;
  getPosition: (comment: T) => Vector2d;
  getStatus: (comment: T) => WeaveCommentStatus;
};

type WeaveCommentsRendererPluginConfig<T> = {
  model: WeaveCommentsRendererModel<T>;
  getUser: () => WeaveUser;
  getUserBackgroundColor: (
    user: WeaveUser
  ) => string | CanvasGradient | undefined;
  getUserForegroundColor: (
    user: WeaveUser
  ) => string | CanvasGradient | undefined;
};

type WeaveCommentsRendererPluginParams<T> = {
  config: WeaveCommentsRendererPluginConfig<T>;
};

Parameters

For WeaveConnectedUsersPluginParams<T>:

Property Type Required Description

Property	Type	Required	Description
`config`	`WeaveCommentsRendererPluginConfig<T>`	Required	Config parameters for the plugin.

config

WeaveCommentsRendererPluginConfig<T>

Required

Config parameters for the plugin.

For WeaveCommentsRendererPluginConfig<T>:

Property Type Required Description

Property	Type	Required	Description
`model`	`WeaveCommentsRendererModel<T>`	Required	Setup the Entity model
`getUser`	`() ⇒ WeaveUser`	Required	A function that return the actual user model
`getUserBackgroundColor`	`(user: WeaveUser) ⇒ string \| CanvasGradient \| undefined`	Required	A function that is called to define a user background color base on its model.
`getUserForegroundColor`	`(user: WeaveUser) ⇒ string \| CanvasGradient \| undefined`	Required	A function that is called to define a user foreground color base on its model.

model

WeaveCommentsRendererModel<T>

Required

Setup the Entity model

getUser

() ⇒ WeaveUser

Required

A function that return the actual user model

getUserBackgroundColor

(user: WeaveUser) ⇒ string | CanvasGradient | undefined

Required

A function that is called to define a user background color base on its model.

getUserForegroundColor

(user: WeaveUser) ⇒ string | CanvasGradient | undefined

Required

A function that is called to define a user foreground color base on its model.