primereact 6.5.0 → 7.0.0-rc.1

package/datatable/datatable.d.ts

@@ -1,6 +1,15 @@
 import * as React from 'react';
-import { ColumnProps } from '../column';
+import { Column } from '../column';
 import { PaginatorTemplate } from '../paginator';
+import { VirtualScrollerProps } from '../virtualscroller/virtualscroller';
+
+type DataTableHeaderTemplateType = React.ReactNode | ((options: DataTableHeaderTemplateOptions) => React.ReactNode);
+
+type DataTableFooterTemplateType = React.ReactNode | ((options: DataTableFooterTemplateOptions) => React.ReactNode);
+
+type DataTableRowGroupHeaderTemplateType = React.ReactNode | ((data: any, options: DataTableRowGroupHeaderTemplateOptions) => React.ReactNode);
+
+type DataTableRowGroupFooterTemplateType = React.ReactNode | ((data: any, options: DataTableRowGroupFooterTemplateOptions) => React.ReactNode);
 
 type DataTablePaginatorPositionType = 'top' | 'bottom' | 'both';
 
@@ -14,7 +23,7 @@ type DataTableSelectionModeType = 'single' | 'multiple' | 'checkbox' | 'radiobut
 
 type DataTableColumnResizeModeType = 'fit' | 'expand';
 
-type DataTableFilterMatchModeType = 'startsWith' | 'contains' | 'endsWith' | 'equals' | 'notEquals' | 'in' | 'lt' | 'lte' | 'gt' | 'gte' | 'custom';
+type DataTableFilterMatchModeType = 'startsWith' | 'contains' | 'notContains' | 'endsWith' | 'equals' | 'notEquals' | 'in' | 'lt' | 'lte' | 'gt' | 'gte' | 'between' | 'dateIs' | 'dateIsNot' | 'dateBefore' | 'dateAfter' | 'custom';
 
 type DataTableGlobalFilterType = string | undefined | null;
 
@@ -28,6 +37,29 @@ type DataTableAppendToType = 'self' | HTMLElement | undefined | null;
 
 type DataTableSelectType = 'row' | 'cell' | 'checkbox' | 'radio' | 'all';
 
