primereact 9.0.0-beta.1 → 9.0.0

package/datatable/datatable.d.ts

@@ -2,7 +2,7 @@
  *
  * DataTable displays data in tabular format.
  *
- * [Live Demo](https://www.primefaces.org/primereact/datatable/)
+ * [Live Demo](https://www.primereact.org/datatable/)
  *
  * @module datatable
  *
@@ -22,7 +22,6 @@ type DataTableRowGroupFooterTemplateType<TValue extends DataTableValueArray> = R
 
 /**
  * Custom datatable header template options.
- * @group Misc
  */
 interface DataTableHeaderTemplateOptions<TValue extends DataTableValueArray> {
     /**
@@ -35,7 +34,6 @@ interface DataTableFooterTemplateOptions<TValue extends DataTableValueArray> ext
 
 /**
  * Custom datatable row group header template options.
- * @group Misc
  */
 interface DataTableRowGroupHeaderTemplateOptions<TValue extends DataTableValueArray> {
     /**
@@ -54,7 +52,6 @@ interface DataTableRowGroupHeaderTemplateOptions<TValue extends DataTableValueAr
 
 /**
  * Custom datatable row group footer template options.
- * @group Misc
  */
 interface DataTableRowGroupFooterTemplateOptions<T extends DataTableValueArray> extends DataTableRowGroupHeaderTemplateOptions<T> {
     /**
@@ -65,7 +62,6 @@ interface DataTableRowGroupFooterTemplateOptions<T extends DataTableValueArray>
 
 /**
  * Custom datatable sort meta
- * @group Misc
  */
 interface DataTableSortMeta {
     /**
@@ -80,7 +76,6 @@ interface DataTableSortMeta {
 
 /**
  * Custom datatable filter metadata.
- * @group Misc
  */
 interface DataTableFilterMetaData {
     /**
@@ -95,7 +90,6 @@ interface DataTableFilterMetaData {
 
 /**
  * Custom datatable operator filter metadata.
- * @group Misc
  */
 interface DataTableOperatorFilterMetaData {
     /**
@@ -110,7 +104,6 @@ interface DataTableOperatorFilterMetaData {
 
 /**
  * Custom datatable filter meta.
- * @group Misc
  */
 interface DataTableFilterMeta {
     /**
@@ -121,7 +114,6 @@ interface DataTableFilterMeta {
 
 /**
  * Custom datatable expanded rows.
- * @group Misc
  */
 interface DataTableExpandedRows {
     [key: string]: boolean;
@@ -129,7 +121,6 @@ interface DataTableExpandedRows {
 
 /**
  * Custom datatable editing rows.
- * @group Misc
  */
 interface DataTableEditingRows {
     [key: string]: boolean;
@@ -189,6 +180,8 @@ interface DataTableColumnResizerClickEvent {
 
 /**
  * Custom pagination event
+ * @see {@link DataTableProps.onPage}
+ * @event
  */
 interface DataTablePageEvent {
     /**
@@ -215,6 +208,7 @@ interface DataTablePageEvent {
 
 /**
  * Custom sort event.
+ * @see {@link DataTableProps.onSort}
  * @event
  */
 interface DataTableSortEvent {
@@ -252,6 +246,20 @@ interface DataTableFilterEvent {
     [key: string]: any;
 }
 
+/**
+ * Custom state event containing page, filter and sort states.
+ * @see {@link DataTableProps.onFilter}
+ * @see {@link DataTableProps.onSort}
+ * @see {@link DataTableProps.onPage}
+ * @event
+ */
+interface DataTableStateEvent extends DataTablePageEvent, DataTableFilterEvent, DataTableSortEvent {
+    /**
+     * Extra options.
+     */
+    [key: string]: any;
+}
+
 /**
  * Custom data selectable event.
  * @see {@link DataTableProps.isDataSelectable}
@@ -531,7 +539,6 @@ interface DataTableRowReorderEvent<TValue extends DataTableValueArray> {
 /**
  * Options for the row expansion template
  * @see {@link DataTableProps.rowExpansionTemplate}
- * @group Misc
  */
 interface DataTableRowExpansionTemplate {
     /**
@@ -547,7 +554,6 @@ interface DataTableRowExpansionTemplate {
 /**
  * Custom row className options.
  * @see {@link DataTableProps.rowClassName}
- * @group Misc
  */
 interface DataTableRowClassNameOptions<TValue extends DataTableValueArray> {
     /**
@@ -559,7 +565,6 @@ interface DataTableRowClassNameOptions<TValue extends DataTableValueArray> {
 /**
  * Custom cell className options.
  * @see {@link DataTableProps.cellClassName}
- * @group Misc
  */
 interface DataTableCellClassNameOptions<TValue extends DataTableValueArray> {
     /**
@@ -587,7 +592,6 @@ interface DataTableCellClassNameOptions<TValue extends DataTableValueArray> {
 /**
  * Custom show selection element options.
  * @see {@link DataTableProps.showSelectionElement}
- * @group Misc
  */
 interface DataTableShowSelectionElementOptions<TValue extends DataTableValueArray> {
     /**
@@ -603,7 +607,6 @@ interface DataTableShowSelectionElementOptions<TValue extends DataTableValueArra
 /**
  * Custom show row reorder element options.
  * @see {@link DataTableProps.showRowReorderElement}
- * @group Misc
  */
 interface DataTableShowRowReorderElementOptions<TValue extends DataTableValueArray> {
     /**
@@ -619,7 +622,6 @@ interface DataTableShowRowReorderElementOptions<TValue extends DataTableValueArr
 /**
  * Custom row edit validator options.
  * @see {@link DataTableProps.rowEditValidator}
- * @group Misc
  */
 interface DataTableRowEditValidatorOptions<TValue extends DataTableValueArray> {
     /**
@@ -628,25 +630,22 @@ interface DataTableRowEditValidatorOptions<TValue extends DataTableValueArray> {
     props: DataTableProps<TValue>;
 }
 
-interface DataTableValue extends Record<string, any> {}
-
-interface DataTableValueArray extends Array<DataTableValue> {}
-
 /**
- * @group Misc
+ * Custom value definition.
+ * @extends Record<string, any>
  */
-type DataTableRowData<TValue extends DataTableValueArray> = {
-    [K in keyof TValue]: TValue[K];
-};
+interface DataTableValue extends Record<string, any> {}
 
 /**
- * @group Misc
+ * Custom value array definition.
+ * @extends Array<DataTableValue>
  */
+interface DataTableValueArray extends Array<DataTableValue> {}
+
+type DataTableRowData<TValueArray extends DataTableValueArray> = TValueArray extends Array<infer TValue> ? TValue : never;
+
 type DataTableRowDataArray<TValue extends DataTableValueArray> = DataTableRowData<TValue>[];
 
-/**
- * @group Misc
- */
 type DataTableCellSelection<TValue extends DataTableValueArray> = {
     /**
      * Index of the cell.
@@ -679,12 +678,9 @@ type DataTableCellSelection<TValue extends DataTableValueArray> = {
     /**
      * Value of the cell.
      */
-    value: TValue[keyof TValue];
+    value: TValue[number][keyof TValue[number]];
 };
 
-/**
- * @group Misc
- */
 type DataTableSelection<TValue extends DataTableValueArray> = DataTableRowData<TValue> | DataTableRowDataArray<TValue> | DataTableCellSelection<TValue>;
 
 /**
@@ -1173,14 +1169,14 @@ export interface DataTableProps<TValue extends DataTableValueArray> extends Omit
     onContextMenuSelectionChange?(event: DataTableSelectionChangeEvent<TValue>): void;
     /**
      * Callback to invoke on filtering.
-     * @param {DataTableFilterEvent} event - Custom filter event.
+     * @param {DataTableStateEvent} event - Custom state event.
      */
-    onFilter?(event: DataTableFilterEvent): void;
+    onFilter?(event: DataTableStateEvent): void;
     /**
      * Callback to invoke on pagination.
-     * @param {DataTablePageEvent} event - Custom pagination event.
+     * @param {DataTableStateEvent} event - Custom state event.
      */
-    onPage?(event: DataTablePageEvent): void;
+    onPage?(event: DataTableStateEvent): void;
     /**
      * Callback to invoke when a row is clicked.
      * @param {DataTableRowClickEvent} event - Custom row click event.
@@ -1268,9 +1264,9 @@ export interface DataTableProps<TValue extends DataTableValueArray> extends Omit
     onSelectionChange?(event: DataTableSelectionChangeEvent<TValue>): void;
     /**
      * Callback to invoke on sort.
-     * @param {DataTableSortEvent} event - Custom sort event.
+     * @param {DataTableStateEvent} event - Custom state event.
      */
-    onSort?(event: DataTableSortEvent): void;
+    onSort?(event: DataTableStateEvent): void;
     /**
      * Callback to invoke table state is restored.
      * @param {object} state - Table state.
@@ -1326,9 +1322,9 @@ export interface DataTableProps<TValue extends DataTableValueArray> extends Omit
  *
  * _DataTable displays data in tabular format._
  *
- * [Live Demo](https://www.primefaces.org/primereact/datatable/)
+ * [Live Demo](https://www.primereact.org/datatable/)
  * --- ---
- * ![PrimeReact](https://www.primefaces.org/primereact/images/logo-100.png)
+ * ![PrimeReact](https://primefaces.org/cdn/primereact/images/logo-100.png)
  *
  * @group Component
  */