CommentOptions

Options for managing Comments and Comment Threads in AdapTable

TypeScript

export interface

Properties

Property	Description	Default
dateFormat	Date Format string for Comments timestamp	'dd-MM-yyyy HH:mm:ss'
isCellCommentable	Function to configure if a cell can contain Comments
showPopupCloseButton	Show the Close Button in the Comments Popup	true

Method	Description
loadCommentThreads(commentLoadContext)	Loads the Comment Threads
persistCommentThreads(commentThreads)	Persists the current Comment Threads

Date Format string for Comments timestamp

TypeScript

dateFormat?: string | (() => string);

'dd-MM-yyyy HH:mm:ss'

string | (() => string)

Function to configure if a cell can contain Comments

TypeScript

isCellCommentable?: (commentableCellContext: CommentableCellContext) => boolean;

(commentableCellContext:CommentableCellContext) => boolean

Show the Close Button in the Comments Popup

TypeScript

showPopupCloseButton?: boolean;

true

boolean

Loads the Comment Threads

TypeScript

loadCommentThreads?(commentLoadContext: CommentLoadContext): Promise<CommentThread[]>;

Parameter	Type
commentLoadContext	`CommentLoadContext`

Persists the current Comment Threads

TypeScript

persistCommentThreads?(commentThreads: CommentThread[]): Promise<void>;

Parameter	Type	Description
commentThreads	`CommentThread[]`

Promise<void>

Framework: