@veltdev/types
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.
60 lines (59 loc) • 1.61 kB
TypeScript
import { IDeviceInfo } from "./device-info.model";
export declare class PageInfo {
/**
* URL of the webpage
*/
url?: string;
/**
* Path of the webpage excluding base url
*/
path?: string;
/**
* Query parameters of the webpage
*/
queryParams?: string;
/**
* Base URL (domain) of a webpage
*/
baseUrl?: string;
/**
* Title of the webpage
*/
title?: string;
/**
* Reference url of a arrow annotation
*/
arrowUrl?: string;
/**
* Reference url of a area annotation
*/
areaUrl?: string;
/**
* Reference url of a comment annotation
*/
commentUrl?: string;
/**
* Reference url of a tag annotation
*/
tagUrl?: string;
/**
* Reference url of a recorder annotation
*/
recorderUrl?: string;
/**
* User’s screen width.
*
* Auto generated.
*/
screenWidth?: number;
deviceInfo?: IDeviceInfo;
/**
* @param applyClientOverride when true (default), merges the CURRENT document's client page
* info override at construction time — covers the bare `new PageInfo()` sites
* (cursor / presence / selection). No-op when the client hasn't provided any, so the
* default empty-page-info behavior is unchanged. `getPageInfo(documentId)` passes
* `false` so it can apply a specific document's override itself, without the current
* document's fields leaking onto a different document's page info.
*/
constructor(applyClientOverride?: boolean);
}