WeaveUsersPointersPlugin

Overview

The WeaveUsersPointersPlugin class that enables real-time cursor sharing across all connected users on the collaborative canvas. It displays live pointer positions, often tagged with user metadata like name or color, 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 usersPointers.

Import

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

Instantiation

new WeaveUsersPointersPlugin(params: WeaveUsersPointersPluginParams);

TypeScript types

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

type WeaveUsersPointersPluginConfig = {
  getUser: () => WeaveUser;
};

type WeaveUserPointersUIProperties = {
  separation: number;
  pointer: {
    circleRadius: number;
    circleStrokeWidth: number;
  };
  name: {
    fontFamily: string;
    fontSize: number;
    backgroundCornerRadius: number;
    backgroundPaddingX: number;
    backgroundPaddingY: number;
  };
};

type WeaveUsersPointersPluginParams = {
  config: WeaveUsersPointersPluginConfig;
  ui?: WeaveUserPointersUIProperties;
};

Parameters

For WeaveUsersPointersPluginParams:

Prop	Type	Default
`config?`	`WeaveUsersPointersPluginConfig`	-

For WeaveUsersPointersPluginConfig:

Prop	Type	Default
`ui?`	`WeaveUserPointersUIProperties`	-
`getUser?`	`() => WeaveUser`	-