@progress/kendo-react-excel-export 13.3.0-develop.9 → 13.4.0-develop.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/ColumnBase.d.ts +45 -0
- package/ExcelExport.d.ts +174 -0
- package/ExcelExportColumn.d.ts +57 -0
- package/ExcelExportColumnGroup.d.ts +18 -0
- package/ExcelExportData.d.ts +20 -0
- package/dist/cdn/js/kendo-react-excel.js +1 -1
- package/index.d.mts +12 -453
- package/index.d.ts +12 -453
- package/ooxml/CellOptionsInterface.d.ts +83 -0
- package/ooxml/ExporterColumns.d.ts +33 -0
- package/ooxml/workbook.d.ts +21 -0
- package/package-metadata.d.ts +12 -0
- package/package-metadata.js +1 -1
- package/package-metadata.mjs +10 -16
- package/package.json +3 -3
- package/templates/ExcelExportFooter.d.ts +27 -0
- package/templates/ExcelExportGroupFooter.d.ts +36 -0
- package/templates/ExcelExportGroupHeader.d.ts +35 -0
package/index.d.ts
CHANGED
|
@@ -5,456 +5,15 @@
|
|
|
5
5
|
* Licensed under commercial license. See LICENSE.md in the package root for more information
|
|
6
6
|
*-------------------------------------------------------------------------------------------
|
|
7
7
|
*/
|
|
8
|
-
import {
|
|
9
|
-
import {
|
|
10
|
-
import {
|
|
11
|
-
import {
|
|
12
|
-
import
|
|
13
|
-
import
|
|
14
|
-
import {
|
|
15
|
-
import {
|
|
16
|
-
import {
|
|
17
|
-
import
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
/**
|
|
21
|
-
* The options for the Excel Export cell.
|
|
22
|
-
*/
|
|
23
|
-
export declare interface CellOptions {
|
|
24
|
-
/**
|
|
25
|
-
* Sets the background color of the cell. Supports hex CSS-like values that start with `"#"`. For example, `"#ff00ff"`.
|
|
26
|
-
*/
|
|
27
|
-
background?: string;
|
|
28
|
-
/**
|
|
29
|
-
* The style information for the bottom border of the cell.
|
|
30
|
-
*/
|
|
31
|
-
borderBottom?: WorkbookSheetRowCellBorderBottom;
|
|
32
|
-
/**
|
|
33
|
-
* The style information for the left border of the cell.
|
|
34
|
-
*/
|
|
35
|
-
borderLeft?: WorkbookSheetRowCellBorderLeft;
|
|
36
|
-
/**
|
|
37
|
-
* The style information for the top border of the cell.
|
|
38
|
-
*/
|
|
39
|
-
borderTop?: WorkbookSheetRowCellBorderTop;
|
|
40
|
-
/**
|
|
41
|
-
* The style information for the right border of the cell.
|
|
42
|
-
*/
|
|
43
|
-
borderRight?: WorkbookSheetRowCellBorderRight;
|
|
44
|
-
/**
|
|
45
|
-
* If set to `true`, renders the cell value in bold.
|
|
46
|
-
*/
|
|
47
|
-
bold?: boolean;
|
|
48
|
-
/**
|
|
49
|
-
* The text color of the cell. Supports hex CSS-like values that start with `"#"`. For example, `"#ff00ff"`.
|
|
50
|
-
*/
|
|
51
|
-
color?: string;
|
|
52
|
-
/**
|
|
53
|
-
* Sets the font that is used to display the cell value.
|
|
54
|
-
*/
|
|
55
|
-
fontFamily?: string;
|
|
56
|
-
/**
|
|
57
|
-
* Sets the font size in pixels.
|
|
58
|
-
*/
|
|
59
|
-
fontSize?: number;
|
|
60
|
-
/**
|
|
61
|
-
* 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).
|
|
62
|
-
*/
|
|
63
|
-
format?: string;
|
|
64
|
-
/**
|
|
65
|
-
* If set to `true`, renders the cell value in italics.
|
|
66
|
-
*/
|
|
67
|
-
italic?: boolean;
|
|
68
|
-
/**
|
|
69
|
-
* Sets the horizontal alignment of the cell value.
|
|
70
|
-
*
|
|
71
|
-
* The supported values are:
|
|
72
|
-
* * `"left"`
|
|
73
|
-
* * `"center"`
|
|
74
|
-
* * `"right"`
|
|
75
|
-
*/
|
|
76
|
-
textAlign?: 'left' | 'center' | 'right';
|
|
77
|
-
/**
|
|
78
|
-
* If set to `true`, underlines the cell value.
|
|
79
|
-
*/
|
|
80
|
-
underline?: boolean;
|
|
81
|
-
/**
|
|
82
|
-
* If set to `true`, wraps the cell value.
|
|
83
|
-
*/
|
|
84
|
-
wrap?: boolean;
|
|
85
|
-
/**
|
|
86
|
-
* Sets the vertical alignment of the cell value.
|
|
87
|
-
*
|
|
88
|
-
* The supported values are:
|
|
89
|
-
* * `"top"`
|
|
90
|
-
* * `"center"`
|
|
91
|
-
* * `"bottom"`
|
|
92
|
-
*/
|
|
93
|
-
verticalAlign?: 'top' | 'center' | 'bottom';
|
|
94
|
-
}
|
|
95
|
-
|
|
96
|
-
/**
|
|
97
|
-
* @hidden
|
|
98
|
-
*/
|
|
99
|
-
export declare interface ColumnBase {
|
|
100
|
-
/**
|
|
101
|
-
* @hidden
|
|
102
|
-
*/
|
|
103
|
-
children?: any;
|
|
104
|
-
/**
|
|
105
|
-
* The options of the column header cell.
|
|
106
|
-
*/
|
|
107
|
-
headerCellOptions?: CellOptions;
|
|
108
|
-
/**
|
|
109
|
-
* Sets the visibility of the column.
|
|
110
|
-
*
|
|
111
|
-
* @default false
|
|
112
|
-
*/
|
|
113
|
-
hidden?: boolean;
|
|
114
|
-
/**
|
|
115
|
-
* @hidden
|
|
116
|
-
*/
|
|
117
|
-
level?: number;
|
|
118
|
-
/**
|
|
119
|
-
* Toggles the locked (frozen) state of the column.
|
|
120
|
-
*
|
|
121
|
-
* @default false
|
|
122
|
-
*/
|
|
123
|
-
locked?: boolean;
|
|
124
|
-
/**
|
|
125
|
-
* The title of the column.
|
|
126
|
-
*/
|
|
127
|
-
title?: string;
|
|
128
|
-
/**
|
|
129
|
-
* The width of the column in pixels.
|
|
130
|
-
*/
|
|
131
|
-
width?: number;
|
|
132
|
-
}
|
|
133
|
-
|
|
134
|
-
/**
|
|
135
|
-
* Represents the KendoReact ExcelExport component.
|
|
136
|
-
*
|
|
137
|
-
* @remarks
|
|
138
|
-
* Supported children components are: {@link ExcelExportColumn}.
|
|
139
|
-
*/
|
|
140
|
-
export declare class ExcelExport extends React_2.Component<ExcelExportProps> {
|
|
141
|
-
/**
|
|
142
|
-
* @hidden
|
|
143
|
-
*/
|
|
144
|
-
static propTypes: {
|
|
145
|
-
children: default_2.Requireable<any>;
|
|
146
|
-
columns: default_2.Requireable<any[]>;
|
|
147
|
-
creator: default_2.Requireable<string>;
|
|
148
|
-
data: default_2.Requireable<any>;
|
|
149
|
-
date: default_2.Requireable<any>;
|
|
150
|
-
filterable: default_2.Requireable<boolean>;
|
|
151
|
-
fileName: default_2.Requireable<string>;
|
|
152
|
-
forceProxy: default_2.Requireable<boolean>;
|
|
153
|
-
group: default_2.Requireable<any>;
|
|
154
|
-
headerPaddingCellOptions: default_2.Requireable<any>;
|
|
155
|
-
paddingCellOptions: default_2.Requireable<any>;
|
|
156
|
-
proxyURL: default_2.Requireable<string>;
|
|
157
|
-
dir: default_2.Requireable<string>;
|
|
158
|
-
hierarchy: default_2.Requireable<boolean>;
|
|
159
|
-
collapsible: default_2.Requireable<boolean>;
|
|
160
|
-
};
|
|
161
|
-
/**
|
|
162
|
-
* @hidden
|
|
163
|
-
*/
|
|
164
|
-
static defaultProps: {
|
|
165
|
-
fileName: string;
|
|
166
|
-
forceProxy: boolean;
|
|
167
|
-
collapsible: boolean;
|
|
168
|
-
};
|
|
169
|
-
private readonly showLicenseWatermark;
|
|
170
|
-
private readonly licenseMessage?;
|
|
171
|
-
constructor(props: ExcelExportProps);
|
|
172
|
-
/**
|
|
173
|
-
* Saves the data to Excel.
|
|
174
|
-
*
|
|
175
|
-
* @param exportData - An optional parameter. Can be the data that will be exported or the [`WorkbookOptions`](https://www.telerik.com/kendo-react-ui/components/excel/api/kendoooxml#toc-workbookoptions).
|
|
176
|
-
* @param columns - An optional parameter. If present, it will be used instead of the columns prop or the child column components.
|
|
177
|
-
*/
|
|
178
|
-
save(exportData?: any[] | ExcelExportData | WorkbookOptions, columns?: ExcelExportColumnProps[] | React_2.ReactElement<ExcelExportColumnProps>[]): void;
|
|
179
|
-
/**
|
|
180
|
-
* Returns a promise which will be resolved with the file data URI.
|
|
181
|
-
*
|
|
182
|
-
* @param exportData - The optional data or the [`WorkbookOptions`](https://www.telerik.com/kendo-react-ui/components/excel/api/kendoooxml#toc-workbookoptions) that will be used to generate the data URI.
|
|
183
|
-
* @param externalColumns - The optional columns that will be used.
|
|
184
|
-
* @returns {Promise<string>} - The promise that will be resolved by the file data URI.
|
|
185
|
-
*/
|
|
186
|
-
toDataURL(exportData?: any[] | ExcelExportData | WorkbookOptions, columns?: any[]): Promise<string>;
|
|
187
|
-
/**
|
|
188
|
-
* Based on the specified columns and data, returns [`WorkbookOptions`](https://www.telerik.com/kendo-react-ui/components/excel/api/kendoooxml#toc-workbookoptions).
|
|
189
|
-
*
|
|
190
|
-
* @param exportData - The optional data that will be exported.
|
|
191
|
-
* @param externalColumns - The optional columns that will be used.
|
|
192
|
-
* @returns {WorkbookOptions} - The workbook options.
|
|
193
|
-
*/
|
|
194
|
-
workbookOptions(exportData?: any[] | ExcelExportData, externalColumns?: ExcelExportColumnProps[] | React_2.ReactElement<ExcelExportColumnProps>[]): WorkbookOptions;
|
|
195
|
-
/**
|
|
196
|
-
* @hidden
|
|
197
|
-
*/
|
|
198
|
-
render(): JSX.Element;
|
|
199
|
-
protected saveFile: (dataURL: string) => void;
|
|
200
|
-
private extractColumns;
|
|
201
|
-
private extractChild;
|
|
202
|
-
private getExportData;
|
|
203
|
-
}
|
|
204
|
-
|
|
205
|
-
/**
|
|
206
|
-
* Represents the columns of the KendoReact ExcelExport component.
|
|
207
|
-
*
|
|
208
|
-
* @returns null
|
|
209
|
-
*/
|
|
210
|
-
export declare const ExcelExportColumn: React_2.FunctionComponent<ExcelExportColumnProps>;
|
|
211
|
-
|
|
212
|
-
/**
|
|
213
|
-
* Represents the column group component of the KendoReact ExcelExport component.
|
|
214
|
-
*
|
|
215
|
-
* @returns null
|
|
216
|
-
*/
|
|
217
|
-
export declare const ExcelExportColumnGroup: React_2.FunctionComponent<ExcelExportColumnGroupProps>;
|
|
218
|
-
|
|
219
|
-
export declare interface ExcelExportColumnGroupProps extends ColumnBase {
|
|
220
|
-
}
|
|
221
|
-
|
|
222
|
-
/**
|
|
223
|
-
* Represents the props of the KendoReact ExcelExportColumnProps component.
|
|
224
|
-
*/
|
|
225
|
-
export declare interface ExcelExportColumnProps extends ColumnBase {
|
|
226
|
-
/**
|
|
227
|
-
* The options of the column data cells.
|
|
228
|
-
*/
|
|
229
|
-
cellOptions?: CellOptions;
|
|
230
|
-
/**
|
|
231
|
-
* The field to which the column is bound.
|
|
232
|
-
*/
|
|
233
|
-
field?: string;
|
|
234
|
-
/**
|
|
235
|
-
* The options of the column footer cell.
|
|
236
|
-
*/
|
|
237
|
-
footerCellOptions?: CellOptions;
|
|
238
|
-
/**
|
|
239
|
-
* The column footer. Can be a function or a React component.
|
|
240
|
-
*/
|
|
241
|
-
footer?: Function | ExcelExportFooter;
|
|
242
|
-
/**
|
|
243
|
-
* The options of the column group footer cells.
|
|
244
|
-
*/
|
|
245
|
-
groupFooterCellOptions?: CellOptions;
|
|
246
|
-
/**
|
|
247
|
-
* The footer of the group. Can be a function or a React component.
|
|
248
|
-
*/
|
|
249
|
-
groupFooter?: Function | ExcelExportGroupFooter;
|
|
250
|
-
/**
|
|
251
|
-
* The options of the column group header cells.
|
|
252
|
-
*/
|
|
253
|
-
groupHeaderCellOptions?: CellOptions;
|
|
254
|
-
/**
|
|
255
|
-
* The header of the group. Can be a function or a React component.
|
|
256
|
-
*/
|
|
257
|
-
groupHeader?: Function | ExcelExportGroupHeader;
|
|
258
|
-
}
|
|
259
|
-
|
|
260
|
-
/**
|
|
261
|
-
* The type that is expected for the ExcelExportComponent `data`.
|
|
262
|
-
*/
|
|
263
|
-
export declare interface ExcelExportData {
|
|
264
|
-
/**
|
|
265
|
-
* The exported data. If grouped, structure the data as described in the [`GroupResult`](https://www.telerik.com/kendo-react-ui/components/datatools/api/groupresult) of the KendoReact Data Query component.
|
|
266
|
-
*/
|
|
267
|
-
data?: any[];
|
|
268
|
-
/**
|
|
269
|
-
* The exported data groups. The groups must be compatible with the [`GroupDescriptor`](https://www.telerik.com/kendo-react-ui/components/datatools/api/groupdescriptor) of the KendoReact Data Query component.
|
|
270
|
-
*/
|
|
271
|
-
group?: any[];
|
|
272
|
-
}
|
|
273
|
-
|
|
274
|
-
/**
|
|
275
|
-
* Represents the return type of ExcelExportExportEvent.
|
|
276
|
-
*/
|
|
277
|
-
export declare type ExcelExportExportEvent = {
|
|
278
|
-
/**
|
|
279
|
-
* The target of the ExcelExportExportEvent from ExcelExport.
|
|
280
|
-
*/
|
|
281
|
-
target: ExcelExport;
|
|
282
|
-
};
|
|
283
|
-
|
|
284
|
-
/**
|
|
285
|
-
* Represents the footer of column.
|
|
286
|
-
*/
|
|
287
|
-
export declare class ExcelExportFooter extends React_2.PureComponent<ExcelExportFooterProps> {
|
|
288
|
-
}
|
|
289
|
-
|
|
290
|
-
/**
|
|
291
|
-
* Represents the props that will be passed to the ExcelExportFooter component when the template is rendered.
|
|
292
|
-
*/
|
|
293
|
-
export declare interface ExcelExportFooterProps {
|
|
294
|
-
/**
|
|
295
|
-
* The column configuration object for the current column.
|
|
296
|
-
*/
|
|
297
|
-
column: ExcelExportColumnProps;
|
|
298
|
-
/**
|
|
299
|
-
* The index of the current column within the grid.
|
|
300
|
-
*/
|
|
301
|
-
columnIndex: number;
|
|
302
|
-
}
|
|
303
|
-
|
|
304
|
-
/**
|
|
305
|
-
* Represents the footer of the column group.
|
|
306
|
-
*/
|
|
307
|
-
export declare class ExcelExportGroupFooter extends React_2.PureComponent<ExcelExportGroupFooterProps> {
|
|
308
|
-
}
|
|
309
|
-
|
|
310
|
-
/**
|
|
311
|
-
* Represents the props that will be passed to the ExcelExportGroupFooter component when the template is rendered.
|
|
312
|
-
*/
|
|
313
|
-
export declare interface ExcelExportGroupFooterProps {
|
|
314
|
-
/**
|
|
315
|
-
* The field name by which the data is grouped.
|
|
316
|
-
*/
|
|
317
|
-
field: string;
|
|
318
|
-
/**
|
|
319
|
-
* The column configuration object for the current column.
|
|
320
|
-
*/
|
|
321
|
-
column: ExcelExportColumnProps;
|
|
322
|
-
/**
|
|
323
|
-
* The aggregate calculation results for the current group.
|
|
324
|
-
*/
|
|
325
|
-
aggregates: AggregateResult;
|
|
326
|
-
/**
|
|
327
|
-
* The group data and metadata for the current group.
|
|
328
|
-
*/
|
|
329
|
-
group: GroupResult;
|
|
330
|
-
}
|
|
331
|
-
|
|
332
|
-
/**
|
|
333
|
-
* Represents the header of the column group.
|
|
334
|
-
*/
|
|
335
|
-
export declare class ExcelExportGroupHeader extends React_2.PureComponent<ExcelExportGroupHeaderProps> {
|
|
336
|
-
}
|
|
337
|
-
|
|
338
|
-
/**
|
|
339
|
-
* Represents the props that will be passed to the ExcelExportGroupHeader component when the template is rendered.
|
|
340
|
-
*/
|
|
341
|
-
export declare interface ExcelExportGroupHeaderProps {
|
|
342
|
-
/**
|
|
343
|
-
* The field name by which the data is grouped.
|
|
344
|
-
*/
|
|
345
|
-
field: string;
|
|
346
|
-
/**
|
|
347
|
-
* The aggregate calculation results for the current group.
|
|
348
|
-
*/
|
|
349
|
-
aggregates: AggregateResult;
|
|
350
|
-
/**
|
|
351
|
-
* The group data and metadata for the current group.
|
|
352
|
-
*/
|
|
353
|
-
group: GroupResult;
|
|
354
|
-
/**
|
|
355
|
-
* The value that identifies the current group.
|
|
356
|
-
*/
|
|
357
|
-
value: any;
|
|
358
|
-
}
|
|
359
|
-
|
|
360
|
-
/**
|
|
361
|
-
* Represents the props of the KendoReact ExcelExport component.
|
|
362
|
-
*/
|
|
363
|
-
export declare interface ExcelExportProps {
|
|
364
|
-
/**
|
|
365
|
-
* @hidden
|
|
366
|
-
*/
|
|
367
|
-
children?: any;
|
|
368
|
-
/**
|
|
369
|
-
* Pass the columns through the component props. If you provide both the `columns` prop and the child column components, the component uses the columns from props.
|
|
370
|
-
*/
|
|
371
|
-
columns?: ExcelExportColumnProps[];
|
|
372
|
-
/**
|
|
373
|
-
* The creator of the workbook.
|
|
374
|
-
*/
|
|
375
|
-
creator?: string;
|
|
376
|
-
/**
|
|
377
|
-
* The exported data. If grouped, structure the data as described by the [`GroupResult`](https://www.telerik.com/kendo-react-ui/components/datatools/api/groupresult) option of the KendoReact Data Query component.
|
|
378
|
-
*/
|
|
379
|
-
data?: any[];
|
|
380
|
-
/**
|
|
381
|
-
* The date on which the workbook is created.
|
|
382
|
-
*
|
|
383
|
-
* @default new Date()
|
|
384
|
-
*/
|
|
385
|
-
date?: Date;
|
|
386
|
-
/**
|
|
387
|
-
* Enables or disables the column filtering in the Excel file.
|
|
388
|
-
*/
|
|
389
|
-
filterable?: boolean;
|
|
390
|
-
/**
|
|
391
|
-
* Specifies the name of the file that is exported to Excel.
|
|
392
|
-
*
|
|
393
|
-
* @default "Export.xlsx"
|
|
394
|
-
*/
|
|
395
|
-
fileName?: string;
|
|
396
|
-
/**
|
|
397
|
-
* If set to `true`, the content is forwarded to `proxyURL` even if the browser supports saving files locally.
|
|
398
|
-
*
|
|
399
|
-
* @default false
|
|
400
|
-
*/
|
|
401
|
-
forceProxy?: boolean;
|
|
402
|
-
/**
|
|
403
|
-
* The exported data groups. The groups must be compatible with the [`GroupDescriptor`](https://www.telerik.com/kendo-react-ui/components/datatools/api/groupdescriptor) option of the KendoReact Data Query component.
|
|
404
|
-
*/
|
|
405
|
-
group?: any[];
|
|
406
|
-
/**
|
|
407
|
-
* 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).
|
|
408
|
-
*/
|
|
409
|
-
headerPaddingCellOptions?: CellOptions;
|
|
410
|
-
/**
|
|
411
|
-
* 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).
|
|
412
|
-
*/
|
|
413
|
-
paddingCellOptions?: CellOptions;
|
|
414
|
-
/**
|
|
415
|
-
* The URL of the server-side proxy which streams the file to the end user. When the browser cannot save files locally—for example, Internet Explorer 9 and earlier, and Safari—a proxy is used. You must implement the server-side proxy.
|
|
416
|
-
*
|
|
417
|
-
* The proxy receives a `POST` request with the following parameters in the request body:
|
|
418
|
-
* - `contentType`—The MIME type of the file.
|
|
419
|
-
* - `base64`—The base-64 encoded file content.
|
|
420
|
-
* - `fileName`—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>"`.
|
|
421
|
-
*/
|
|
422
|
-
proxyURL?: string;
|
|
423
|
-
/**
|
|
424
|
-
* If set to `rtl`, the Excel file is rendered in the right-to-left mode.
|
|
425
|
-
*/
|
|
426
|
-
dir?: string;
|
|
427
|
-
/**
|
|
428
|
-
* If set to `true`, the data is exported as a tree based on the `level` property of each data record.
|
|
429
|
-
*/
|
|
430
|
-
hierarchy?: boolean;
|
|
431
|
-
/**
|
|
432
|
-
* Enables or disables collapsible (grouped) rows in the exported file.
|
|
433
|
-
*
|
|
434
|
-
* @default false
|
|
435
|
-
*/
|
|
436
|
-
collapsible?: boolean;
|
|
437
|
-
/**
|
|
438
|
-
* Triggered after the export is complete.
|
|
439
|
-
*/
|
|
440
|
-
onExportComplete?: (event: ExcelExportExportEvent) => void;
|
|
441
|
-
}
|
|
442
|
-
|
|
443
|
-
/**
|
|
444
|
-
* @hidden
|
|
445
|
-
*/
|
|
446
|
-
export declare const isWorkbookOptions: (value: any) => boolean;
|
|
447
|
-
|
|
448
|
-
export { KendoOoxml }
|
|
449
|
-
|
|
450
|
-
/**
|
|
451
|
-
* @hidden
|
|
452
|
-
*/
|
|
453
|
-
export declare const toDataURL: (options: WorkbookOptions) => Promise<string>;
|
|
454
|
-
|
|
455
|
-
/**
|
|
456
|
-
* @hidden
|
|
457
|
-
*/
|
|
458
|
-
export declare const workbookOptions: (options: ExcelExportProps) => WorkbookOptions;
|
|
459
|
-
|
|
460
|
-
export { }
|
|
8
|
+
import { ExcelExport, ExcelExportProps, ExcelExportExportEvent } from './ExcelExport.js';
|
|
9
|
+
import { ExcelExportData } from './ExcelExportData.js';
|
|
10
|
+
import { ExcelExportColumn, ExcelExportColumnProps } from './ExcelExportColumn.js';
|
|
11
|
+
import { ExcelExportColumnGroup, ExcelExportColumnGroupProps } from './ExcelExportColumnGroup.js';
|
|
12
|
+
import { ColumnBase } from './ColumnBase.js';
|
|
13
|
+
import { CellOptions } from './ooxml/CellOptionsInterface.js';
|
|
14
|
+
import { ExcelExportFooter, ExcelExportFooterProps } from './templates/ExcelExportFooter.js';
|
|
15
|
+
import { ExcelExportGroupFooter, ExcelExportGroupFooterProps } from './templates/ExcelExportGroupFooter.js';
|
|
16
|
+
import { ExcelExportGroupHeader, ExcelExportGroupHeaderProps } from './templates/ExcelExportGroupHeader.js';
|
|
17
|
+
import * as KendoOoxml from '@progress/kendo-ooxml';
|
|
18
|
+
export { ExcelExport, ExcelExportData, ExcelExportProps, ExcelExportExportEvent, ExcelExportColumnGroup, ExcelExportColumnGroupProps, ExcelExportFooter, ExcelExportFooterProps, ExcelExportColumn, ExcelExportColumnProps, ColumnBase, ExcelExportGroupFooter, ExcelExportGroupFooterProps, ExcelExportGroupHeader, ExcelExportGroupHeaderProps, CellOptions, KendoOoxml };
|
|
19
|
+
export * from './ooxml/workbook.js';
|
|
@@ -0,0 +1,83 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @license
|
|
3
|
+
*-------------------------------------------------------------------------------------------
|
|
4
|
+
* Copyright © 2026 Progress Software Corporation. All rights reserved.
|
|
5
|
+
* Licensed under commercial license. See LICENSE.md in the package root for more information
|
|
6
|
+
*-------------------------------------------------------------------------------------------
|
|
7
|
+
*/
|
|
8
|
+
import { WorkbookSheetRowCellBorderBottom, WorkbookSheetRowCellBorderLeft, WorkbookSheetRowCellBorderTop, WorkbookSheetRowCellBorderRight } from '@progress/kendo-ooxml';
|
|
9
|
+
/**
|
|
10
|
+
* The options for the Excel Export cell.
|
|
11
|
+
*/
|
|
12
|
+
export interface CellOptions {
|
|
13
|
+
/**
|
|
14
|
+
* Sets the background color of the cell. Supports hex CSS-like values that start with `"#"`. For example, `"#ff00ff"`.
|
|
15
|
+
*/
|
|
16
|
+
background?: string;
|
|
17
|
+
/**
|
|
18
|
+
* The style information for the bottom border of the cell.
|
|
19
|
+
*/
|
|
20
|
+
borderBottom?: WorkbookSheetRowCellBorderBottom;
|
|
21
|
+
/**
|
|
22
|
+
* The style information for the left border of the cell.
|
|
23
|
+
*/
|
|
24
|
+
borderLeft?: WorkbookSheetRowCellBorderLeft;
|
|
25
|
+
/**
|
|
26
|
+
* The style information for the top border of the cell.
|
|
27
|
+
*/
|
|
28
|
+
borderTop?: WorkbookSheetRowCellBorderTop;
|
|
29
|
+
/**
|
|
30
|
+
* The style information for the right border of the cell.
|
|
31
|
+
*/
|
|
32
|
+
borderRight?: WorkbookSheetRowCellBorderRight;
|
|
33
|
+
/**
|
|
34
|
+
* If set to `true`, renders the cell value in bold.
|
|
35
|
+
*/
|
|
36
|
+
bold?: boolean;
|
|
37
|
+
/**
|
|
38
|
+
* The text color of the cell. Supports hex CSS-like values that start with `"#"`. For example, `"#ff00ff"`.
|
|
39
|
+
*/
|
|
40
|
+
color?: string;
|
|
41
|
+
/**
|
|
42
|
+
* Sets the font that is used to display the cell value.
|
|
43
|
+
*/
|
|
44
|
+
fontFamily?: string;
|
|
45
|
+
/**
|
|
46
|
+
* Sets the font size in pixels.
|
|
47
|
+
*/
|
|
48
|
+
fontSize?: number;
|
|
49
|
+
/**
|
|
50
|
+
* 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).
|
|
51
|
+
*/
|
|
52
|
+
format?: string;
|
|
53
|
+
/**
|
|
54
|
+
* If set to `true`, renders the cell value in italics.
|
|
55
|
+
*/
|
|
56
|
+
italic?: boolean;
|
|
57
|
+
/**
|
|
58
|
+
* Sets the horizontal alignment of the cell value.
|
|
59
|
+
*
|
|
60
|
+
* The supported values are:
|
|
61
|
+
* * `"left"`
|
|
62
|
+
* * `"center"`
|
|
63
|
+
* * `"right"`
|
|
64
|
+
*/
|
|
65
|
+
textAlign?: 'left' | 'center' | 'right';
|
|
66
|
+
/**
|
|
67
|
+
* If set to `true`, underlines the cell value.
|
|
68
|
+
*/
|
|
69
|
+
underline?: boolean;
|
|
70
|
+
/**
|
|
71
|
+
* If set to `true`, wraps the cell value.
|
|
72
|
+
*/
|
|
73
|
+
wrap?: boolean;
|
|
74
|
+
/**
|
|
75
|
+
* Sets the vertical alignment of the cell value.
|
|
76
|
+
*
|
|
77
|
+
* The supported values are:
|
|
78
|
+
* * `"top"`
|
|
79
|
+
* * `"center"`
|
|
80
|
+
* * `"bottom"`
|
|
81
|
+
*/
|
|
82
|
+
verticalAlign?: 'top' | 'center' | 'bottom';
|
|
83
|
+
}
|
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @license
|
|
3
|
+
*-------------------------------------------------------------------------------------------
|
|
4
|
+
* Copyright © 2026 Progress Software Corporation. All rights reserved.
|
|
5
|
+
* Licensed under commercial license. See LICENSE.md in the package root for more information
|
|
6
|
+
*-------------------------------------------------------------------------------------------
|
|
7
|
+
*/
|
|
8
|
+
import { CellOptions } from './CellOptionsInterface.js';
|
|
9
|
+
import { ExcelExportColumnProps } from '../ExcelExportColumn.js';
|
|
10
|
+
/**
|
|
11
|
+
* @hidden
|
|
12
|
+
*/
|
|
13
|
+
export declare const toExporterColumns: (sourceColumns?: ExcelExportColumnProps[]) => ExporterColumn[];
|
|
14
|
+
/**
|
|
15
|
+
* @hidden
|
|
16
|
+
*/
|
|
17
|
+
export declare class ExporterColumn {
|
|
18
|
+
title?: string;
|
|
19
|
+
field?: string;
|
|
20
|
+
hidden?: boolean;
|
|
21
|
+
locked?: boolean;
|
|
22
|
+
width?: number;
|
|
23
|
+
columns: ExporterColumn[] | null;
|
|
24
|
+
groupHeaderTemplate: any;
|
|
25
|
+
groupFooterTemplate: any;
|
|
26
|
+
footerTemplate: any;
|
|
27
|
+
headerCellOptions?: CellOptions;
|
|
28
|
+
cellOptions?: CellOptions;
|
|
29
|
+
groupHeaderCellOptions?: CellOptions;
|
|
30
|
+
groupFooterCellOptions?: CellOptions;
|
|
31
|
+
footerCellOptions?: CellOptions;
|
|
32
|
+
constructor(column: ExcelExportColumnProps, columnIndex?: number);
|
|
33
|
+
}
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @license
|
|
3
|
+
*-------------------------------------------------------------------------------------------
|
|
4
|
+
* Copyright © 2026 Progress Software Corporation. All rights reserved.
|
|
5
|
+
* Licensed under commercial license. See LICENSE.md in the package root for more information
|
|
6
|
+
*-------------------------------------------------------------------------------------------
|
|
7
|
+
*/
|
|
8
|
+
import { WorkbookOptions } from '@progress/kendo-ooxml';
|
|
9
|
+
import { ExcelExportProps } from '../ExcelExport.js';
|
|
10
|
+
/**
|
|
11
|
+
* @hidden
|
|
12
|
+
*/
|
|
13
|
+
export declare const workbookOptions: (options: ExcelExportProps) => WorkbookOptions;
|
|
14
|
+
/**
|
|
15
|
+
* @hidden
|
|
16
|
+
*/
|
|
17
|
+
export declare const toDataURL: (options: WorkbookOptions) => Promise<string>;
|
|
18
|
+
/**
|
|
19
|
+
* @hidden
|
|
20
|
+
*/
|
|
21
|
+
export declare const isWorkbookOptions: (value: any) => boolean;
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @license
|
|
3
|
+
*-------------------------------------------------------------------------------------------
|
|
4
|
+
* Copyright © 2026 Progress Software Corporation. All rights reserved.
|
|
5
|
+
* Licensed under commercial license. See LICENSE.md in the package root for more information
|
|
6
|
+
*-------------------------------------------------------------------------------------------
|
|
7
|
+
*/
|
|
8
|
+
import { PackageMetadata } from '@progress/kendo-licensing';
|
|
9
|
+
/**
|
|
10
|
+
* @hidden
|
|
11
|
+
*/
|
|
12
|
+
export declare const packageMetadata: PackageMetadata;
|
package/package-metadata.js
CHANGED
|
@@ -5,4 +5,4 @@
|
|
|
5
5
|
* Licensed under commercial license. See LICENSE.md in the package root for more information
|
|
6
6
|
*-------------------------------------------------------------------------------------------
|
|
7
7
|
*/
|
|
8
|
-
"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const e=Object.freeze({name:"@progress/kendo-react-excel-export",productName:"KendoReact",productCode:"KENDOUIREACT",productCodes:["KENDOUIREACT"],publishDate:
|
|
8
|
+
"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const e=Object.freeze({name:"@progress/kendo-react-excel-export",productName:"KendoReact",productCode:"KENDOUIREACT",productCodes:["KENDOUIREACT"],publishDate: 1770219084,version:"13.4.0-develop.1",licensingDocsUrl:"https://www.telerik.com/kendo-react-ui/components/my-license/"});exports.packageMetadata=e;
|
package/package-metadata.mjs
CHANGED
|
@@ -1,19 +1,13 @@
|
|
|
1
|
+
// Generated file. DO NOT EDIT.
|
|
1
2
|
/**
|
|
2
|
-
* @
|
|
3
|
-
*-------------------------------------------------------------------------------------------
|
|
4
|
-
* Copyright © 2026 Progress Software Corporation. All rights reserved.
|
|
5
|
-
* Licensed under commercial license. See LICENSE.md in the package root for more information
|
|
6
|
-
*-------------------------------------------------------------------------------------------
|
|
3
|
+
* @hidden
|
|
7
4
|
*/
|
|
8
|
-
const
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
5
|
+
export const packageMetadata = Object.freeze({
|
|
6
|
+
name: '@progress/kendo-react-excel-export',
|
|
7
|
+
productName: 'KendoReact',
|
|
8
|
+
productCode: 'KENDOUIREACT',
|
|
9
|
+
productCodes: ['KENDOUIREACT'],
|
|
10
|
+
publishDate: 0,
|
|
11
|
+
version: '13.4.0-develop.1',
|
|
12
|
+
licensingDocsUrl: 'https://www.telerik.com/kendo-react-ui/components/my-license/'
|
|
16
13
|
});
|
|
17
|
-
export {
|
|
18
|
-
e as packageMetadata
|
|
19
|
-
};
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@progress/kendo-react-excel-export",
|
|
3
|
-
"version": "13.
|
|
3
|
+
"version": "13.4.0-develop.1",
|
|
4
4
|
"description": "React Excel export helps you export and save data to Excel files and customize or filter the output. KendoReact Excel Export package",
|
|
5
5
|
"author": "Progress",
|
|
6
6
|
"license": "SEE LICENSE IN LICENSE.md",
|
|
@@ -27,7 +27,7 @@
|
|
|
27
27
|
"peerDependencies": {
|
|
28
28
|
"@progress/kendo-licensing": "^1.7.2",
|
|
29
29
|
"@progress/kendo-data-query": "^1.7.2",
|
|
30
|
-
"@progress/kendo-react-common": "13.
|
|
30
|
+
"@progress/kendo-react-common": "13.4.0-develop.1",
|
|
31
31
|
"react": "^16.8.2 || ^17.0.0 || ^18.0.0 || ^19.0.0 || ^19.0.0-rc",
|
|
32
32
|
"react-dom": "^16.8.2 || ^17.0.0 || ^18.0.0 || ^19.0.0 || ^19.0.0-rc"
|
|
33
33
|
},
|
|
@@ -55,7 +55,7 @@
|
|
|
55
55
|
"package": {
|
|
56
56
|
"productName": "KendoReact",
|
|
57
57
|
"productCode": "KENDOUIREACT",
|
|
58
|
-
"publishDate":
|
|
58
|
+
"publishDate": 1770219084,
|
|
59
59
|
"licensingDocsUrl": "https://www.telerik.com/kendo-react-ui/components/my-license/"
|
|
60
60
|
}
|
|
61
61
|
},
|