Vizel API / core/src / VizelCommentOptions

Interface: VizelCommentOptions

Defined in: packages/core/src/comment.ts:52

Configuration options for comment management

Properties

enabled?

optional enabled?: boolean;

Defined in: packages/core/src/comment.ts:54

Enable comments (default: true)

---

key?

optional key?: string;

Defined in: packages/core/src/comment.ts:58

Storage key for localStorage (default: 'vizel-comments')

---

onAdd?

optional onAdd?: (comment) => void;

Defined in: packages/core/src/comment.ts:60

Callback when a comment is added

Parameters

Parameter	Type
comment	VizelComment

Returns

void

---

onError?

optional onError?: (error) => void;

Defined in: packages/core/src/comment.ts:71

Callback when an error occurs. The error may be a VizelError — narrow with isVizelError(error) to access the structured code field.

Parameters

Parameter	Type
error	Error

Returns

void

---

onRemove?

optional onRemove?: (commentId) => void;

Defined in: packages/core/src/comment.ts:62

Callback when a comment is removed

Parameters

Parameter	Type
commentId	string

Returns

void

---

onReopen?

optional onReopen?: (comment) => void;

Defined in: packages/core/src/comment.ts:66

Callback when a comment is reopened

Parameters

Parameter	Type
comment	VizelComment

Returns

void

---

onResolve?

optional onResolve?: (comment) => void;

Defined in: packages/core/src/comment.ts:64

Callback when a comment is resolved

Parameters

Parameter	Type
comment	VizelComment

Returns

void

---

storage?

optional storage?: VizelCommentStorage;

Defined in: packages/core/src/comment.ts:56

Storage backend (default: 'localStorage')