Weave.js
prerelease Prerelease 5.2.2 Latest 5.2.1
↑↓ navigate · ↵ select · esc close
Weave.js
Weave.js
prerelease Prerelease 5.2.2 Latest 5.2.1

WeaveUsersSelectionPlugin

Showcase what the users are selecting on the canvas

Overview

The WeaveUsersSelectionPlugin class that enables real-time user selection sharing across all connected users on the collaborative canvas. It displays live what each user is selecting, allowing participants to see each other’s activity and collaborate more intuitively.

This plugin helps create a shared sense of presence, making collaborative tools feel dynamic, interactive, and truly multi-user.

The class extends the WeavePlugin class

Name

This plugin name property value is usersSelection.

Import

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

Instantiation

new WeaveUsersSelectionPlugin(params: WeaveUsersSelectionPluginParams);

TypeScript types

type WeaveUser = {
  [key: string]: any;
  name: string;
  email: string;
};

type WeaveUsersSelectionPluginConfig = {
  getUser: () => WeaveUser;
  getUserColor: (user: WeaveUser) => string | CanvasGradient | undefined;
};

type WeaveUsersSelectionPluginParams = {
  config: WeaveUsersSelectionPluginConfig;
};

Parameters

For WeaveUsersSelectionPluginParams:

Property Type Required Description

config

WeaveUsersSelectionPluginConfig

Config parameters for the plugin.

For WeaveUsersSelectionPluginConfig:

Property Type Required Description

getUser

() ⇒ WeaveUser

A function that returns the actual instance user metadata.

getUserColor

(user: WeaveUser) ⇒ string | CanvasGradient | undefined

A function that returns the color (#RGB or #RGBA) to use to set the selector for the user.