+type DataTableResponsiveLayoutType = 'scroll' | 'stack';
+
+type DataTableFilterDisplayType = 'menu' | 'row';
+
+type DataTableSizeType = 'small' | 'normal' | 'large';
+
+type DataTableScrollDirectionType = 'vertical' | 'horizontal' | 'both';
+
+interface DataTableHeaderTemplateOptions {
+    props: DataTableProps;
+}
+
+interface DataTableFooterTemplateOptions extends DataTableHeaderTemplateOptions {}
+
+interface DataTableRowGroupHeaderTemplateOptions {
+    index: number;
+    props: DataTableProps;
+}
+
+interface DataTableRowGroupFooterTemplateOptions extends DataTableRowGroupHeaderTemplateOptions {
+    colSpan: number;
+}
+
 interface DataTableSortMeta {
     field: string;
     order: DataTableSortOrderType;
@@ -38,8 +70,13 @@ interface DataTableFilterMetaData {
     matchMode: DataTableFilterMatchModeType;
 }
 
+interface DataTableOperatorFilterMetaData {
+    operator: string;
+    constraints: DataTableFilterMetaData[];
+}
+
 interface DataTableFilterMeta {
-    [key: string]: DataTableFilterMetaData;
+    [key: string]: DataTableFilterMetaData | DataTableOperatorFilterMetaData;
 }
 
 interface DataTableExpandedRows {
@@ -57,25 +94,20 @@ interface DataTablePageParams {
     pageCount: number;
 }
 
-interface DataTableVirtualScrollParams {
-    first: number;
-    rows: number;
-}
-
 interface DataTableRowToggleParams {
     data: any[];
 }
 
 interface DataTableColumnResizeEndParams {
     element: HTMLElement;
-    column: ColumnProps;
+    column: Column;
     delta: number;
 }
 
 interface DataTableColumnResizerClickParams {
     originalEvent: React.MouseEvent<HTMLElement>;
     element: HTMLElement;
-    column: ColumnProps;
+    column: Column;
 }
 
 interface DataTableSortParams {
@@ -122,6 +154,12 @@ interface DataTableRowEditSaveParams extends DataTableRowEditParams {
     valid: boolean;
 }
 
+interface DataTableRowEditCompleteParams extends DataTableRowEventParams {
+    newData: any;
+    field: string;
+    index: number;
+}
+
 interface DataTableSelectParams {
     originalEvent: React.SyntheticEvent;
     data: any;
@@ -149,11 +187,38 @@ interface DataTableRowReorderParams {
     dropIndex: number;
 }
 
+interface DataTableRowExpansionTemplate {
+    index: number;
+}
+
+interface DataTableRowClassNameOptions {
+    props: DataTableProps;
+}
+
+interface DataTableCellClassNameOptions {
+    props: DataTableProps;
+    rowData: any;
+}
+
+interface DataTableShowSelectionElementOptions {
+    index: number;
+    props: DataTableProps;
+}
+
+interface DataTableShowRowReorderElementOptions {
+    index: number;
+    props: DataTableProps;
+}
+
+interface DataTableRowEditValidatorOptions {
+    props: DataTableProps;
+}
+
 export interface DataTableProps {
     id?: string;
     value?: any[];
-    header?: React.ReactNode;
-    footer?: React.ReactNode;
+    header?: DataTableHeaderTemplateType;
+    footer?: DataTableFooterTemplateType;
     style?: object;
     className?: string;
     tableStyle?: object;
@@ -191,8 +256,6 @@ export interface DataTableProps {
     selectOnEdit?: boolean;
     headerColumnGroup?: React.ReactNode;
     footerColumnGroup?: React.ReactNode;
-    frozenHeaderColumnGroup?: React.ReactNode;
-    frozenFooterColumnGroup?: React.ReactNode;
     expandedRows?: any[] | DataTableExpandedRows;
     resizableColumns?: boolean;
     columnResizeMode?: DataTableColumnResizeModeType;
@@ -203,9 +266,8 @@ export interface DataTableProps {
     filterLocale?: string;
     scrollable?: boolean;
     scrollHeight?: string;
-    virtualScroll?: boolean;
-    virtualScrollDelay?: number;
-    virtualRowHeight?: number;
+    scrollDirection?: DataTableScrollDirectionType;
+    virtualScrollerOptions?: VirtualScrollerProps;
     frozenWidth?: string;
     frozenValue?: any[];
     csvSeparator?: string;
@@ -217,30 +279,37 @@ export interface DataTableProps {
     tabIndex?: number;
     stateKey?: string;
     stateStorage?: DataTableStateStorageType;
-    groupField?: string;
+    groupRowsBy?: string;
     editMode?: string;
     editingRows?: any[] | DataTableEditingRows;
     expandableRowGroups?: boolean;
     rowHover?: boolean;
     showGridlines?: boolean;
     stripedRows?: boolean;
-    showSelectionElement?(data: any): boolean | undefined | null;
-    showRowReorderElement?(data: any): boolean | undefined | null;
+    size?: DataTableSizeType;
+    responsiveLayout?: DataTableResponsiveLayoutType;
+    breakpoint?: string;
+    filterDisplay?: DataTableFilterDisplayType;
+    expandedRowIcon?: string;
+    collapsedRowIcon?: string;
+    globalFilterFields?: string[];
+    rowGroupHeaderTemplate?: DataTableRowGroupHeaderTemplateType;
+    rowGroupFooterTemplate?: DataTableRowGroupFooterTemplateType
+    onRowEditComplete?(e: DataTableRowEditCompleteParams): void;
+    showSelectionElement?(data: any, options: DataTableShowSelectionElementOptions): boolean | undefined | null;
+    showRowReorderElement?(data: any, options: DataTableShowRowReorderElementOptions): boolean | undefined | null;
     onSelectionChange?(e: DataTableSelectionChangeParams): void;
     onContextMenuSelectionChange?(e: DataTableSelectionChangeParams): void;
-    rowExpansionTemplate?(data: any): React.ReactNode;
+    rowExpansionTemplate?(data: any, options: DataTableRowExpansionTemplate): React.ReactNode;
     onRowToggle?(e: DataTableRowToggleParams): void;
-    rowClassName?(data: any): object;
-    cellClassName?(data: any, options: any): object;
-    rowGroupHeaderTemplate?(data: any, index: number): React.ReactNode;
-    rowGroupFooterTemplate?(data: any, index: number): React.ReactNode;
+    rowClassName?(data: any, options: DataTableRowClassNameOptions): object | string;
+    cellClassName?(value: any, options: DataTableCellClassNameOptions): object | string;
     onColumnResizeEnd?(e: DataTableColumnResizeEndParams): void;
     onColumnResizerClick?(e: DataTableColumnResizerClickParams): void;
     onColumnResizerDoubleClick?(e: DataTableColumnResizerClickParams): void;
     onSort?(e: DataTableSortParams): void;
     onPage?(e: DataTablePageParams): void;
     onFilter?(e: DataTableFilterParams): void;
-    onVirtualScroll?(e: DataTableVirtualScrollParams): void;
     onAllRowsSelect?(e: DataTableSelectParams): void;
     onAllRowsUnselect?(e: DataTableUnselectParams): void;
     onRowClick?(e: DataTableRowClickEventParams): void;
@@ -256,7 +325,7 @@ export interface DataTableProps {
     onColReorder?(e: DataTableColReorderParams): void;
     onRowReorder?(e: DataTableRowReorderParams): void;
     onValueChange?(value: any[]): void;
-    rowEditorValidator?(data: any): boolean;
+    rowEditValidator?(data: any, options: DataTableRowEditValidatorOptions): boolean;
     onRowEditInit?(e: DataTableRowEditParams): void;
     onRowEditSave?(e: DataTableRowEditSaveParams): void;
     onRowEditCancel?(e: DataTableRowEditParams): void;
@@ -271,7 +340,7 @@ export interface DataTableProps {
 export declare class DataTable extends React.Component<DataTableProps, any> {
     public reset(): void;
     public exportCSV(options: { selectionOnly: boolean }): void;
-    public filter<T>(value: T, field: string, mode: DataTableFilterMatchModeType): void;
+    public filter<T>(value: T, field: string, mode: DataTableFilterMatchModeType, index?: number): void;
     public resetColumnOrder(): void;
     public closeEditingCell(): void;
 }