@progress/kendo-react-pdf-viewer 7.2.4-develop.3 → 7.3.0-develop.1

package/PDFViewer.d.ts

@@ -1,211 +0,0 @@
-/**-----------------------------------------------------------------------------------------
-* Copyright © 2024 Progress Software Corporation. All rights reserved.
-* Licensed under commercial license. See LICENSE.md in the package root for more information
-*-------------------------------------------------------------------------------------------*/
-import * as React from 'react';
-import { ToolbarProps } from '@progress/kendo-react-buttons';
-import { SaveOptions } from '@progress/kendo-file-saver';
-import { TypedArray } from '@progress/kendo-pdfviewer-common';
-export type PDFViewerTool = 'pager' | 'spacer' | 'zoomInOut' | 'zoom' | 'selection' | 'search' | 'open' | 'download' | 'print';
-interface PDFViewerEvent {
-    /**
-     * The event target object.
-     */
-    target: PDFViewerHandle;
-}
-/**
- * The KendoReact [PDFViewer]({% slug api_pdf-viewer_pdfviewer %}) ErrorEvent object.
- */
-export interface ErrorEvent extends PDFViewerEvent {
-    /**
-     * The raised error.
-     */
-    error: Error | {
-        message: string;
-    };
-}
-/**
- * The KendoReact [PDFViewer]({% slug api_pdf-viewer_pdfviewer %}) DownloadEvent object.
- */
-export interface DownloadEvent extends PDFViewerEvent {
-    /**
-     * The Blob object.
-     */
-    blob: Blob;
-    /**
-     * The name which will be used for saving the file.
-     */
-    fileName: string;
-    /**
-     * The options which will be used for saving the file.
-     */
-    saveOptions: SaveOptions;
-}
-/**
- * The KendoReact [PDFViewer]({% slug api_pdf-viewer_pdfviewer %}) LoadEvent object.
- */
-export interface LoadEvent extends PDFViewerEvent {
-}
-/**
- * The KendoReact [PDFViewer]({% slug api_pdf-viewer_pdfviewer %}) ZoomEvent object.
- */
-export interface ZoomEvent extends PDFViewerEvent {
-    /**
-     * The zoom value.
-     */
-    zoom: number;
-    /**
-     * A React `SyntheticEvent`.
-     */
-    syntheticEvent: React.SyntheticEvent<any>;
-}
-/**
- * The KendoReact [PDFViewer]({% slug api_pdf-viewer_pdfviewer %}) PageEvent object.
- */
-export interface PageEvent extends PDFViewerEvent {
-    /**
-     * The page number.
-     */
-    page: number;
-    /**
-     * A React `SyntheticEvent`.
-     */
-    syntheticEvent: React.SyntheticEvent<any>;
-}
-/**
- * The props of the KendoReact [PDFViewer]({% slug api_pdf-viewer_pdfviewer %}) component.
- */
-export interface PDFViewerProps {
-    /**
-     * Represents the url of the PDF file.
-     */
-    url?: string;
-    /**
-     * Represents the data of the PDF file in Base64 format.
-     */
-    data?: string;
-    /**
-     * Represents the raw binary data buffer of the PDF file.
-     */
-    arrayBuffer?: ArrayBuffer;
-    /**
-     * Represents the data of the PDF file in typed array format.
-     */
-    typedArray?: TypedArray;
-    /**
-     * Represents the additional styles which will be added to the PDFViewer component.
-     */
-    style?: React.CSSProperties;
-    /**
-     * Represents the file name used to save the file when the user clicks the download tool.
-     */
-    saveFileName?: string;
-    /**
-     * Represents the options for saving the file when the user clicks the download tool.
-     */
-    saveOptions?: SaveOptions;
-    /**
-     * Represents the tools collection rendered in the toolbar.
-     *
-     * @default - ['pager', 'spacer', 'zoomInOut', 'zoom', 'selection', 'spacer', 'search', 'open', 'download', 'print']
-     */
-    tools?: PDFViewerTool[];
-    /**
-     * Represents the zoom levels populated in the ComboBox component.
-     */
-    zoomLevels?: {
-        id: number;
-        priority: number;
-        value: number;
-        text: string;
-        type: string;
-        locationString?: string;
-    }[];
-    /**
-     * Represents the zoom value of the document.
-     */
-    zoom?: number;
-    /**
-     * Represents the default zoom value.
-     */
-    defaultZoom?: number;
-    /**
-     * Represents the minimum zoom value.
-     */
-    minZoom?: number;
-    /**
-     * Represents the maximum zoom value.
-     */
-    maxZoom?: number;
-    /**
-     * Represents the zoom rate value.
-     */
-    zoomRate?: number;
-    /**
-     * Fires when an error occurs.
-     */
-    onError?: (event: ErrorEvent) => void;
-    /**
-     * Fires when a PDF document has been loaded.
-     */
-    onLoad?: (event: LoadEvent) => void;
-    /**
-     * Fires when the download tool has been clicked. To prevent the download, return `false`.
-     */
-    onDownload?: (event: DownloadEvent) => boolean | void;
-    /**
-     * Fires when the zoom has changed.
-     */
-    onZoom?: (event: ZoomEvent) => void;
-    /**
-     * Fires when the page has changed.
-     */
-    onPageChange?: (event: PageEvent) => void;
-    /**
-     * Fires when the toolbar component is about to be rendered. Use it to override the default appearance of the toolbar.
-     */
-    onRenderToolbar?: (defaultRendering: React.ReactElement<ToolbarProps>) => React.ReactNode;
-    /**
-     * Fires when the content component is about to be rendered. Use it to override the default appearance of the content.
-     */
-    onRenderContent?: (defaultRendering: React.ReactElement<HTMLDivElement>) => React.ReactNode;
-    /**
-     * Fires when the loading indication component is about to be rendered. Use it to override the default appearance of the loading.
-     */
-    onRenderLoader?: (defaultRendering: React.ReactElement<HTMLDivElement> | null) => React.ReactNode;
-}
-/**
- * Represents the object which is passed to the [`ref`](https://reactjs.org/docs/refs-and-the-dom.html)
- * callback of the [PDFViewer]({% slug api_pdf-viewer_pdfviewer %}) component.
- */
-export interface PDFViewerHandle {
-    /**
-     * The root DOM element of the PDFViewer component.
-     */
-    element: HTMLDivElement | null;
-    /**
-     * The props of the PDFViewer component.
-     */
-    props: PDFViewerProps;
-    /**
-     * The `PDF.js` document loaded in the PDFViewer component.
-     */
-    document: any;
-    /**
-     * The `PDF.js` pages loaded in the PDFViewer component.
-     */
-    pages: any[];
-}
-/**
- * Represents the [KendoReact PDFViewer component]({% slug api_pdf-viewer_pdfviewerprops %}).
- *
- * @example
- * ```jsx
- * function App() {
- *  return <PDFViewer url="sample.pdf" />;
- * }
- *  ReactDOM.render(<App />, document.querySelector('my-app'));
- * ```
- */
-export declare const PDFViewer: React.ForwardRefExoticComponent<PDFViewerProps & React.RefAttributes<PDFViewerHandle | null>>;
-export {};

