@progress/kendo-react-data-tools 12.0.2-develop.1 → 12.0.2-develop.3

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/index.d.ts CHANGED
@@ -107,7 +107,7 @@ export declare interface CellProps {
107
107
  */
108
108
  id: string;
109
109
  /**
110
- * The index to be applied to the `aria-colindex` attribute.
110
+ * The index applied to the `aria-colindex` attribute.
111
111
  */
112
112
  ariaColumnIndex: number;
113
113
  /**
@@ -127,30 +127,29 @@ export declare interface CellProps {
127
127
  */
128
128
  isAlt?: boolean;
129
129
  /**
130
- * The expanded value of the cell.
130
+ * Indicates if the cell is expanded.
131
131
  */
132
132
  expanded?: boolean;
133
133
  /**
134
- * The custom CSS classes of the cells.
134
+ * Custom CSS classes for the cell.
135
135
  */
136
136
  className?: string;
137
137
  /**
138
- * The styles for the cell.
138
+ * Inline styles for the cell.
139
139
  */
140
140
  style?: React_2.CSSProperties;
141
141
  /**
142
- * The field to which the cell is bound.
142
+ * The data field that the cell binds to.
143
143
  */
144
144
  field?: string;
145
145
  /**
146
- * The data item which corresponds to the current row.
146
+ * The data item for the current row.
147
147
  */
148
148
  dataItem: any;
149
149
  /**
150
- * The format that is applied to the value before the value is displayed.
150
+ * The format applied to the value before display.
151
151
  * Takes the `{0:format}` form where `format` is a standard number format, a custom number format,
152
- * a standard date format, or a custom date format. For more information on the supported date and number formats,
153
- * refer to the [kendo-intl](https://github.com/telerik/kendo-intl/blob/develop/docs/index.md) documentation.
152
+ * a standard date format, or a custom date format.
154
153
  */
155
154
  format?: string;
156
155
  /**
@@ -158,13 +157,13 @@ export declare interface CellProps {
158
157
  */
159
158
  colSpan?: number;
160
159
  /**
161
- * The event that is fired when the cell is selected.
160
+ * Fires when the cell is selected.
162
161
  */
163
162
  selectionChange?: (event: {
164
163
  syntheticEvent: React_2.SyntheticEvent<any>;
165
164
  }) => void;
166
165
  /**
167
- * The event that is fired when the cell value is changed.
166
+ * Fires when the cell value changes.
168
167
  */
169
168
  onChange?: (event: {
170
169
  dataItem: any;
@@ -173,7 +172,7 @@ export declare interface CellProps {
173
172
  value?: any;
174
173
  }) => void;
175
174
  /**
176
- * A function for overriding the default rendering of the cell.
175
+ * Overrides the default cell rendering.
177
176
  */
178
177
  render?: (defaultRendering: React_2.ReactElement<HTMLTableCellElement> | null, props: CellProps) => React_2.ReactElement<HTMLTableCellElement> | null;
179
178
  }
@@ -303,69 +302,73 @@ export declare const closestTagName: (target: HTMLElement | null, tagName: 'TD'
303
302
 
304
303
  export declare interface ColumnBaseProps<C = CellProps> {
305
304
  /**
306
- * The field to which the column is bound.
305
+ * Sets the data field that the column binds to.
307
306
  */
308
307
  field?: string;
309
308
  /**
310
- * The title of the column.
309
+ * Sets the column header text.
311
310
  */
312
311
  title?: string;
313
312
  /**
314
- * Allows the column headers to be clicked and the `sortChange` event emitted.
315
- * You have to handle the `sortChange` event yourself and sort the data.
316
- * Defaults to `true`.
313
+ * Enables header click to emit the `sortChange` event. Handle `sortChange` to sort the data.
314
+ *
315
+ * @default true
317
316
  */
318
317
  sortable?: boolean | ColumnSortSettings;
319
318
  /**
320
- * The width of the column (in pixels).
319
+ * Sets the width of the column (in pixels).
321
320
  */
322
321
  width?: string | number;
323
322
  /**
324
- * Defines if the header selection checkbox is checked.
323
+ * Indicates that the header selection checkbox is checked when `true`.
325
324
  */
326
325
  headerSelectionValue?: boolean;
327
326
  /**
328
- * The format that is applied to the value before it is displayed.
327
+ * Applies a format to the value before display.
329
328
  * Takes the `{0:format}` form where `format` is a standard number format, a custom number format,
330
- * a standard date format, or a custom date format. For more information on the supported date and number formats,
331
- * refer to the [kendo-intl](https://github.com/telerik/kendo-intl/blob/develop/docs/index.md) documentation.
329
+ * a standard date format, or a custom date format. For more information on supported formats see the
330
+ * [kendo-intl](https://github.com/telerik/kendo-intl/blob/develop/docs/index.md) documentation.
332
331
  */
333
332
  format?: string;
334
333
  /**
335
- * Sets the custom CSS classes to the column header cell.
334
+ * Sets custom CSS classes on the header cell.
336
335
  */
337
336
  headerClassName?: string;
338
337
  /**
339
- * Sets the custom CSS classes to the column cells.
338
+ * Sets custom CSS classes on the column cells.
340
339
  */
341
340
  className?: string;
342
341
  /**
343
- * Indicates whether the column is resizable.
342
+ * Enables column resizing when `true`.
343
+ *
344
+ * @default true
344
345
  */
345
346
  resizable?: boolean;
346
347
  /**
347
- * Indicates whether the column is reorderable.
348
+ * Enables column reordering when `true`.
349
+ *
350
+ * @default true
348
351
  */
349
352
  reorderable?: boolean;
350
353
  /**
351
- * The width of the column (in pixels) below which the user is not able to resize the column through the UI. Defaults to `10`.
354
+ * Sets the minimum resize width (in pixels).
355
+ *
356
+ * @default 10
352
357
  */
353
358
  minResizableWidth?: number;
354
359
  /**
355
- * Determinates the position of the column.
356
- * Columns with smaller `orderIndex` will appear before columns with bigger `orderIndex`.
357
- * Defaults to `0`.
360
+ * Determines the column position. Smaller `orderIndex` values render first.
361
+ *
362
+ * @default 0
358
363
  */
359
364
  orderIndex?: number;
360
365
  /**
361
- * The column identifier used to distinguish columns for example in multi column header scenarios with resize and keyboard navigation.
362
- * Also used for unique key for rendering the component cells.
363
- * If not set, the component will generate unique `id` automatically.
366
+ * Sets the column id for distinguishing columns (multi header, resize, or keyboard navigation scenarios).
367
+ * Also used as the unique key for rendering cells. If not set, a unique id is generated.
364
368
  */
365
369
  id?: string;
366
370
  /**
367
- * Defines the component that will be rendered as a cell.
368
- * If not set, a `Cell` will be rendered by default.
371
+ * Defines the component rendered as a cell. If not set, a `Cell` renders.
369
372
  */
370
373
  cell?: ComponentType<C>;
371
374
  /**
@@ -402,14 +405,14 @@ declare interface ColumnDraggableProps {
402
405
  }
403
406
 
404
407
  /**
405
- * The `ColumnMenuBooleanColumn` component. Use it for `boolean` type columns.
408
+ * Represents the ColumnMenuBooleanColumn component. Use it for `boolean` type columns.
406
409
  */
407
410
  export declare const ColumnMenuBooleanColumn: React_2.FunctionComponent<ColumnMenuProps>;
408
411
 
409
412
  export declare const ColumnMenuBooleanFilter: React_2.FunctionComponent<ColumnMenuFilterProps>;
410
413
 
411
414
  /**
412
- * The `ColumnMenuDateColumn` component. Use it for `Date` type columns.
415
+ * Represents the ColumnMenuDateColumn component. Use it for `Date` type columns.
413
416
  */
414
417
  export declare const ColumnMenuDateColumn: React_2.FunctionComponent<ColumnMenuProps>;
415
418
 
@@ -423,13 +426,18 @@ export declare const ColumnMenuFilterForm: React_2.FunctionComponent<ColumnMenuF
423
426
  export declare const ColumnMenuFilterLogic: React_2.FunctionComponent<DropDownListProps>;
424
427
 
425
428
  export declare interface ColumnMenuFilterProps {
429
+ /** The current filter descriptor for the column */
426
430
  filter: FilterDescriptor;
431
+ /** Event handler for filter changes */
427
432
  onFilterChange: (event: React_2.SyntheticEvent<any>, nextFilter: FilterDescriptor, prevFilter: FilterDescriptor) => void;
433
+ /** Available filter operators for the column */
428
434
  operators?: {
429
435
  text: string;
430
436
  operator: string;
431
437
  }[];
438
+ /** Initial filter descriptor when creating a new filter */
432
439
  initialFilter?: FilterDescriptor;
440
+ /** Custom input component for filter value entry */
433
441
  input?: React_2.ComponentType<{
434
442
  value: any;
435
443
  onChange: any;
@@ -439,26 +447,52 @@ export declare interface ColumnMenuFilterProps {
439
447
  export declare const ColumnMenuForm: React_2.FunctionComponent<ColumnMenuFormProps>;
440
448
 
441
449
  export declare interface ColumnMenuFormProps {
450
+ /** Whether to show the form */
442
451
  show?: boolean;
452
+ /** Event handler for form submission */
443
453
  onSubmit?: React_2.FormEventHandler<HTMLFormElement>;
454
+ /** Event handler for form reset */
444
455
  onReset?: React_2.FormEventHandler<HTMLFormElement>;
456
+ /** Action buttons or custom action elements */
445
457
  actions?: React_2.ReactNode;
458
+ /** Form content and child elements */
446
459
  children?: React_2.ReactNode;
447
460
  }
448
461
 
449
462
  export declare const ColumnMenuItem: React_2.FunctionComponent<ColumnMenuItemProps>;
450
463
 
464
+ /**
465
+ * Defines the props of the ColumnMenuItem component.
466
+ */
451
467
  export declare interface ColumnMenuItemProps {
468
+ /**
469
+ * Fires when the item is clicked.
470
+ */
452
471
  onClick?: (event: React_2.MouseEvent<HTMLDivElement>) => void;
472
+ /**
473
+ * Indicates that the item is selected when `true`.
474
+ */
453
475
  selected?: boolean;
476
+ /**
477
+ * Disables the item when `true`.
478
+ */
454
479
  disabled?: boolean;
480
+ /**
481
+ * Sets the font icon CSS class.
482
+ */
455
483
  iconClass?: string;
484
+ /**
485
+ * Sets the SVG icon definition.
486
+ */
456
487
  svgIcon?: SVGIcon;
488
+ /**
489
+ * Sets the item title text.
490
+ */
457
491
  title: string;
458
492
  }
459
493
 
460
494
  /**
461
- * The `ColumnMenuNumericColumn` component. Use it for `number` type columns.
495
+ * Represents the ColumnMenuNumericColumn component. Use it for `number` type columns.
462
496
  */
463
497
  export declare const ColumnMenuNumericColumn: React_2.FunctionComponent<ColumnMenuProps>;
464
498
 
@@ -530,69 +564,73 @@ export declare class ColumnMenuOperators {
530
564
  }
531
565
 
532
566
  /**
533
- * The props of the ColumnMenu component.
567
+ * Defines the props of the ColumnMenu component.
534
568
  */
535
569
  export declare interface ColumnMenuProps {
536
570
  /**
537
- * The descriptors by which the data is sorted.
571
+ * Sets the `SortDescriptor[]` applied to the data.
538
572
  */
539
573
  sort?: SortDescriptor[];
540
574
  /**
541
- * Fires when the sorting of the ColumnMenu is changed.
575
+ * Fires when sorting changes. Receives the browser event, the new `SortDescriptor[]`, and the column `field`.
542
576
  */
543
577
  onSortChange?: (event: React_2.SyntheticEvent<any>, sort: SortDescriptor[], field: string) => void;
544
578
  /**
545
- * The descriptors by which the data is filtered.
579
+ * Sets the `CompositeFilterDescriptor[]` applied to the data.
546
580
  */
547
581
  filter?: CompositeFilterDescriptor[];
548
582
  /**
549
- * Fires when the ColumnMenu filter is changed.
583
+ * Fires when filtering changes. Receives the browser event, the new `CompositeFilterDescriptor[]`, and the column `field`.
550
584
  */
551
585
  onFilterChange?: (event: React_2.SyntheticEvent<any>, filter: CompositeFilterDescriptor[], field: string) => void;
552
586
  /**
553
- * The field to which the ColumnMenu is bound.
587
+ * Sets the column `field` the menu operates on.
554
588
  */
555
589
  field?: string;
556
590
  /**
557
- * If set to `true`, a button for sorting in `asc` direction will be rendered.
591
+ * Shows the ascending sort button when `true`.
592
+ *
593
+ * @default false
558
594
  */
559
595
  sortAsc?: boolean;
560
596
  /**
561
- * If set to `true`, a button for sorting in `desc` direction will be rendered.
597
+ * Shows the descending sort button when `true`.
598
+ *
599
+ * @default false
562
600
  */
563
601
  sortDesc?: boolean;
564
602
  /**
565
- * Defines the filtering UI and accepts an array with components.
603
+ * Provides the filtering UI components in render order. Supply up to three components: first filter, logic, second filter.
566
604
  */
567
605
  filterContent?: any[];
568
606
  /**
569
- * Defines the initial expand state of the filters.
570
- * Defaults to `false`.
607
+ * Sets the initial expand state of the filters.
608
+ *
609
+ * @default false
571
610
  */
572
611
  expandFilters?: boolean;
573
612
  /**
574
- * A function that returns the initial filter descriptor base on the ColumnMenu field.
575
- * Use it to customize the initial values of the filtering components.
613
+ * Returns the initial `CompositeFilterDescriptor` based on the current `field`. Use to customize starting filter values.
576
614
  */
577
615
  initialFilter?: (field: string) => CompositeFilterDescriptor;
578
616
  /**
579
- * Fires when the ColumnMenu items are about to be rendered. Use it to add or remove menu items.
580
- * The `defaultRendering` is an array with the sorting and filtering components.
581
- * `props` contains the column's field and the closeMenu function which closes the ColumnMenu.
617
+ * Fires before the ColumnMenu items render. Use to add or remove items.
618
+ * `defaultRendering` holds sorting and filtering elements.
619
+ * `props` exposes the column `field` and `closeMenu()` helper.
582
620
  */
583
621
  itemsRender?: (defaultRendering: (React_2.ReactElement<HTMLDivElement> | null)[], props: {
584
622
  field?: string;
585
623
  closeMenu: () => void;
586
624
  }) => React_2.ReactNode;
587
625
  /**
588
- * Fires when the ColumnMenu is about to be rendered. Use it to override the default rendering of the ColumnMenu.
589
- * The defaultRendering is an array with the button `React.ReactElement<HTMLSpanElement>` and popup `React.ReactElement<PopupProps>` components.
626
+ * Fires before the ColumnMenu renders. Use to override the entire rendering.
627
+ * `defaultRendering` contains the menu button and popup elements (and license watermark when present).
590
628
  */
591
629
  render?: (defaultRendering: React_2.ReactElement<any>[]) => React_2.ReactNode;
592
630
  }
593
631
 
594
632
  /**
595
- * The `ColumnMenuTextColumn` component. Use it for `string` type columns.
633
+ * Represents the ColumnMenuTextColumn component. Use it for `string` type columns.
596
634
  */
597
635
  export declare const ColumnMenuTextColumn: React_2.FunctionComponent<ColumnMenuProps>;
598
636
 
@@ -1795,19 +1833,33 @@ export declare const HeaderTdElement: {
1795
1833
  };
1796
1834
 
1797
1835
  export declare interface HeaderTdElementProps extends React_2.TdHTMLAttributes<HTMLTableCellElement> {
1836
+ /** ARIA sort state indicating column sorting direction */
1798
1837
  ariaSort?: 'none' | 'ascending' | 'descending';
1838
+ /** ARIA label for accessibility */
1799
1839
  ariaLabel?: string;
1840
+ /** ARIA column index for screen readers */
1800
1841
  ariaColumnIndex?: number;
1842
+ /** ARIA selected state for the header cell */
1801
1843
  ariaSelected?: boolean;
1844
+ /** ARIA description for additional context */
1802
1845
  ariaDescription?: string;
1846
+ /** Number of columns the cell spans */
1803
1847
  colSpan?: number;
1848
+ /** Number of rows the cell spans */
1804
1849
  rowSpan?: number;
1850
+ /** ARIA role for the element */
1805
1851
  role?: string;
1852
+ /** Unique identifier for the column */
1806
1853
  columnId: string;
1854
+ /** CSS class names for styling */
1807
1855
  className?: string;
1856
+ /** Inline styles for the element */
1808
1857
  style?: any;
1858
+ /** Child elements to render inside the header cell */
1809
1859
  children?: any;
1860
+ /** Keyboard event handler */
1810
1861
  onKeyDown?: any;
1862
+ /** Whether the cell supports keyboard navigation */
1811
1863
  navigatable?: boolean;
1812
1864
  }
1813
1865
 
@@ -1817,19 +1869,33 @@ export declare const HeaderThElement: {
1817
1869
  };
1818
1870
 
1819
1871
  export declare interface HeaderThElementProps extends React_2.ThHTMLAttributes<HTMLTableCellElement> {
1872
+ /** ARIA sort state indicating column sorting direction */
1820
1873
  ariaSort?: 'none' | 'ascending' | 'descending';
1874
+ /** ARIA label for accessibility */
1821
1875
  ariaLabel?: string;
1876
+ /** ARIA column index for screen readers */
1822
1877
  ariaColumnIndex?: number;
1878
+ /** ARIA selected state for the header cell */
1823
1879
  ariaSelected?: boolean;
1880
+ /** ARIA description for additional context */
1824
1881
  ariaDescription?: string;
1882
+ /** Number of columns the cell spans */
1825
1883
  colSpan?: number;
1884
+ /** Number of rows the cell spans */
1826
1885
  rowSpan?: number;
1886
+ /** ARIA role for the element */
1827
1887
  role?: string;
1888
+ /** Unique identifier for the column */
1828
1889
  columnId: string;
1890
+ /** CSS class names for styling */
1829
1891
  className?: string;
1892
+ /** Inline styles for the element */
1830
1893
  style?: any;
1894
+ /** Child elements to render inside the header cell */
1831
1895
  children?: any;
1896
+ /** Keyboard event handler */
1832
1897
  onKeyDown?: any;
1898
+ /** Whether the cell supports keyboard navigation */
1833
1899
  navigatable?: boolean;
1834
1900
  }
1835
1901
 
@@ -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-data-tools",productName:"KendoReact",productCode:"KENDOUIREACT",productCodes:["KENDOUIREACT"],publishDate: 1756967076,version:"12.0.2-develop.1",licensingDocsUrl:"https://www.telerik.com/kendo-react-ui/components/my-license/"});exports.packageMetadata=e;
8
+ "use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const e=Object.freeze({name:"@progress/kendo-react-data-tools",productName:"KendoReact",productCode:"KENDOUIREACT",productCodes:["KENDOUIREACT"],publishDate: 1757419579,version:"12.0.2-develop.3",licensingDocsUrl:"https://www.telerik.com/kendo-react-ui/components/my-license/"});exports.packageMetadata=e;
@@ -10,8 +10,8 @@ const e = Object.freeze({
10
10
  productName: "KendoReact",
11
11
  productCode: "KENDOUIREACT",
12
12
  productCodes: ["KENDOUIREACT"],
13
- publishDate: 1756967076,
14
- version: "12.0.2-develop.1",
13
+ publishDate: 1757419579,
14
+ version: "12.0.2-develop.3",
15
15
  licensingDocsUrl: "https://www.telerik.com/kendo-react-ui/components/my-license/"
16
16
  });
17
17
  export {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@progress/kendo-react-data-tools",
3
- "version": "12.0.2-develop.1",
3
+ "version": "12.0.2-develop.3",
4
4
  "description": "Includes React Pager & React Filter component, an intuitive interface to create complex filter descriptions. KendoReact Data Tools package",
5
5
  "author": "Progress",
6
6
  "license": "SEE LICENSE IN LICENSE.md",
@@ -28,14 +28,14 @@
28
28
  "@progress/kendo-data-query": "^1.0.0",
29
29
  "@progress/kendo-drawing": "^1.21.2",
30
30
  "@progress/kendo-licensing": "^1.7.0",
31
- "@progress/kendo-react-animation": "12.0.2-develop.1",
32
- "@progress/kendo-react-buttons": "12.0.2-develop.1",
33
- "@progress/kendo-react-common": "12.0.2-develop.1",
34
- "@progress/kendo-react-dateinputs": "12.0.2-develop.1",
35
- "@progress/kendo-react-dropdowns": "12.0.2-develop.1",
36
- "@progress/kendo-react-inputs": "12.0.2-develop.1",
37
- "@progress/kendo-react-intl": "12.0.2-develop.1",
38
- "@progress/kendo-react-popup": "12.0.2-develop.1",
31
+ "@progress/kendo-react-animation": "12.0.2-develop.3",
32
+ "@progress/kendo-react-buttons": "12.0.2-develop.3",
33
+ "@progress/kendo-react-common": "12.0.2-develop.3",
34
+ "@progress/kendo-react-dateinputs": "12.0.2-develop.3",
35
+ "@progress/kendo-react-dropdowns": "12.0.2-develop.3",
36
+ "@progress/kendo-react-inputs": "12.0.2-develop.3",
37
+ "@progress/kendo-react-intl": "12.0.2-develop.3",
38
+ "@progress/kendo-react-popup": "12.0.2-develop.3",
39
39
  "@progress/kendo-svg-icons": "^4.0.0",
40
40
  "react": "^16.8.2 || ^17.0.0 || ^18.0.0 || ^19.0.0 || ^19.0.0-rc",
41
41
  "react-dom": "^16.8.2 || ^17.0.0 || ^18.0.0 || ^19.0.0 || ^19.0.0-rc"
@@ -65,7 +65,7 @@
65
65
  "package": {
66
66
  "productName": "KendoReact",
67
67
  "productCode": "KENDOUIREACT",
68
- "publishDate": 1756967076,
68
+ "publishDate": 1757419579,
69
69
  "licensingDocsUrl": "https://www.telerik.com/kendo-react-ui/components/my-license/"
70
70
  }
71
71
  },