Fix #6233: FilterMatchMode typescript updates

primefaces · Mar 27, 2024 · 187726b · 187726b
1 parent 7d8aee6
commit 187726b
Show file tree

Hide file tree

Showing 7 changed files with 17 additions and 16 deletions.
diff --git a/components/lib/api/api.d.ts b/components/lib/api/api.d.ts
@@ -1446,6 +1446,7 @@ export declare enum FilterMatchMode {
     EQUALS = 'equals',
     NOT_EQUALS = 'notEquals',
     IN = 'in',
+    NOT_IN = 'notIn',
     LESS_THAN = 'lt',
     LESS_THAN_OR_EQUAL_TO = 'lte',
     GREATER_THAN = 'gt',

diff --git a/components/lib/column/column.d.ts b/components/lib/column/column.d.ts
@@ -680,9 +680,9 @@ interface ColumnFilterMetaData {
      */
     value: any;
     /**
-     * Type of filter match.
+     * Type of filter match; "startsWith", "contains", "endsWith", "equals", "notEquals", "in", "notIn", "lt", "lte", "gt", "gte" and "custom".
      */
-    matchMode: 'startsWith' | 'contains' | 'endsWith' | 'equals' | 'notEquals' | 'in' | 'notIn' | 'lt' | 'lte' | 'gt' | 'gte' | 'custom';
+    matchMode: FilterMatchMode | string;
 }
 
 interface ColumnFilterMetaDataWithConstraint {
@@ -723,9 +723,9 @@ interface ColumnFilterMatchModeChangeEvent {
      */
     field: string;
     /**
-     * Type of filter match.
+     * Type of filter match; "startsWith", "contains", "endsWith", "equals", "notEquals", "in", "notIn", "lt", "lte", "gt", "gte" and "custom".
      */
-    matchMode: FilterMatchMode;
+    matchMode: FilterMatchMode | string;
 }
 
 /**
@@ -818,9 +818,9 @@ interface ColumnFilterMatchModeOptions {
      */
     label: string;
     /**
-     * The match mode type
+     * Type of filter match; "startsWith", "contains", "endsWith", "equals", "notEquals", "in", "notIn", "lt", "lte", "gt", "gte" and "custom".
      */
-    value: FilterMatchMode | string;
+    matchMode: FilterMatchMode | string;
 }
 
 /**
@@ -962,9 +962,9 @@ export interface ColumnProps {
      */
     filterHeaderStyle?: React.CSSProperties | undefined;
     /**
-     * Defines filterMatchMode; "startsWith", "contains", "endsWith", "equals", "notEquals", "in", "lt", "lte", "gt", "gte" and "custom".
+     * Defines filterMatchMode; "startsWith", "contains", "endsWith", "equals", "notEquals", "in", "notIn", "lt", "lte", "gt", "gte" and "custom".
      */
-    filterMatchMode?: FilterMatchMode | undefined;
+    filterMatchMode?: FilterMatchMode | string | undefined;
     /**
      * An array of label-value pairs to override the global match mode options.
      */

diff --git a/components/lib/dropdown/dropdown.d.ts b/components/lib/dropdown/dropdown.d.ts
@@ -329,7 +329,7 @@ export interface DropdownProps extends Omit<React.DetailedHTMLProps<React.InputH
      */
     filterLocale?: string | undefined;
     /**
-     * Defines how the items are filtered.
+     * Defines how the items are filtered, valid values are "contains", (default) "startsWith", "endsWith", "equals" and "notEquals".
      * @defaultValue contains
      */
     filterMatchMode?: 'contains' | 'startsWith' | 'endsWith' | 'equals' | 'notEquals' | undefined;

diff --git a/components/lib/listbox/listbox.d.ts b/components/lib/listbox/listbox.d.ts
@@ -301,10 +301,10 @@ export interface ListBoxProps extends Omit<React.DetailedHTMLProps<React.InputHT
      */
     filterLocale?: string | undefined;
     /**
-     * Defines how the items are filtered, valid values are "contains" (default), "startsWith", "endsWith", "equals" and "notEquals".
+     * Defines how the items are filtered, valid values are "contains", (default) "startsWith", "endsWith", "equals" and "notEquals".
      * @defaultValue contains
      */
-    filterMatchMode?: string | undefined;
+    filterMatchMode?: 'contains' | 'startsWith' | 'endsWith' | 'equals' | 'notEquals' | undefined;
     /**
      * Placeholder text to show when filter input is empty.
      */

diff --git a/components/lib/multiselect/multiselect.d.ts b/components/lib/multiselect/multiselect.d.ts
@@ -502,7 +502,7 @@ export interface MultiSelectProps extends Omit<React.DetailedHTMLProps<React.Inp
      * Defines how the items are filtered, valid values are "contains", (default) "startsWith", "endsWith", "equals" and "notEquals".
      * @defaultValue contains
      */
-    filterMatchMode?: string | undefined;
+    filterMatchMode?: 'contains' | 'startsWith' | 'endsWith' | 'equals' | 'notEquals' | undefined;
     /**
      * Placeholder text to show when filter input is empty.
      */

diff --git a/components/lib/orderlist/orderlist.d.ts b/components/lib/orderlist/orderlist.d.ts
@@ -248,10 +248,10 @@ export interface OrderListProps extends Omit<React.DetailedHTMLProps<React.HTMLA
      */
     filterBy?: string | undefined;
     /**
-     * Defines how the items are filtered, valid values are "contains" (default), "startsWith", "endsWith", "equals" and "notEquals".
+     * Defines how the items are filtered, valid values are "contains", (default) "startsWith", "endsWith", "equals" and "notEquals".
      * @defaultValue contains
      */
-    filterMatchMode?: string | undefined;
+    filterMatchMode?: 'contains' | 'startsWith' | 'endsWith' | 'equals' | 'notEquals' | undefined;
     /**
      * Placeholder text to show when filter input is empty.
      */

diff --git a/components/lib/picklist/picklist.d.ts b/components/lib/picklist/picklist.d.ts
@@ -368,10 +368,10 @@ export interface PickListProps {
      */
     filterBy?: string | undefined;
     /**
-     * 	Defines how the items are filtered, valid values are "contains" (default) "startsWith", "endsWith", "equals", "notEquals", "in", "notIn", "lt", "lte", "gt" and "gte".
+     * Defines how the items are filtered, valid values are "contains", (default) "startsWith", "endsWith", "equals" and "notEquals".
      * @defaultValue contains
      */
-    filterMatchMode?: string | undefined;
+    filterMatchMode?: 'contains' | 'startsWith' | 'endsWith' | 'equals' | 'notEquals' | undefined;
     /**
      * Locale to use in filtering. The default locale is the host environment's current locale.
      * @defaultValue undefined