@univerjs/sheets-thread-comment

@univerjs/sheets-thread-comment

[](https://img.shields.io/npm/l/@univerjs/sheets- thread-comment)

Introduction

@univerjs/sheets-thread-comment provides the comment/annotation function of Univer Sheets.

Usage

Install

# Use npm
npm install @univerjs/sheets-thread-comment

# Use pnpm
pnpm add @univerjs/sheets-thread-comment

use

import { UniverSheetsThreadCommentPlugin, IThreadCommentMentionDataService} from '@univerjs/sheets-thread-comment';

const mockUser = {
    userID: 'mockId',
    name: 'MockUser',
    avatar: 'icon-url',
    anonymous: false,
    canBindAnonymous: false,
};

class CustomMentionDataService implements IThreadCommentMentionDataService {
    trigger: string = '@';

     // Get the common interface implementation of the mentioned user
    async getMentions(search: string) {
        return [
            {
                id: mockUser.userID,
                label: mockUser.name,
                type: 'user',
                icon: mockUser.avatar,
            },
            {
                id: '2',
                label: 'User2',
                type: 'user',
                icon: mockUser.avatar,
            },
        ];
    }
}

univer.registerPlugin(UniverSheetsThreadCommentPlugin, {
    overrides: [[IThreadCommentMentionDataService, { useClass: CustomMentionDataService }]],
});