#319 - Added OData list filter

Author: estruyf

docs/documentation/docs/controls/ListPicker.md

@@ -53,6 +53,7 @@ The `ListPicker` control can be configured with the following properties:
 | className | string | no | If provided, additional class name to provide on the dropdown element. |
 | disabled | boolean | no | Whether or not the control is disabled. |
 | baseTemplate | number | no | The SharePoint BaseTemplate ID to filter the list options by. |
+| filter | string | no | Filter list from OData query (takes precendents over Hidden and BaseTemplate Filters). |
 | includeHidden | boolean | no | Whether or not to include hidden lists. Default is `true`. |
 | orderBy | LibsOrderBy | no | How to order the lists retrieved from SharePoint. |
 | selectedList | string OR string[] | no | Keys of the selected item(s). If you provide this, you must maintain selection state by observing onSelectionChanged events and passing a new value in when changed. |

src/controls/listPicker/IListPicker.ts

@@ -26,6 +26,10 @@ export interface IListPickerProps {
   * Whether or not to include hidden lists. Default is true
   */
   includeHidden?: boolean;
+  /**
+   * Filter list from OData query (takes precendents over Hidden and BaseTemplate Filters)
+   */
+  filter?: string;
   /**
   * How to order the lists retrieved from SharePoint
   */

src/controls/listPicker/ListPicker.tsx

@@ -63,7 +63,7 @@ export class ListPicker extends React.Component<IListPickerProps, IListPickerSta
   * Loads the list from SharePoint current web site
   */
   private loadLists() {
-    const { context, baseTemplate, includeHidden, orderBy, multiSelect, selectedList } = this.props;
+    const { context, baseTemplate, includeHidden, orderBy, multiSelect, filter, selectedList } = this.props;
 
     // Show the loading indicator and disable the dropdown
     this.setState({ loading: true });
@@ -72,7 +72,8 @@ export class ListPicker extends React.Component<IListPickerProps, IListPickerSta
     service.getLibs({
       baseTemplate: baseTemplate,
       includeHidden: includeHidden,
-      orderBy: orderBy
+      orderBy: orderBy,
+      filter: filter
     }).then((results) => {
       // Start mapping the lists to the dropdown option
       results.value.map(list => {

src/services/ISPService.ts

@@ -12,6 +12,7 @@ export interface ILibsOptions {
     orderBy?: LibsOrderBy;
     baseTemplate?: number;
     includeHidden?: boolean;
+    filter?: string;
 }
 
 export interface ISPService {

src/services/SPService.ts

@@ -22,14 +22,18 @@ export default class SPService implements ISPService {
       queryUrl += `&$orderby=${options.orderBy === LibsOrderBy.Id ? 'Id' : 'Title'}`;
     }
 
-    if (options.baseTemplate) {
-      queryUrl += `&$filter=BaseTemplate eq ${options.baseTemplate}`;
-      filtered = true;
-    }
+    if (options.filter) {
+      queryUrl += `&$filter=${encodeURIComponent(options.filter)}`;
+    } else {
+      if (options.baseTemplate) {
+        queryUrl += `&$filter=BaseTemplate eq ${options.baseTemplate}`;
+        filtered = true;
+      }
 
-    if (options.includeHidden === false) {
-      queryUrl += filtered ? ' and Hidden eq false' : '&$filter=Hidden eq false';
-      filtered = true;
+      if (options.includeHidden === false) {
+        queryUrl += filtered ? ' and Hidden eq false' : '&$filter=Hidden eq false';
+        filtered = true;
+      }
     }
 
     const data = await this._context.spHttpClient.get(queryUrl, SPHttpClient.configurations.v1);

src/webparts/controlsTest/components/ControlsTest.tsx

@@ -549,6 +549,7 @@ export default class ControlsTest extends React.Component<IControlsTestProps, IC
                   baseTemplate={100}
                   includeHidden={false}
                   multiSelect={true}
+                  // filter="Title eq 'Test List'"
                   onSelectionChanged={this.onListPickerChange} />
               </div>