@veltdev/react
Version:
Velt is an SDK to add collaborative features to your product within minutes. Example: Comments like Figma, Frame.io, Google docs or sheets, Recording like Loom, Huddles like Slack and much more.
83 lines (82 loc) • 2.54 kB
TypeScript
import React from 'react';
export interface IVeltCommentsProps extends React.DetailedHTMLProps<React.HTMLAttributes<HTMLElement>, HTMLElement> {
streamViewContainerId?: string;
autoCategorize?: boolean;
onSignIn?: Function;
onUpgrade?: Function;
textMode?: boolean;
popoverMode?: boolean;
popoverTriangleComponent?: boolean;
floatingCommentDialog?: boolean;
moderatorMode?: boolean;
streamMode?: boolean;
signInButton?: boolean;
upgradeButton?: boolean;
attachments?: boolean;
/**
* Pass `all` to allow all type of recordings.
* Pass `none` to disable all type of recordings.
* Pass `string` to allow specific type of recordings.
* For example: `audio` or `video` or `screen` or any combination like `audio,video`.
*/
recordings?: string;
reactions?: boolean;
deviceInfo?: boolean;
commentIndex?: boolean;
dialogOnHover?: boolean;
dialogOnTargetElementClick?: boolean;
priority?: boolean;
status?: boolean;
resolveButton?: boolean;
inboxMode?: boolean;
suggestionMode?: boolean;
mobileMode?: boolean;
inlineCommentMode?: boolean;
privateCommentMode?: boolean;
minimap?: boolean;
persistentCommentMode?: boolean;
ghostComments?: boolean;
ghostCommentsIndicator?: boolean;
commentsOnDom?: boolean;
commentTool?: boolean;
sidebarButtonOnCommentDialog?: boolean;
deviceIndicatorOnCommentPins?: boolean;
scrollToComment?: boolean;
userMentions?: boolean;
deleteOnBackspace?: boolean;
hotkey?: boolean;
recordingSummary?: boolean;
recordingCountdown?: boolean;
allowedElementIds?: string[];
allowedElementClassNames?: string[];
allowedElementQuerySelectors?: string[];
onCommentAdd?: Function;
onCustomPinInject?: Function;
onCommentUpdate?: Function;
onCommentAccept?: Function;
onCommentReject?: Function;
onSidebarButtonOnCommentDialogClick?: Function;
customStatus?: {
id: string;
color: string;
name: string;
type: 'default' | 'ongoing' | 'terminal';
lightColor?: string;
svg?: string;
iconUrl?: string;
}[];
customPriority?: {
id: string;
color: string;
name: string;
lightColor?: string;
}[];
customCategory?: {
id: string;
color: string;
name: string;
}[];
darkMode?: boolean;
}
declare const SnippylyComments: React.FC<IVeltCommentsProps>;
export default SnippylyComments;