Update Listbox.d.ts and doc

primefaces · Dec 9, 2020 · 6a76deb · 6a76deb
1 parent 61228ba
commit 6a76deb
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 1 deletion.
diff --git a/src/components/listbox/ListBox.d.ts b/src/components/listbox/ListBox.d.ts
@@ -17,6 +17,7 @@ interface ListBoxProps {
     metaKeySelection?: boolean;
     filter?: boolean;
     filterBy?: string;
+    filterValue?: string;
     filterMatchMode?: string;
     filterPlaceholder?: string;
     filterLocale?: string;
@@ -26,6 +27,7 @@ interface ListBoxProps {
     ariaLabelledBy?: string,
     itemTemplate?(item: any): JSX.Element | undefined;
     onChange?(e: {originalEvent: Event, value: any, target: {name: string, id: string, value: any}}): void;
+    onFilterValueChange?(e: {originalEvent: Event, value: string}): void;
 }
 
 export class ListBox extends React.Component<ListBoxProps,any> {}
diff --git a/src/showcase/listbox/ListBoxDoc.js b/src/showcase/listbox/ListBoxDoc.js
@@ -278,7 +278,8 @@ itemTemplate(option) {
             <h5>Filtering</h5>
             <p>Options can be filtered using an input field in the overlay by enabling the <i>filter</i> property. By default filtering is done against
             label of the items and <i>filterBy</i> property is available to choose one or more properties of the options. In addition <i>filterMatchMode</i> can be utilized
-            to define the filtering algorithm, valid options are "contains" (default), "startsWith", "endsWith", "equals" and "notEquals".</p>
+            to define the filtering algorithm, valid options are "contains" (default), "startsWith", "endsWith", "equals" and "notEquals".
+            Also, the <i>filterValue</i> and <i>onFilterValueChange</i> properties can be used to control the filter value.</p>
 
 <CodeHighlight>
 {`
@@ -441,6 +442,12 @@ itemTemplate(option) {
                             <td>label</td>
                             <td>When filtering is enabled, filterBy decides which field or fields (comma separated) to search against.</td>
                         </tr>
+                        <tr>
+                            <td>filterValue</td>
+                            <td>string</td>
+                            <td>null</td>
+                            <td>When specified, filter displays with this value.</td>
+                        </tr>
                         <tr>
                             <td>filterMatchMode</td>
                             <td>string</td>
@@ -499,6 +506,13 @@ itemTemplate(option) {
                             </td>
                             <td>Callback to invoke when value of listbox changes.</td>
                         </tr>
+                        <tr>
+                            <td>onFilterValueChange</td>
+                            <td>event.originalEvent: Browser event <br/>
+                                event.value: the filtered value <br/>
+                            </td>
+                            <td>Callback to invoke when filter value changes.</td>
+                        </tr>
                     </tbody>
                 </table>
             </div>