package/messages.d.ts

@@ -1,94 +0,0 @@
-/**-----------------------------------------------------------------------------------------
-* Copyright © 2024 Progress Software Corporation. All rights reserved.
-* Licensed under commercial license. See LICENSE.md in the package root for more information
-*-------------------------------------------------------------------------------------------*/
-/**
- * @hidden
- */
-export declare const zoomIn = "pdfviewer.zoomIn";
-/**
- * @hidden
- */
-export declare const zoomOut = "pdfviewer.zoomOut";
-/**
- * @hidden
- */
-export declare const zoomLevel = "pdfviewer.zoomLevel";
-/**
- * @hidden
- */
-export declare const enableSelection = "pdfviewer.enableSelection";
-/**
- * @hidden
- */
-export declare const enablePanning = "pdfviewer.enablePanning";
-/**
- * @hidden
- */
-export declare const search = "pdfviewer.search";
-/**
- * @hidden
- */
-export declare const open = "pdfviewer.open";
-/**
- * @hidden
- */
-export declare const download = "pdfviewer.download";
-/**
- * @hidden
- */
-export declare const print = "pdfviewer.print";
-/**
- * @hidden
- */
-export declare const close = "pdfviewer.close";
-/**
- * @hidden
- */
-export declare const matchCase = "pdfviewer.matchCase";
-/**
- * @hidden
- */
-export declare const prevMatch = "pdfviewer.prevMatch";
-/**
- * @hidden
- */
-export declare const nextMatch = "pdfviewer.nextMatch";
-/**
- * @hidden
- */
-export declare const actualWidth = "pdfviewer.actualWidth";
-/**
- * @hidden
- */
-export declare const fitToWidth = "pdfviewer.fitToWidth";
-/**
- * @hidden
- */
-export declare const fitToPage = "pdfviewer.fitToPage";
-/**
- * @hidden
- */
-export declare const popupBlocked = "pdfviewer.popupBlocked";
-/**
- * @hidden
- */
-export declare const messages: {
-    "pdfviewer.zoomIn": string;
-    "pdfviewer.zoomOut": string;
-    "pdfviewer.zoomLevel": string;
-    "pdfviewer.enableSelection": string;
-    "pdfviewer.enablePanning": string;
-    "pdfviewer.search": string;
-    "pdfviewer.open": string;
-    "pdfviewer.download": string;
-    "pdfviewer.print": string;
-    "pdfviewer.close": string;
-    "pdfviewer.matchCase": string;
-    "pdfviewer.prevMatch": string;
-    "pdfviewer.nextMatch": string;
-    "pdfviewer.actualWidth": string;
-    "pdfviewer.fitToWidth": string;
-    "pdfviewer.fitToPage": string;
-    "pdfviewer.popupBlocked": string;
-};

package/package-metadata.d.ts

@@ -1,9 +0,0 @@
-/**-----------------------------------------------------------------------------------------
-* Copyright © 2024 Progress Software Corporation. All rights reserved.
-* Licensed under commercial license. See LICENSE.md in the package root for more information
-*-------------------------------------------------------------------------------------------*/
-import { PackageMetadata } from '@progress/kendo-licensing';
-/**
- * @hidden
- */
-export declare const packageMetadata: PackageMetadata;