primereact 9.2.3 → 9.3.1

package/datatable/datatable.d.ts

@@ -10,6 +10,7 @@
 import * as React from 'react';
 import { Column, ColumnProps } from '../column';
 import { PaginatorTemplate } from '../paginator';
+import { IconType } from '../utils/utils';
 import { VirtualScroller, VirtualScrollerProps } from '../virtualscroller/virtualscroller';
 
 type DataTableHeaderTemplateType<TValue extends DataTableValueArray> = React.ReactNode | ((options: DataTableHeaderTemplateOptions<TValue>) => React.ReactNode);
@@ -276,9 +277,25 @@ interface DataTableDataSelectableEvent<TValue extends DataTableValueArray> {
     index: number;
 }
 
+/**
+ * Custom selection change event for context menu.
+ * @see {@link DataTableProps.onContextMenuSelectionChange}
+ * @event
+ */
+interface DataTableContextMenuSelectionChangeEvent<TValue extends DataTableValueArray> {
+    /**
+     * Browser event.
+     */
+    originalEvent: React.SyntheticEvent;
+    /**
+     * Selection object.
+     */
+    value: DataTableSelection<TValue>;
+}
+
 /**
  * Custom selection change event.
- * @see {@link DataTableProps.onContextMenuSelectionChange}, {@link DataTableProps.onSelectionChange}
+ * @see {@link DataTableProps.onSelectionChange}
  * @event
  */
 interface DataTableSelectionChangeEvent<TValue extends DataTableValueArray> {
@@ -706,6 +723,10 @@ export interface DataTableProps<TValue extends DataTableValueArray> extends Omit
      * @defaultValue 960px
      */
     breakpoint?: string | undefined;
+    /**
+     * Icon to display in the checkbox.
+     */
+    checkIcon?: IconType<DataTableProps<TValue>> | undefined;
     /**
      * Whether to cell selection is enabled or not.
      * @defaultValue false
@@ -717,9 +738,8 @@ export interface DataTableProps<TValue extends DataTableValueArray> extends Omit
     className?: string | undefined;
     /**
      * Icon of the row toggler to display the row as collapsed.
-     * @defaultValue pi pi-chevron-up
      */
-    collapsedRowIcon?: string | undefined;
+    collapsedRowIcon?: IconType<DataTableProps<TValue>> | undefined;
     /**
      * Used to define the resize mode of the columns, valid values are "fit" and "expand".
      * @defaultValue fit
@@ -779,9 +799,8 @@ export interface DataTableProps<TValue extends DataTableValueArray> extends Omit
     expandableRowGroups?: boolean | undefined;
     /**
      * Icon of the row toggler to display the row as expanded.
-     * @defaultValue pi pi-chevron-down
      */
-    expandedRowIcon?: string | undefined;
+    expandedRowIcon?: IconType<DataTableProps<TValue>> | undefined;
     /**
      * A collection of rows or a map object row data keys that are expanded.
      */
@@ -868,9 +887,8 @@ export interface DataTableProps<TValue extends DataTableValueArray> extends Omit
     loading?: boolean | undefined;
     /**
      * The icon to show while indicating data load is in progress.
-     * @defaultValue pi pi-spinner
      */
-    loadingIcon?: string | undefined;
+    loadingIcon?: IconType<DataTableProps<TValue>> | undefined;
     /**
      * Defines whether metaKey is requred or not for the selection. When true metaKey needs to be pressed to select or unselect an item and when set to false selection of each item can be toggled individually. On touch enabled devices, metaKeySelection is turned off automatically.
      * @defaultValue true
@@ -932,6 +950,14 @@ export interface DataTableProps<TValue extends DataTableValueArray> extends Omit
      * @defaultValue false
      */
     reorderableRows?: boolean | undefined;
+    /**
+     * Defines the reorder indicator down icon.
+     */
+    reorderIndicatorDownIcon?: IconType<DataTableProps<TValue>> | undefined;
+    /**
+     * Defines the reorder indicator up icon.
+     */
+    reorderIndicatorUpIcon?: IconType<DataTableProps<TValue>> | undefined;
     /**
      * When enabled, columns can be resized using drag and drop.
      * @defaultValue false
@@ -943,6 +969,18 @@ export interface DataTableProps<TValue extends DataTableValueArray> extends Omit
      * @deprecated since version 9.2.0
      */
     responsiveLayout?: 'scroll' | 'stack' | undefined;
+    /**
+     * Icon to display in the row editor cancel button.
+     */
+    rowEditorCancelIcon?: IconType<DataTableProps<TValue>> | undefined;
+    /**
+     * Icon to display in the row editor init button.
+     */
+    rowEditorInitIcon?: IconType<DataTableProps<TValue>> | undefined;
+    /**
+     * Icon to display in the row editor save button.
+     */
+    rowEditorSaveIcon?: IconType<DataTableProps<TValue>> | undefined;
     /**
      * Function to provide the content of row group footer.
      */
@@ -1032,6 +1070,10 @@ export interface DataTableProps<TValue extends DataTableValueArray> extends Omit
      * @defaultValue single
      */
     sortMode?: 'single' | 'multiple' | undefined;
+    /**
+     * Icon to display the current sorting status.
+     */
+    sortIcon?: IconType<DataTable<TValue>> | undefined;
     /**
      * Order to sort the data by default.
      */
@@ -1157,7 +1199,7 @@ export interface DataTableProps<TValue extends DataTableValueArray> extends Omit
      * Callback to invoke when a row selected with right click.
      * @param {DataTableRowEvent} event - Custom row event.
      */
-    onContextMenuSelectionChange?(event: DataTableSelectionChangeEvent<TValue>): void;
+    onContextMenuSelectionChange?(event: DataTableContextMenuSelectionChangeEvent<TValue>): void;
     /**
      * Callback to invoke on filtering.
      * @param {DataTableStateEvent} event - Custom state event.