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.
Note
- Comments differ to Notes as they enable inter-colleague communication, while Notes are for personal use
- Comments differ to Free Text Columns as Comments are cell-level threads, whereas Free Text Columns are column-shaped state data (one editable 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
- This example allows you to simulate 2 users - Alice and Bob - each adding Comments
- Each user can see the Comments created by their colleague, but can only edit their own Comments
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 using Notes which are more straightforward and designed for single use.