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

package/index.d.ts

@@ -1,15 +1,413 @@
-/**-----------------------------------------------------------------------------------------
-* Copyright © 2024 Progress Software Corporation. All rights reserved.
-* Licensed under commercial license. See LICENSE.md in the package root for more information
-*-------------------------------------------------------------------------------------------*/
-import { ExcelExport, type ExcelExportProps, type ExcelExportExportEvent } from './ExcelExport';
-import type { ExcelExportData } from './ExcelExportData';
-import { ExcelExportColumn, type ExcelExportColumnProps } from './ExcelExportColumn';
-import { ExcelExportColumnGroup, type ExcelExportColumnGroupProps } from './ExcelExportColumnGroup';
-import type { ColumnBase } from './ColumnBase';
-import { ExcelExportFooter, type ExcelExportFooterProps } from './templates/ExcelExportFooter';
-import { ExcelExportGroupFooter, type ExcelExportGroupFooterProps } from './templates/ExcelExportGroupFooter';
-import { ExcelExportGroupHeader, type ExcelExportGroupHeaderProps } from './templates/ExcelExportGroupHeader';
-import * as KendoOoxml from '@progress/kendo-ooxml';
-export { ExcelExport, ExcelExportData, ExcelExportProps, ExcelExportExportEvent, ExcelExportColumnGroup, ExcelExportColumnGroupProps, ExcelExportFooter, ExcelExportFooterProps, ExcelExportColumn, ExcelExportColumnProps, ColumnBase, ExcelExportGroupFooter, ExcelExportGroupFooterProps, ExcelExportGroupHeader, ExcelExportGroupHeaderProps, KendoOoxml };
-export * from './ooxml/workbook';
+/**
+ * @license
+ *-------------------------------------------------------------------------------------------
+ * Copyright © 2024 Progress Software Corporation. All rights reserved.
+ * Licensed under commercial license. See LICENSE.md in the package root for more information
+ *-------------------------------------------------------------------------------------------
+ */
+import { AggregateResult } from '@progress/kendo-data-query';
+import { GroupResult } from '@progress/kendo-data-query';
+import * as KendoOoxml from '@progress/kendo-ooxml';
+import PropTypes from 'prop-types';
+import * as React_2 from 'react';
+import { WorkbookOptions } from '@progress/kendo-ooxml';
+import { WorkbookSheetRowCellBorderBottom } from '@progress/kendo-ooxml';
+import { WorkbookSheetRowCellBorderLeft } from '@progress/kendo-ooxml';
+import { WorkbookSheetRowCellBorderRight } from '@progress/kendo-ooxml';
+import { WorkbookSheetRowCellBorderTop } from '@progress/kendo-ooxml';
+
+/**
+ * The options for the Excel Export cell.
+ */
+declare interface CellOptions {
+    /**
+     * Sets the background color of the cell. Supports hex CSS-like values that start with `"#"`. For example, `"#ff00ff"`.
+     */
+    background?: string;
+    /**
+     * The style information for the bottom border of the cell.
+     */
+    borderBottom?: WorkbookSheetRowCellBorderBottom;
+    /**
+     * The style information for the left border of the cell.
+     */
+    borderLeft?: WorkbookSheetRowCellBorderLeft;
+    /**
+     * The style information for the top border of the cell.
+     */
+    borderTop?: WorkbookSheetRowCellBorderTop;
+    /**
+     * The style information for the right border of the cell.
+     */
+    borderRight?: WorkbookSheetRowCellBorderRight;
+    /**
+     * If set to `true`, renders the cell value in bold.
+     */
+    bold?: boolean;
+    /**
+     * The text color of the cell. Supports hex CSS-like values that start with `"#"`. For example, `"#ff00ff"`.
+     */
+    color?: string;
+    /**
+     * Sets the font that is used to display the cell value.
+     */
+    fontFamily?: string;
+    /**
+     * Sets the font size in pixels.
+     */
+    fontSize?: number;
+    /**
+     * Sets the format that Excel uses to display the cell value. For more information, refer to the page on [supported Excel formats](https://support.office.com/en-us/article/Create-or-delete-a-custom-number-format-78f2a361-936b-4c03-8772-09fab54be7f4).
+     */
+    format?: string;
+    /**
+     * If set to `true`, renders the cell value in italics.
+     */
+    italic?: boolean;
+    /**
+     * Sets the horizontal alignment of the cell value.
+     *
+     * The supported values are:
+     * * `"left"`
+     * * `"center"`
+     * * `"right"`
+     */
+    textAlign?: 'left' | 'center' | 'right';
+    /**
+     * If set to `true`, underlines the cell value.
+     */
+    underline?: boolean;
+    /**
+     * If set to `true`, wraps the cell value.
+     */
+    wrap?: boolean;
+    /**
+     * Sets the vertical alignment of the cell value.
+     *
+     * The supported values are:
+     * * `"top"`
+     * * `"center"`
+     * * `"bottom"`
+     */
+    verticalAlign?: 'top' | 'center' | 'bottom';
+}
+
+/**
+ * @hidden
+ */
+export declare interface ColumnBase {
+    /**
+     * @hidden
+     */
+    children?: any;
+    /**
+     * The options of the column header cell.
+     */
+    headerCellOptions?: CellOptions;
+    /**
+     * Sets the visibility of the column.
+     *
+     * @default false
+     */
+    hidden?: boolean;
+    /**
+     * @hidden
+     */
+    level?: number;
+    /**
+     * Toggles the locked (frozen) state of the column.
+     *
+     * @default false
+     */
+    locked?: boolean;
+    /**
+     * The title of the column.
+     */
+    title?: string;
+    /**
+     * The width of the column in pixels.
+     */
+    width?: number;
+}
+
+export declare class ExcelExport extends React_2.Component<ExcelExportProps> {
+    /**
+     * @hidden
+     */
+    static propTypes: {
+        children: PropTypes.Requireable<any>;
+        columns: PropTypes.Requireable<any[]>;
+        creator: PropTypes.Requireable<string>;
+        data: PropTypes.Requireable<any>;
+        date: PropTypes.Requireable<any>;
+        filterable: PropTypes.Requireable<boolean>;
+        fileName: PropTypes.Requireable<string>;
+        forceProxy: PropTypes.Requireable<boolean>;
+        group: PropTypes.Requireable<any>;
+        headerPaddingCellOptions: PropTypes.Requireable<any>;
+        paddingCellOptions: PropTypes.Requireable<any>;
+        proxyURL: PropTypes.Requireable<string>;
+        dir: PropTypes.Requireable<string>;
+        hierarchy: PropTypes.Requireable<boolean>;
+        collapsible: PropTypes.Requireable<boolean>;
+    };
+    /**
+     * @hidden
+     */
+    static defaultProps: {
+        fileName: string;
+        forceProxy: boolean;
+        collapsible: boolean;
+    };
+    constructor(props: ExcelExportProps);
+    /**
+     * Saves the data to Excel.
+     *
+     * @param exportData - An optional parameter. Can be the data that will be exported or the [`WorkbookOptions`]({% slug api_excel-export_workbookoptions %}).
+     * @param columns - An optional parameter. If present, it will be used instead of the columns prop or the child column components.
+     */
+    save(exportData?: any[] | ExcelExportData | WorkbookOptions, columns?: ExcelExportColumnProps[] | React_2.ReactElement<ExcelExportColumnProps>[]): void;
+    /**
+     * Returns a promise which will be resolved with the file data URI.
+     *
+     * @param exportData - The optional data or the [`WorkbookOptions`]({% slug api_excel-export_workbookoptions %}) that will be used to generate the data URI.
+     * @param externalColumns - The optional columns that will be used.
+     * @returns {Promise<string>} - The promise that will be resolved by the file data URI.
+     */
+    toDataURL(exportData?: any[] | ExcelExportData | WorkbookOptions, columns?: any[]): Promise<string>;
+    /**
+     * Based on the specified columns and data, returns [`WorkbookOptions`]({% slug api_excel-export_workbookoptions %}).
+     *
+     * @param exportData - The optional data that will be exported.
+     * @param externalColumns - The optional columns that will be used.
+     * @returns {WorkbookOptions} - The workbook options.
+     */
+    workbookOptions(exportData?: any[] | ExcelExportData, externalColumns?: ExcelExportColumnProps[] | React_2.ReactElement<ExcelExportColumnProps>[]): WorkbookOptions;
+    /**
+     * @hidden
+     */
+    render(): any;
+    protected saveFile: (dataURL: string) => void;
+    private extractColumns;
+    private extractChild;
+    private getExportData;
+}
+
+/**
+ * Represents the columns of the KendoReact ExcelExport component.
+ *
+ * @returns null
+ */
+export declare const ExcelExportColumn: React_2.FunctionComponent<ExcelExportColumnProps>;
+
+/**
+ * Represents the column group component of the KendoReact ExcelExport component.
+ *
+ * @returns null
+ */
+export declare const ExcelExportColumnGroup: React_2.FunctionComponent<ExcelExportColumnGroupProps>;
+
+export declare interface ExcelExportColumnGroupProps extends ColumnBase {
+}
+
+/**
+ * Represents the props of the KendoReact ExcelExportColumnProps component.
+ */
+export declare interface ExcelExportColumnProps extends ColumnBase {
+    /**
+     * The options of the column data cells.
+     */
+    cellOptions?: CellOptions;
+    /**
+     * The field to which the column is bound.
+     */
+    field?: string;
+    /**
+     * The options of the column footer cell.
+     */
+    footerCellOptions?: CellOptions;
+    /**
+     * The column footer. Can be a function or a React component.
+     */
+    footer?: Function | ExcelExportFooter;
+    /**
+     * The options of the column group footer cells.
+     */
+    groupFooterCellOptions?: CellOptions;
+    /**
+     * The footer of the group. Can be a function or a React component.
+     */
+    groupFooter?: Function | ExcelExportGroupFooter;
+    /**
+     * The options of the column group header cells.
+     */
+    groupHeaderCellOptions?: CellOptions;
+    /**
+     * The header of the group. Can be a function or a React component.
+     */
+    groupHeader?: Function | ExcelExportGroupHeader;
+}
+
+/**
+ * The type that is expected for the ExcelExportComponent data.
+ */
+export declare interface ExcelExportData {
+    /**
+     * The exported data. If grouped, the data must be structured as described in the [`GroupResult`]({% slug api_kendo-data-query_groupresult %}) of the KendoReact Data Query component.
+     */
+    data?: any[];
+    /**
+     * The exported data groups. The groups must be compatible with the [`GroupDescriptor`]({% slug api_kendo-data-query_groupdescriptor %}) of the KendoReact Data Query component.
+     */
+    group?: any[];
+}
+
+/**
+ * Represents the return type of ExcelExportExportEvent.
+ */
+export declare type ExcelExportExportEvent = {
+    /**
+     * The target of the ExcelExportExportEvent from ExcelExport.
+     */
+    target: ExcelExport;
+};
+
+/**
+ * Represents the footer of column.
+ */
+export declare class ExcelExportFooter extends React_2.PureComponent<ExcelExportFooterProps> {
+}
+
+/**
+ * Represents the props that will be passed to the ExcelExportFooter component when the template is rendered.
+ */
+export declare interface ExcelExportFooterProps {
+    column: ExcelExportColumnProps;
+    columnIndex: number;
+}
+
+/**
+ * Represents the footer of the column group.
+ */
+export declare class ExcelExportGroupFooter extends React_2.PureComponent<ExcelExportGroupFooterProps> {
+}
+
+/**
+ * Represents the props that will be passed to the ExcelExportGroupFooter component when the template is rendered.
+ */
+export declare interface ExcelExportGroupFooterProps {
+    field: string;
+    column: ExcelExportColumnProps;
+    aggregates: AggregateResult;
+    group: GroupResult;
+}
+
+/**
+ * Represents the header of the column group.
+ */
+export declare class ExcelExportGroupHeader extends React_2.PureComponent<ExcelExportGroupHeaderProps> {
+}
+
+/**
+ * Represents the props that will be passed to the ExcelExportGroupHeader component when the template is rendered.
+ */
+export declare interface ExcelExportGroupHeaderProps {
+    field: string;
+    aggregates: AggregateResult;
+    group: GroupResult;
+    value: any;
+}
+
+/**
+ * Represents the props of the KendoReact ExcelExport component.
+ */
+export declare interface ExcelExportProps {
+    /**
+     * @hidden
+     */
+    children?: any;
+    /**
+     * You can pass the columns through the props of the component. If both the columns prop and the child column components are presented, the columns from props will be used.
+     */
+    columns?: ExcelExportColumnProps[];
+    /**
+     * The creator of the workbook.
+     */
+    creator?: string;
+    /**
+     * The exported data. If grouped, the data must be structured as described by the [`GroupResult`]({% slug api_kendo-data-query_groupresult %}) option of the KendoReact Data Query component.
+     */
+    data?: any[];
+    /**
+     * The date on which the workbook is created. The default value is `new Date()`.
+     */
+    date?: Date;
+    /**
+     * Enables or disables the column filtering in the Excel file.
+     */
+    filterable?: boolean;
+    /**
+     * Specifies the name of the file that is exported to Excel. Defaults to `Export.xlsx`.
+     */
+    fileName?: string;
+    /**
+     * If set to `true`, the content is forwarded to `proxyURL` even if the browser supports the saving of files locally.
+     */
+    forceProxy?: boolean;
+    /**
+     * The exported data groups. The groups must be compatible with the [`GroupDescriptor`]({% slug api_kendo-data-query_groupdescriptor %}) option of the KendoReact Data Query component.
+     */
+    group?: any[];
+    /**
+     * The options of the cells that are inserted before the header cells to align the headers and the column values (when the data is grouped).
+     */
+    headerPaddingCellOptions?: CellOptions;
+    /**
+     * The options of the cells that are inserted before the data, group, and footer cells to indicate the group hierarchy (when the data is grouped).
+     */
+    paddingCellOptions?: CellOptions;
+    /**
+     * The URL of the server-side proxy which will stream the file to the end user. When the browser is not capable of saving files locally&mdash;for example, Internet Explorer 9 and earlier, and Safari&mdash;a proxy is used. The implementation of the server-side proxy has to be done by you.
+     *
+     * The proxy receives a `POST` request with the following parameters in the request body:
+     * - `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 is expected to return the decoded file with the **Content-Disposition** header set to `attachment; filename="<fileName.xslx>"`.
+     */
+    proxyURL?: string;
+    /**
+     * If set to `rtl`, the Excel file will be rendered in the right-to-left mode.
+     */
+    dir?: string;
+    /**
+     * If set to true the data will be exported as a tree based on the `level` property of each data record.
+     */
+    hierarchy?: boolean;
+    /**
+     * Enables or disables collapsible (grouped) rows in the exported file.
+     */
+    collapsible?: boolean;
+    /**
+     * Triggered after the export is complete.
+     */
+    onExportComplete?: (event: ExcelExportExportEvent) => void;
+}
+
+/**
+ * @hidden
+ */
+export declare const isWorkbookOptions: (value: any) => boolean;
+
+export { KendoOoxml }
+
+/**
+ * @hidden
+ */
+export declare const toDataURL: (options: WorkbookOptions) => Promise<string>;
+
+/**
+ * @hidden
+ */
+export declare const workbookOptions: (options: ExcelExportProps) => WorkbookOptions;
+
+export { }

