@progress/kendo-react-pdf 7.2.4-develop.3 → 7.2.4-develop.4

package/grid/provideSaveGridPDF.mjs

@@ -0,0 +1,53 @@
+/**
+ * @license
+ *-------------------------------------------------------------------------------------------
+ * Copyright © 2024 Progress Software Corporation. All rights reserved.
+ * Licensed under commercial license. See LICENSE.md in the package root for more information
+ *-------------------------------------------------------------------------------------------
+ */
+"use client";
+import * as E from "react-dom";
+import * as a from "react";
+import { exportElement as b } from "./export-element.mjs";
+function F(o) {
+  return (e, c = {}, p, t, i) => x(
+    o,
+    e,
+    c,
+    p,
+    t,
+    i
+  );
+}
+function x(o, e, c = {}, p, t, i) {
+  let n, d, r;
+  u();
+  function u() {
+    n = document.createElement("div"), n.setAttribute("style", "position:absolute; left: -5000px; top: 0px;"), d = document.createElement("div"), n.appendChild(d), document.body.appendChild(n), E.render(h(), d, m);
+  }
+  function m() {
+    o(C(), c, f);
+  }
+  function f() {
+    document.body.removeChild(n), document.body.removeChild(r), n = r = void 0, p && p();
+  }
+  function C() {
+    r = document.createElement("div"), r.className = "k-grid-pdf-export-element";
+    const l = b(d);
+    return r.appendChild(l), document.body.appendChild(r), l;
+  }
+  function h() {
+    const l = t && { data: t, total: t.length, pageSize: t.length, skip: 0 }, y = { style: Object.assign({}, e.props.style, { width: "1000px" }) }, s = Object.assign({}, l, y);
+    if (i && i.length > 0) {
+      const v = g(e);
+      return a.cloneElement(e, s, i.concat(v));
+    } else
+      return a.cloneElement(e, s);
+  }
+}
+function g(o) {
+  return a.Children.toArray(o.props.children).filter((e) => e && e.type && e.type.displayName !== "KendoReactGridColumn");
+}
+export {
+  F as provideSaveGridPDF
+};

package/index.d.mts

