@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.
63 lines (62 loc) • 2.03 kB
TypeScript
import { ContextOptions } from '@veltdev/types';
import React from 'react';
export interface IVeltInlineCommentsSectionProps extends React.DetailedHTMLProps<React.HTMLAttributes<HTMLElement>, HTMLElement> {
config?: {
id: string;
name?: string;
};
/**
* @deprecated Use `targetElementId` instead.
*/
targetInlineCommentElementId?: string;
/**
* @deprecated Use `targetElementId` instead.
*/
targetCommentElementId?: string;
targetElementId?: string;
darkMode?: boolean;
variant?: string;
dialogVariant?: string;
composerVariant?: string;
shadowDom?: boolean;
multiThread?: boolean;
/**
* @deprecated Use `sortBy` and `sortOrder` instead.
*/
sortData?: 'asc' | 'desc' | 'none';
composerPosition?: 'top' | 'bottom';
sortBy?: 'createdAt' | 'lastUpdated';
sortOrder?: 'asc' | 'desc';
fullExpanded?: boolean;
context?: {
[key: string]: any;
};
contextOptions?: ContextOptions;
locationId?: string;
documentId?: string;
folderId?: string;
commentPlaceholder?: string;
replyPlaceholder?: string;
composerPlaceholder?: string;
editPlaceholder?: string;
editCommentPlaceholder?: string;
editReplyPlaceholder?: string;
readOnly?: boolean;
/**
* Per-section override for anonymous email mentions. When set, overrides the global
* comment setting for this inline section only.
*/
anonymousEmail?: boolean;
/**
* When enabled, long comment messages are visually truncated to a fixed number of lines
* with Show more / Show less controls. Off by default.
*/
messageTruncation?: boolean;
/**
* Number of lines to show before truncating a comment message. Defaults to 4.
* Only takes effect when `messageTruncation` is enabled.
*/
messageTruncationLines?: number;
}
declare const VeltInlineCommentsSection: React.FC<IVeltInlineCommentsSectionProps>;
export default VeltInlineCommentsSection;