primevue 4.3.1 → 4.3.3

package/datatable/index.d.ts

@@ -7,7 +7,7 @@
  * @module datatable
  *
  */
-import type { DefineComponent, DesignToken, EmitFn, HintedString, Nullable, PassThrough } from '@primevue/core';
+import type { DefineComponent, DesignToken, EmitFn, HintedString, NoInfer, Nullable, PassThrough } from '@primevue/core';
 import type { ComponentHooks } from '@primevue/core/basecomponent';
 import type { ButtonProps } from 'primevue/button';
 import type { ColumnPassThroughOptionType } from 'primevue/column';
@@ -593,19 +593,19 @@ export interface DataTableRowEditCancelEvent<T = any> extends DataTableRowEditIn
  * Custom state event.
  * @see {@link DataTableEmitsOptions['state-save']}
  */
-export interface DataTableStateEvent {
+export interface DataTableStateEvent<T = any> {
     /**
      * Index of first record
      */
-    first: number;
+    first?: number | undefined;
     /**
      * Number of rows to display in new page
      */
-    rows: number;
+    rows?: number | undefined;
     /**
      * Field to sort against
      */
-    sortField: string;
+    sortField: keyof T;
     /**
      * Sort order as integer
      */
@@ -613,19 +613,19 @@ export interface DataTableStateEvent {
     /**
      * MultiSort metadata
      */
-    multiSortMeta: DataTableSortMeta[] | undefined;
+    multiSortMeta?: DataTableSortMeta[] | undefined | null;
     /**
      * Collection of active filters
      */
-    filters: DataTableFilterMeta;
+    filters?: DataTableFilterMeta;
     /**
      * Comma separated list of column widths
      */
-    columnWidths: string[];
+    columnWidths?: string[] | null;
     /**
      * Order of the columns
      */
-    columnOrder: string[];
+    columnOrder?: string[] | null;
     /**
      * Instances of rows in expanded state
      */
@@ -637,15 +637,15 @@ export interface DataTableStateEvent {
     /**
      * Instances of rows in expanded state
      */
-    expandedRowGroups: any[] | DataTableExpandedRows;
+    expandedRowGroups?: any[] | DataTableExpandedRows;
     /**
      * Selected rows
      */
-    selection: any[] | any;
+    selection?: T[] | T | undefined | null;
     /**
      * Keys of selected rows
      */
-    selectionKeys: any[];
+    selectionKeys: any[] | null;
 }
 
 /**
@@ -884,11 +884,11 @@ export interface DataTableProps<T = any> {
     /**
      * An array of objects to display.
      */
-    value?: any[] | undefined | null;
+    value?: T[] | undefined | null;
     /**
      * Name of the field that uniquely identifies the a record in the data.
      */
-    dataKey?: string | ((item: any) => string) | undefined;
+    dataKey?: keyof T | ((item: NoInfer<T>) => string) | undefined;
     /**
      * Number of rows to display per page.
      * @defaultValue 0
@@ -913,7 +913,7 @@ export interface DataTableProps<T = any> {
      * Position of the paginator, options are 'top','bottom' or 'both'.
      * @defaultValue bottom
      */
-    paginatorPosition?: 'top' | 'bottom' | 'both' | undefined;
+    paginatorPosition?: HintedString<'top' | 'bottom' | 'both'> | undefined;
     /**
      * Whether to show it even there is only one page.
      * @defaultValue true
@@ -972,7 +972,7 @@ export interface DataTableProps<T = any> {
     /**
      * Property name or a getter function of a row data used for sorting by default
      */
-    sortField?: string | ((item: any) => string) | undefined;
+    sortField?: keyof T | ((item: NoInfer<T>) => string) | undefined;
     /**
      * Order to sort the data by default.
      */
@@ -995,7 +995,7 @@ export interface DataTableProps<T = any> {
      * Defines whether sorting works on single column or on multiple columns.
      * @defaultValue single
      */
-    sortMode?: 'single' | 'multiple' | undefined;
+    sortMode?: HintedString<'single' | 'multiple'> | undefined;
     /**
      * When enabled, columns can have an un-sorted state.
      * @defaultValue false
@@ -1009,11 +1009,11 @@ export interface DataTableProps<T = any> {
     /**
      * Layout of the filter elements.
      */
-    filterDisplay?: 'menu' | 'row' | undefined;
+    filterDisplay?: HintedString<'menu' | 'row'> | undefined;
     /**
      * 	An array of fields as string or function to use in global filtering.
      */
-    globalFilterFields?: (string | ((data: T) => string))[] | undefined;
+    globalFilterFields?: (keyof T | ((data: NoInfer<T>) => string))[] | undefined;
     /**
      * Locale to use in filtering. The default locale is the host environment's current locale.
      */
@@ -1021,16 +1021,16 @@ export interface DataTableProps<T = any> {
     /**
      * Selected row in single mode or an array of values in multiple mode.
      */
-    selection?: T[] | T | undefined;
+    selection?: NoInfer<T>[] | NoInfer<T> | undefined;
     /**
      * Specifies the selection mode.
      */
-    selectionMode?: 'single' | 'multiple' | undefined;
+    selectionMode?: HintedString<'single' | 'multiple'> | undefined;
     /**
      * Algorithm to define if a row is selected.
      * @defaultValue deepEquals
      */
-    compareSelectionBy?: 'equals' | 'deepEquals' | undefined;
+    compareSelectionBy?: HintedString<'equals' | 'deepEquals'> | 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.
@@ -1045,7 +1045,7 @@ export interface DataTableProps<T = any> {
     /**
      * Selected row instance with the ContextMenu.
      */
-    contextMenuSelection?: any | any[] | undefined;
+    contextMenuSelection?: NoInfer<T> | NoInfer<T>[] | undefined;
     /**
      * Whether all data is selected.
      */
@@ -1078,7 +1078,7 @@ export interface DataTableProps<T = any> {
      * Defines whether the overall table width.
      * @defaultValue fit
      */
-    columnResizeMode?: 'fit' | 'expand' | undefined;
+    columnResizeMode?: HintedString<'fit' | 'expand'> | undefined;
     /**
      * When enabled, columns can be reordered using drag and drop.
      * @defaultValue false
@@ -1087,7 +1087,7 @@ export interface DataTableProps<T = any> {
     /**
      * A collection of row data display as expanded.
      */
-    expandedRows?: any[] | DataTableExpandedRows | null;
+    expandedRows?: NoInfer<T>[] | DataTableExpandedRows | null;
     /**
      * Icon of the row toggler to display the row as expanded.
      */
@@ -1099,11 +1099,11 @@ export interface DataTableProps<T = any> {
     /**
      * Defines the row group mode.
      */
-    rowGroupMode?: 'subheader' | 'rowspan' | undefined;
+    rowGroupMode?: HintedString<'subheader' | 'rowspan'> | undefined;
     /**
      * One or more field names to use in row grouping.
      */
-    groupRowsBy?: ((field: string) => object) | string[] | string | undefined;
+    groupRowsBy?: ((field: NoInfer<T>) => object) | keyof T[] | keyof T | undefined;
     /**
      * Whether the row groups can be expandable.
      * @defaultValue false
@@ -1112,12 +1112,12 @@ export interface DataTableProps<T = any> {
     /**
      * An array of group field values whose groups would be rendered as expanded.
      */
-    expandedRowGroups?: any[] | DataTableExpandedRows;
+    expandedRowGroups?: NoInfer<T>[] | DataTableExpandedRows;
     /**
      * Defines where a stateful table keeps its state.
      * @defaultValue session
      */
-    stateStorage?: 'session' | 'local' | undefined;
+    stateStorage?: HintedString<'session' | 'local'> | undefined;
     /**
      * Unique identifier of a stateful table to use in state storage.
      */
@@ -1125,22 +1125,22 @@ export interface DataTableProps<T = any> {
     /**
      * Defines the incell editing mode.
      */
-    editMode?: 'cell' | 'row' | undefined;
+    editMode?: HintedString<'cell' | 'row'> | undefined;
     /**
      * A collection of rows to represent the current editing data in row edit mode.
      */
-    editingRows?: T[] | DataTableEditingRows;
+    editingRows?: NoInfer<T>[] | DataTableEditingRows;
     /**
      * A function that takes the row data as a parameter and returns a string to apply a particular class for the row.
      * The return value is added to the row's :classes array (see Vue.js class bindings).
      */
-    rowClass?: (data: T) => string | object | undefined;
+    rowClass?: (data: NoInfer<T>) => string | object | undefined;
     /**
      * A function that takes the row data as a parameter and returns the inline style object for the corresponding row.
      * The function may also return an array of style objects which will be merged.
      * The return value of this function is directly applied as a Vue.js style-binding on the table row.
      */
-    rowStyle?: (data: T) => object | object[] | undefined;
+    rowStyle?: (data: NoInfer<T>) => object | object[] | undefined;
     /**
      * When specified, enables horizontal and/or vertical scrolling.
      * @defaultValue false
@@ -1158,7 +1158,7 @@ export interface DataTableProps<T = any> {
     /**
      * Items of the frozen part in scrollable DataTable.
      */
-    frozenValue?: any[] | undefined | null;
+    frozenValue?: NoInfer<T>[] | undefined | null;
     /**
      * The breakpoint to define the maximum width boundary when using stack responsive layout.
      * @defaultValue 960px
@@ -1187,7 +1187,7 @@ export interface DataTableProps<T = any> {
     /**
      * Defines the size of the table.
      */
-    size?: 'small' | 'large' | undefined;
+    size?: HintedString<'small' | 'large'> | undefined;
     /**
      * Inline style of the table element.
      */
@@ -1370,6 +1370,10 @@ export interface DataTableSlots<T = any> {
          * Total number of pages
          */
         pageCount?: number;
+        /**
+         * Direct page links
+         */
+        pageLinks?: number;
         /**
          * Total records
          */
@@ -1398,6 +1402,10 @@ export interface DataTableSlots<T = any> {
          * Row change function.
          */
         rowChangeCallback: (value: number) => void;
+        /**
+         * Page change function.
+         */
+        changePageCallback: (value: number) => void;
     }): VNode[];
     /**
      * Custom paginator start template.
@@ -1656,12 +1664,12 @@ export interface DataTableEmitsOptions<T = any> {
      * Invoked when a stateful table saves the state.
      * @param {DataTableStateEvent} event - Custom state event.
      */
-    'state-restore'(event: DataTableStateEvent): void;
+    'state-restore'(event: DataTableStateEvent<T>): void;
     /**
      * Invoked when a stateful table restores the state.
      * @param {DataTableStateEvent} event - Custom state event.
      */
-    'state-save'(event: DataTableStateEvent): void;
+    'state-save'(event: DataTableStateEvent<T>): void;
 }
 
 export declare type DataTableEmits = EmitFn<DataTableEmitsOptions>;