Sharing Comments
Summary
- Comments are cell-level annotations designed with collaboration in mind
- Users can see each other's Comments and add to the Comment Thread
- The Comment Thread is persisted (via developer provided functions) so that all users can access them
Comments are annotations that are attached to individual Cells in AG Grid.
They are stored remotely, rather than with the Grid’s underlying data source, and are designed with collaboration in mind.
The Comment popup, cell triangle and menus are AdapTable UI. Unlike Notes (which wrap AG Grid Cell Notes), Comments do not require an AG Grid module.
Note
- Comments differ from Notes — Comments enable colleague communication; Notes are personal
- Comments differ from Free Text Columns — Comments are cell-level threads; Free Text is column-shaped state (one value per row), not collaborative annotations
Multiple users can add Comments to the same Comment Thread, and all the Comments are visible to all users.
Caution
Comments are not available if you are using an auto-generated Primary Key
- Simulate two users — Alice and Bob — via the pinned user toolbar (see
adaptableOptions.tsand the framework-specific app file) - Each user sees the other’s Comments (localStorage +
BroadcastChannel); only the author can edit or delete their own Comment
- Switch between Alice and Bob, add Comments on the same cell, and confirm both users see the thread
- Try editing a Comment written by the other user — it should not be editable
Comment Threads
Comments are designed to be written at run-time, and to be used in a collaborative manner.
This is achieved by creating a Comment Thread for each cell that contains a Comment, to which all permissioned Team Members can contribute.
UI Step by Step Guide
Comment Thread Workflow
UI Entitlements
The UI Entitlements behaviour for Comments is as expected for Full and Hidden Access Levels.
The ReadOnly Entitlement behaviour is that existing Comments - either previously created or provided by other users are visible - but new Comments cannot be added.
FAQ
Can I create Comments for personal use? You can, but for that use case we recommend Notes, which are simpler and stored in AdapTable State.