package/index.js

@@ -1,5 +1,8 @@
-/**-----------------------------------------------------------------------------------------
-* Copyright © 2024 Progress Software Corporation. All rights reserved.
-* Licensed under commercial license. See LICENSE.md in the package root for more information
-*-------------------------------------------------------------------------------------------*/
-"use client";"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const b=require("react"),r=require("prop-types"),E=require("@progress/kendo-file-saver"),c=require("@progress/kendo-ooxml"),k=require("react-dom/server"),w=require("@progress/kendo-react-common");function h(t){const e=Object.create(null,{[Symbol.toStringTag]:{value:"Module"}});if(t){for(const o in t)if(o!=="default"){const s=Object.getOwnPropertyDescriptor(t,o);Object.defineProperty(e,o,s.get?s:{enumerable:!0,get:()=>t[o]})}}return e.default=t,Object.freeze(e)}const n=h(b),P=h(c),R=h(k),d=(t,e,o)=>i=>{o(e,i);const p=R.renderToStaticMarkup(n.createElement(t,{...e})),l=Number(p);return isNaN(l)?p:l},T=(t,e)=>{t.$implicit=t.group=e,t.field=e.field,t.value=e.value,t.aggregates=e.aggregates},v=(t,e)=>{t.group=e.group,t.$implicit=t.aggregates=e},F=(t,e)=>{},D=t=>{const e=[];let o=0;const s=(i,p,l)=>{i.forEach(a=>{if(a.level===l){const g=new U(a,o);if(p.push(g),a.children&&a.children.length>1){const y=g.columns=[];s(a.children,y,l+1)}else o++}})};return s(t,e,0),e};class U{constructor(e,o){this.columns=null,this.title=e.title,this.field=e.field,this.hidden=e.hidden,this.locked=e.locked,this.width=e.width,this.headerCellOptions=e.headerCellOptions,this.cellOptions=e.cellOptions,this.groupHeaderCellOptions=e.groupHeaderCellOptions,this.groupFooterCellOptions=e.groupFooterCellOptions,this.footerCellOptions=e.footerCellOptions,e.footer&&(this.footerTemplate=d(e.footer,{$implicit:e,column:e,columnIndex:o},F)),e.groupFooter&&(this.groupFooterTemplate=d(e.groupFooter,{column:e,field:e.field},v)),e.groupHeader&&(this.groupHeaderTemplate=d(e.groupHeader,{},T))}}const L=t=>Math.max(...t.map(e=>e.level))+1,f=t=>{const e=D(t.columns),s=new c.ExcelExporter({columns:e,data:t.data,filterable:t.filterable,groups:t.group,paddingCellOptions:t.paddingCellOptions,headerPaddingCellOptions:t.headerPaddingCellOptions,hierarchy:t.hierarchy?{depth:L(t.data),itemLevel:i=>i.level}:null,collapsible:t.collapsible}).workbook();return s.creator=t.creator,s.date=t.date,s.rtl=t.dir==="rtl",s},x=t=>new c.Workbook(t).toDataURL(),C=t=>t&&t.sheets,N={name:"@progress/kendo-react-excel-export",productName:"KendoReact",productCodes:["KENDOUIREACT","KENDOUICOMPLETE"],publishDate:0,version:"",licensingDocsUrl:"https://www.telerik.com/kendo-react-ui/components/my-license/"};class u extends n.Component{constructor(e){super(e),this.saveFile=o=>{E.saveAs(o,this.props.fileName,{forceProxy:this.props.forceProxy,proxyURL:this.props.proxyURL})},this.extractColumns=(o,s=0)=>Array.isArray(o)?o.map(i=>this.extractChild(i,s)):[o,this.extractChild(o,s)],this.extractChild=(o,s=0)=>n.isValidElement(o)?{...o.props,width:o.props.width&&parseInt(`${o.props.width}`,10),level:s,children:o.props.children&&this.extractColumns(o.props.children,s+1)}:{...o,level:s,children:o.children&&this.extractColumns(o.children,s+1)},this.getExportData=o=>{let s;return o?Array.isArray(o)?s={data:o}:s=o:s={data:this.props.data,group:this.props.group},s},w.validatePackage(N),this.save=this.save.bind(this),this.toDataURL=this.toDataURL.bind(this),this.workbookOptions=this.workbookOptions.bind(this)}save(e,o){this.toDataURL(e,o).then((...s)=>{this.props.onExportComplete&&this.props.onExportComplete.call(void 0,{target:this}),this.saveFile(...s)})}toDataURL(e,o){const s=C(e)?e:this.workbookOptions(e,o);return x(s)}workbookOptions(e,o){const s=this.getExportData(e),i=this.props.children,p=i&&i.type&&i.type.displayName==="KendoReactGrid"&&i.props&&n.Children.toArray(i.props.children),l=this.extractColumns(p||o||this.props.columns||n.Children.toArray(i));return f({columns:l,data:s.data,group:s.group,filterable:this.props.filterable,creator:this.props.creator,date:this.props.date,dir:this.props.dir,hierarchy:this.props.hierarchy,paddingCellOptions:this.props.paddingCellOptions,headerPaddingCellOptions:this.props.headerPaddingCellOptions,collapsible:this.props.collapsible})}render(){return this.props.children||null}}u.propTypes={children:r.any,columns:r.arrayOf(r.any),creator:r.string,data:r.any,date:r.any,filterable:r.bool,fileName:r.string,forceProxy:r.bool,group:r.any,headerPaddingCellOptions:r.any,paddingCellOptions:r.any,proxyURL:r.string,dir:r.string,hierarchy:r.bool,collapsible:r.bool};u.defaultProps={fileName:"Export.xlsx",forceProxy:!1,collapsible:!1};const O=t=>null;O.propTypes={cellOptions:r.any,field:r.string,footerCellOptions:r.any,footer:r.oneOfType([r.func,r.element]),groupFooterCellOptions:r.any,groupFooter:r.oneOfType([r.func,r.element]),groupHeaderCellOptions:r.any,groupHeader:r.oneOfType([r.func,r.element]),headerCellOptions:r.any,hidden:r.bool,level:r.number,locked:r.bool,title:r.string,width:r.number};const m=t=>null;m.propTypes={children:r.oneOfType([r.arrayOf(r.element),r.element]),headerCellOptions:r.any,hidden:r.bool,level:r.number,locked:r.bool,title:r.string,width:r.number};class _ extends n.PureComponent{}class H extends n.PureComponent{}class G extends n.PureComponent{}exports.KendoOoxml=P;exports.ExcelExport=u;exports.ExcelExportColumn=O;exports.ExcelExportColumnGroup=m;exports.ExcelExportFooter=_;exports.ExcelExportGroupFooter=H;exports.ExcelExportGroupHeader=G;exports.isWorkbookOptions=C;exports.toDataURL=x;exports.workbookOptions=f;
+/**
+ * @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";"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const l=require("./ExcelExport.js"),n=require("./ExcelExportColumn.js"),x=require("./ExcelExportColumnGroup.js"),p=require("./templates/ExcelExportFooter.js"),u=require("./templates/ExcelExportGroupFooter.js"),E=require("./templates/ExcelExportGroupHeader.js"),i=require("@progress/kendo-ooxml"),t=require("./ooxml/workbook.js");function s(o){const r=Object.create(null,{[Symbol.toStringTag]:{value:"Module"}});if(o){for(const e in o)if(e!=="default"){const c=Object.getOwnPropertyDescriptor(o,e);Object.defineProperty(r,e,c.get?c:{enumerable:!0,get:()=>o[e]})}}return r.default=o,Object.freeze(r)}const a=s(i);exports.ExcelExport=l.ExcelExport;exports.ExcelExportColumn=n.ExcelExportColumn;exports.ExcelExportColumnGroup=x.ExcelExportColumnGroup;exports.ExcelExportFooter=p.ExcelExportFooter;exports.ExcelExportGroupFooter=u.ExcelExportGroupFooter;exports.ExcelExportGroupHeader=E.ExcelExportGroupHeader;exports.KendoOoxml=a;exports.isWorkbookOptions=t.isWorkbookOptions;exports.toDataURL=t.toDataURL;exports.workbookOptions=t.workbookOptions;