matrix-react-sdk/lib/src/utils/FileDownloader.d.ts

SDK for matrix.org using React

export type GetIframeFn = () => HTMLIFrameElement | null;
export declare const DEFAULT_STYLES: {
    imgSrc: string;
    imgStyle: string | null;
    style: string;
    textContent: string;
};
type DownloadOptions = {
    blob: Blob;
    name: string;
    autoDownload?: boolean;
    opts?: typeof DEFAULT_STYLES;
};
/**
 * Helper to handle safe file downloads. This operates off an iframe for reasons described
 * by the blob helpers. By default, this will use a hidden iframe to manage the download
 * through a user content wrapper, but can be given an iframe reference if the caller needs
 * additional control over the styling/position of the iframe itself.
 */
export declare class FileDownloader {
    private iframeFn?;
    private onLoadPromise?;
    /**
     * Creates a new file downloader
     * @param iframeFn Function to get a pre-configured iframe. Set to null to have the downloader
     * use a generic, hidden, iframe.
     */
    constructor(iframeFn?: GetIframeFn | undefined);
    private get iframe();
    download({ blob, name, autoDownload, opts }: DownloadOptions): Promise<void>;
}
export {};