@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.
86 lines (85 loc) • 2.37 kB
TypeScript
import React from 'react';
declare class FilterTypeConfig {
name?: string;
enable?: boolean;
multiSelection?: boolean;
enableGrouping?: boolean;
order?: string[];
}
declare class CommentSidebarFilterConfig {
location?: FilterTypeConfig;
people?: FilterTypeConfig;
tagged?: FilterTypeConfig;
assigned?: FilterTypeConfig;
priority?: FilterTypeConfig;
category?: FilterTypeConfig;
commentType?: FilterTypeConfig;
status?: FilterTypeConfig;
}
declare class CommentSidebarGroupConfig {
enable?: boolean;
name?: string;
}
declare class CommentSidebarFilters {
location?: Location[];
people?: {
userId?: string;
email?: string;
}[];
tagged?: {
userId?: string;
email?: string;
}[];
assigned?: {
userId?: string;
email?: string;
}[];
priority?: string[];
status?: string[];
category?: string[];
}
export interface IVeltCommentsSidebarProps {
embedMode?: boolean;
floatingMode?: boolean;
/**
* @deprecated Use `urlNavigation` instead
*/
enableUrlNavigation?: boolean;
urlNavigation?: boolean;
queryParamsComments?: boolean;
pageMode?: boolean;
currentLocationSuffix?: boolean;
variant?: string;
pageModeComposerVariant?: string;
dialogVariant?: string;
shadowDom?: boolean;
sortData?: 'asc' | 'desc' | 'none';
filterConfig?: CommentSidebarFilterConfig;
groupConfig?: CommentSidebarGroupConfig;
filters?: CommentSidebarFilters;
excludeLocationIds?: string[];
/**
* @deprecated Use `onSidebarOpen` instead
*/
openSidebar?: Function;
onSidebarOpen?: Function;
/**
* @deprecated Use `onCommentClick` instead
*/
onSidebarCommentClick?: Function;
onCommentClick?: Function;
onSidebarClose?: Function;
onCommentNavigationButtonClick?: Function;
darkMode?: boolean;
position?: "right" | "left";
filterPanelLayout?: 'menu' | 'bottomSheet';
customActions?: boolean;
focusedThreadDialogVariant?: string;
focusedThreadMode?: boolean;
searchPlaceholder?: string;
filterOptionLayout?: 'checkbox' | 'dropdown';
filterCount?: boolean;
fullExpanded?: boolean;
}
declare const SnippylyCommentsSidebar: React.FC<IVeltCommentsSidebarProps>;
export default SnippylyCommentsSidebar;