@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.
26 lines (25 loc) • 1.3 kB
TypeScript
import { Location, User, Options, DocumentMetadata, Document, SetDocumentsRequestOptions, SetLocationsRequestOptions } from "@veltdev/types";
export declare function useClient(): any;
export declare function useIdentify(user: User, userOptions?: Options): void;
export declare function useSetDocument(documentId: string, documentMetadata?: DocumentMetadata): void;
export declare function useSetDocumentId(documentId: string): void;
export declare function useSetDocuments(): {
setDocuments: (documents: Document[], options?: SetDocumentsRequestOptions) => void;
};
export declare function useSetRootDocument(): {
setRootDocument: (document: Document) => void;
};
export declare function useUnsetDocumentId(): void;
export declare function useUnsetDocuments(): void;
export declare function useSetLocation(location: Location, appendLocation?: boolean): void;
export declare function useSetLocations(): {
setLocations: (locations: Location[], options?: SetLocationsRequestOptions) => void;
};
export declare function useSetRootLocation(): {
setRootLocation: (location: Location) => void;
};
export declare function useVeltInitState(): boolean | undefined;
export declare function useUiState<T extends object = object>(): {
uiState: T | undefined;
setUiState: (data: T) => void;
};