@@ -1,5 +1,439 @@
-/**-----------------------------------------------------------------------------------------
-* Copyright © 2024 Progress Software Corporation. All rights reserved.
-* Licensed under commercial license. See LICENSE.md in the package root for more information
-*-------------------------------------------------------------------------------------------*/
-export * from './index';
+/**
+ * @license
+ *-------------------------------------------------------------------------------------------
+ * Copyright © 2024 Progress Software Corporation. All rights reserved.
+ * Licensed under commercial license. See LICENSE.md in the package root for more information
+ *-------------------------------------------------------------------------------------------
+ */
+import { DrawOptions } from '@progress/kendo-drawing';
+import { Group } from '@progress/kendo-drawing';
+import { JSX as JSX_2 } from 'react/jsx-runtime';
+import { PageMargin } from '@progress/kendo-drawing/pdf';
+import { PaperSize } from '@progress/kendo-drawing/pdf';
+import { PDFOptions } from '@progress/kendo-drawing/pdf';
+import PropTypes from 'prop-types';
+import * as React_2 from 'react';
+import { SaveOptions } from '@progress/kendo-file-saver';
+
+/**
+ * @hidden
+ * Returns the margin options by reading the props of he component and the `PDFMargin` child.
+ * The props of the `PDFMargin` child are with greater priority.
+ */
+export declare function getPageMargin(props: any): any;
+
+/**
+ * A React component which facilitates the PDF export of the Grid.
+ */
+export declare class GridPDFExport extends React_2.Component<GridPDFExportProps, {}> {
+    /**
+     * @hidden
+     */
+    static propTypes: {
+        author: PropTypes.Requireable<string>;
+        avoidLinks: PropTypes.Requireable<NonNullable<string | boolean | null | undefined>>;
+        forcePageBreak: PropTypes.Requireable<string>;
+        keepTogether: PropTypes.Requireable<string>;
+        creator: PropTypes.Requireable<string>;
+        date: PropTypes.Requireable<Date>;
+        imageResolution: PropTypes.Requireable<number>;
+        fileName: PropTypes.Requireable<string>;
+        forceProxy: PropTypes.Requireable<boolean>;
+        keywords: PropTypes.Requireable<string>;
+        landscape: PropTypes.Requireable<boolean>;
+        margin: PropTypes.Requireable<NonNullable<string | number | PropTypes.InferProps<{
+            left: PropTypes.Requireable<NonNullable<string | number | null | undefined>>;
+            top: PropTypes.Requireable<NonNullable<string | number | null | undefined>>;
+            right: PropTypes.Requireable<NonNullable<string | number | null | undefined>>;
+            bottom: PropTypes.Requireable<NonNullable<string | number | null | undefined>>;
+        }> | null | undefined>>;
+        pageTemplate: PropTypes.Requireable<any>;
+        paperSize: PropTypes.Requireable<any>;
+        repeatHeaders: PropTypes.Requireable<boolean>;
+        scale: PropTypes.Requireable<number>;
+        proxyData: PropTypes.Requireable<any>;
+        proxyURL: PropTypes.Requireable<string>;
+        proxyTarget: PropTypes.Requireable<string>;
+        producer: PropTypes.Requireable<string>;
+        subject: PropTypes.Requireable<string>;
+        title: PropTypes.Requireable<string>;
+    };
+    /**
+     * @hidden
+     */
+    saveGridPDF: any;
+    constructor(props: any);
+    /**
+     * @hidden
+     */
+    render(): null;
+    /**
+     * Saves the content of the Grid as a PDF file.
+     *
+     * @param data - The data can be different from the currently displayed data in the Grid. Can be used to export all Grid pages.
+     * @param callback - The callback that will be executed after the PDF is saved.
+     */
+    save(data?: any[], callback?: () => void): void;
+    protected getSavePDF(): typeof savePDF;
+    private getGrid;
+    private getCustomColumns;
+}
+
+/**
+ * The props of the GridPDFExport component
+ * ([more information and examples in the documentation on PDF export]({% slug overview_pdfexport_grid %})).
+ */
+export declare interface GridPDFExportProps extends PDFExportProps {
+}
+
+/**
+ * @hidden
+ */
+export declare class KendoDrawingAdapter {
+    private drawDOM;
+    private exportPDF;
+    private saveAs;
+    private domElement;
+    private options;
+    constructor(drawDOM: (element: HTMLElement, options: DrawOptions) => Promise<Group>, exportPDF: (group: Group, options: PDFOptions) => Promise<string>, saveAs: (dataUri: string, fileName: string, options: SaveOptions) => void, domElement: HTMLElement, options?: PDFExportProps);
+    savePDF(callback?: () => void): void;
+    private getDrawOptions;
+    private getPDFOptions;
+    private getSaveOptions;
+    private convertPageTemplateToHtml;
+}
+
+/**
+ * Represents the props of a page template component that can be added to the PDFExport component.
+ */
+export declare interface PageTemplateProps {
+    /**
+     * The number of the current page.
+     */
+    pageNum: number;
+    /**
+     * The total number of pages.
+     */
+    totalPages: number;
+}
+
+/**
+ * Represents the KendoReact PDFExport component.
+ */
+export declare class PDFExport extends React_2.Component<PDFExportProps, {}> {
+    /**
+     * @hidden
+     */
+    static propTypes: {
+        author: PropTypes.Requireable<string>;
+        avoidLinks: PropTypes.Requireable<NonNullable<string | boolean | null | undefined>>;
+        forcePageBreak: PropTypes.Requireable<string>;
+        keepTogether: PropTypes.Requireable<string>;
+        creator: PropTypes.Requireable<string>;
+        date: PropTypes.Requireable<Date>;
+        imageResolution: PropTypes.Requireable<number>;
+        fileName: PropTypes.Requireable<string>;
+        forceProxy: PropTypes.Requireable<boolean>;
+        keywords: PropTypes.Requireable<string>;
+        landscape: PropTypes.Requireable<boolean>;
+        margin: PropTypes.Requireable<NonNullable<string | number | PropTypes.InferProps<{
+            left: PropTypes.Requireable<NonNullable<string | number | null | undefined>>;
+            top: PropTypes.Requireable<NonNullable<string | number | null | undefined>>;
+            right: PropTypes.Requireable<NonNullable<string | number | null | undefined>>;
+            bottom: PropTypes.Requireable<NonNullable<string | number | null | undefined>>;
+        }> | null | undefined>>;
+        pageTemplate: PropTypes.Requireable<any>;
+        paperSize: PropTypes.Requireable<any>;
+        repeatHeaders: PropTypes.Requireable<boolean>;
+        scale: PropTypes.Requireable<number>;
+        proxyData: PropTypes.Requireable<any>;
+        proxyURL: PropTypes.Requireable<string>;
+        proxyTarget: PropTypes.Requireable<string>;
+        producer: PropTypes.Requireable<string>;
+        subject: PropTypes.Requireable<string>;
+        title: PropTypes.Requireable<string>;
+    };
+    private rootElForPDF;
+    constructor(props: PDFExportProps);
+    /**
+     * @hidden
+     */
+    render(): JSX_2.Element;
+    /**
+     * Saves the content as a PDF file.
+     *
+     * @param callback - The callback to be executed after the PDF is saved.
+     */
+    save(callback?: () => void): void;
+    private getOptions;
+}
+
+/**
+ * Represents the props of the KendoReact PDFExport component.
+ */
+export declare interface PDFExportProps {
+    /**
+     * @hidden
+     */
+    children?: React.ReactNode;
+    /**
+     * The author (metadata) of the PDF document.
+     */
+    author?: string;
+    /**
+     * A flag that indicates whether to produce actual hyperlinks in the exported PDF file. It is also possible to set a CSS selector. All matching links will be ignored.
+     */
+    avoidLinks?: boolean | string;
+    /**
+     * An optional CSS selector that specifies the elements which cause the page breaks.
+     */
+    forcePageBreak?: string;
+    /**
+     * An optional CSS selector that specifies the elements which should not be split across the pages.
+     */
+    keepTogether?: string;
+    /**
+     * The creator of the PDF document. Defaults to `KendoReact PDF Generator`.
+     */
+    creator?: string;
+    /**
+     * The date when the PDF document is created. Defaults to `new Date()`.
+     */
+    date?: Date;
+    /**
+     * The forced resolution of the images in the exported PDF document. By default, the images are exported at their full resolution.
+     */
+    imageResolution?: number;
+    /**
+     * Specifies the name of the exported PDF file. Defaults to `export.pdf`.
+     */
+    fileName?: string;
+    /**
+     * If set to `true`, the content is forwarded to `proxyURL` even if the browser supports local saving of files.
+     */
+    forceProxy?: boolean;
+    /**
+     * The keywords (metadata) of the PDF document.
+     */
+    keywords?: string;
+    /**
+     * A flag that indicates if the page will be in a landscape orientation. By default, the page is in a portrait orientation. Defaults to `false`.
+     */
+    landscape?: boolean;
+    /**
+     * Specifies the margins of the page.
+     *
+     * The supported units are:
+     * * `"mm"`
+     * * `"cm"`
+     * * `"in"`
+     * * `"pt"` (default).
+     *
+     * > Numbers are considered to be points (`"pt"`).
+     */
+    margin?: string | number | PageMargin;
+    /**
+     * A React functional or class component which is used as a template that is inserted into each page of the PDF document. The number of the current page (`pageNum`) and the total number of pages (`totalPages`) are passed to the component as properties.
+     */
+    pageTemplate?: any;
+    /**
+     * Specifies the paper size of the PDF document. Defaults to `"auto"` which means that the paper size is determined by the content. The size of the content in pixels matches the size of the output in points (1 pixel = 1/72 inch).
+     *
+     * If set, the content will be split across multiple pages. This enables the `repeatHeaders` and `scale` options, and allows you to specify a template.
+     *
+     * The supported values are:
+     * * A predefined size. The supported paper sizes are: `A0-A10`, `B0-B10`, `C0-C10`, `Executive`, `Folio`, `Legal`, `Letter`, `Tabloid`.
+     * * An array of two numbers which specify the width and height in points (1pt = 1/72in).
+     * * An array of two strings which specify the width and height in units. The supported units are `"mm"`, `"cm"`, `"in"`, and `"pt"`.
+     */
+    paperSize?: PaperSize;
+    /**
+     * Specifies if the `<thead>` elements of the tables will be repeated on each page.
+     */
+    repeatHeaders?: boolean;
+    /**
+     * A scale factor. The text size on the screen might be too big for printing. To scale down the output in PDF, use this option. Defaults to `1`.
+     */
+    scale?: number;
+    /**
+     * A key/value dictionary of form values which will be sent to the proxy. Can be used to submit Anti-Forgery tokens and other metadata.
+     */
+    proxyData?: {
+        [key: string]: string;
+    };
+    /**
+     * The URL of the server-side proxy which streams the file to the end user. You need to use a proxy if the browser is not capable of saving files locally&mdash;for example, Internet Explorer 9 and Safari. It is your responsibility to implement the server-side proxy.
+     *
+     * In the request body, the proxy receives a `POST` request with the following parameters:
+     * - `"contentType"`&mdash;The MIME type of the file.
+     * - `"base64"`&mdash;The base-64 encoded file content.
+     * - `"fileName"`&mdash;The file name, as requested by the caller.
+     *
+     * The proxy returns the decoded file with the `"Content-Disposition"` header set to `attachment;
+     * filename="<fileName.pdf>"`.
+     */
+    proxyURL?: string;
+    /**
+     * A name or keyword which indicates where to display the document that is returned from the proxy. To display the document in a new window or iframe, the proxy has to have the `"Content-Disposition"` header set to `inline; filename="<fileName.pdf>"`. Defaults to `_self`.
+     */
+    proxyTarget?: string;
+    /**
+     * The producer (metadata) of the PDF document.
+     */
+    producer?: string;
+    /**
+     * The subject (metadata) of the PDF document.
+     */
+    subject?: string;
+    /**
+     * The title (metadata) of the PDF document.
+     */
+    title?: string;
+}
+
+/**
+ * @hidden
+ */
+export declare class PDFMargin extends React_2.Component<PDFMarginProps, {}> {
+    static propTypes: {
+        left: PropTypes.Requireable<NonNullable<string | number | null | undefined>>;
+        top: PropTypes.Requireable<NonNullable<string | number | null | undefined>>;
+        right: PropTypes.Requireable<NonNullable<string | number | null | undefined>>;
+        bottom: PropTypes.Requireable<NonNullable<string | number | null | undefined>>;
+    };
+    render(): null;
+}
+
+/**
+ * Represents the props of the KendoReact PDFMargin component.
+ */
+export declare interface PDFMarginProps {
+    /**
+     * The bottom margin.
+     *
+     * The supported units are:
+     * * `"mm"`
+     * * `"cm"`
+     * * `"in"`
+     * * `"pt"` (default).
+     *
+     * > Numbers are considered to be points (`"pt"`).
+     */
+    left?: number | string;
+    /**
+     * The top margin.
+     *
+     * The supported units are:
+     * * `"mm"`
+     * * `"cm"`
+     * * `"in"`
+     * * `"pt"` (default).
+     *
+     * > Numbers are considered to be points (`"pt"`).
+     */
+    top?: number | string;
+    /**
+     * The right margin.
+     *
+     * The supported units are:
+     * * `"mm"`
+     * * `"cm"`
+     * * `"in"`
+     * * `"pt"` (default).
+     *
+     * > Numbers are considered to be points (`"pt"`).
+     */
+    right?: number | string;
+    /**
+     * The bottom margin.
+     *
+     * The supported units are:
+     * * `"mm"`
+     * * `"cm"`
+     * * `"in"`
+     * * `"pt"` (default).
+     *
+     * > Numbers are considered to be points (`"pt"`).
+     */
+    bottom?: number | string;
+}
+
+/**
+ * Saves the content of a DOM element to a PDF file.
+ *
+ * @param domElement - The root DOM element to save to a PDF file.
+ * @param options - The export options.
+ * @param callback - The callback to be executed after the PDF is saved.
+ */
+export declare function savePDF(domElement: HTMLElement, options?: PDFExportProps, callback?: () => void): void;
+
+/**
+ * A React component which facilitates the PDF export of the TreeList.
+ */
+export declare class TreeListPDFExport extends React_2.Component<TreeListPDFExportProps, {}> {
+    /**
+     * @hidden
+     */
+    static propTypes: {
+        author: PropTypes.Requireable<string>;
+        avoidLinks: PropTypes.Requireable<NonNullable<string | boolean | null | undefined>>;
+        forcePageBreak: PropTypes.Requireable<string>;
+        keepTogether: PropTypes.Requireable<string>;
+        creator: PropTypes.Requireable<string>;
+        date: PropTypes.Requireable<Date>;
+        imageResolution: PropTypes.Requireable<number>;
+        fileName: PropTypes.Requireable<string>;
+        forceProxy: PropTypes.Requireable<boolean>;
+        keywords: PropTypes.Requireable<string>;
+        landscape: PropTypes.Requireable<boolean>;
+        margin: PropTypes.Requireable<NonNullable<string | number | PropTypes.InferProps<{
+            left: PropTypes.Requireable<NonNullable<string | number | null | undefined>>;
+            top: PropTypes.Requireable<NonNullable<string | number | null | undefined>>;
+            right: PropTypes.Requireable<NonNullable<string | number | null | undefined>>;
+            bottom: PropTypes.Requireable<NonNullable<string | number | null | undefined>>;
+        }> | null | undefined>>;
+        pageTemplate: PropTypes.Requireable<any>;
+        paperSize: PropTypes.Requireable<any>;
+        repeatHeaders: PropTypes.Requireable<boolean>;
+        scale: PropTypes.Requireable<number>;
+        proxyData: PropTypes.Requireable<any>;
+        proxyURL: PropTypes.Requireable<string>;
+        proxyTarget: PropTypes.Requireable<string>;
+        producer: PropTypes.Requireable<string>;
+        subject: PropTypes.Requireable<string>;
+        title: PropTypes.Requireable<string>;
+        allPages: PropTypes.Requireable<boolean>;
+    };
+    /**
+     * @hidden
+     */
+    saveTreeListPDF: any;
+    constructor(props: any);
+    /**
+     * @hidden
+     */
+    render(): null;
+    /**
+     * Saves the content of the TreeList as a PDF file.
+     *
+     * @param data - The data that will be exported to the PDF. The data can be different from the currently displayed data in the TreeList.
+     * @param columns - The columns that will be exported to the PDF. The columns collection can be different from the currently displayed in the TreeList.
+     * @param callback - The callback that will be executed after the PDF is saved.
+     */
+    save(data?: any[], columns?: any[], callback?: () => void): void;
+    protected getSavePDF(): typeof savePDF;
+    private getTreeList;
+}
+
+/**
+ * The props of the TreeListPDFExport component
+ * ([more information and examples in the documentation on PDF export]({% slug overview_pdfexport_treelist %})).
+ */
+export declare interface TreeListPDFExportProps extends PDFExportProps {
+    /**
+     * If set to true it will export all pages of the TreeList data. By default allPages is set to `false`.
+     */
+    allPages?: boolean;
+}
+
+export { }