Skip to content

Commit 3e68f28

Browse files
committed
filterList -> filter
1 parent 2ac704e commit 3e68f28

File tree

5 files changed

+10
-11
lines changed

5 files changed

+10
-11
lines changed

docs/documentation/docs/controls/ListItemPicker.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# ListItemPicker control
22

3-
This control allows you to select one or more items from a list. The List can be filter to allow select items from a subset of items The item selection is based from a column value. The control will suggest items based on the inserted value.
3+
This control allows you to select one or more items from a list. The List can be filtered to allow select items from a subset of items The item selection is based from a column value. The control will suggest items based on the inserted value.
44

55
Here is an example of the control:
66

@@ -24,7 +24,7 @@ import { ListItemPicker } from '@pnp/spfx-controls-react/lib/listItemPicker';
2424
<ListItemPicker listId='da8daf15-d84f-4ab1-9800-7568f82fed3f'
2525
columnInternalName='Title'
2626
valueColumnInternalName='Id'
27-
filterList="Title eq 'SPFx'"
27+
filter="Title eq 'SPFx'"
2828
itemLimit={2}
2929
onSelectedItem={this.onSelectedItem}
3030
context={this.props.context} />
@@ -59,6 +59,6 @@ The `ListItemPicker` control can be configured with the following properties:
5959
| suggestionsHeaderText | string | no | The text that should appear at the top of the suggestion box. |
6060
| noResultsFoundText | string | no | The text that should appear when no results are returned. |
6161
| disabled | boolean | no | Specifies if the control is disabled or not. |
62-
| filterList | string | no | condition to filter list Item, same as $filter ODATA parameter|
62+
| filter | string | no | condition to filter list Item, same as $filter ODATA parameter|
6363

6464
![](https://telemetry.sharepointpnp.com/sp-dev-fx-controls-react/wiki/controls/ListItemPicker)

src/controls/listItemPicker/IListItemPickerProps.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ export interface IListItemPickerProps {
77
context: WebPartContext | ApplicationCustomizerContext;
88
listId: string;
99
itemLimit: number;
10-
filterList?: string;
10+
filter?: string;
1111
className?: string;
1212
webUrl?: string;
1313
defaultSelectedItems?: any[];

src/controls/listItemPicker/ListItemPicker.tsx

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -112,10 +112,9 @@ export class ListItemPicker extends React.Component<IListItemPickerProps, IListI
112112
* Function to load List Items
113113
*/
114114
private loadListItems = async (filterText: string): Promise<{ key: string; name: string }[]> => {
115-
let { listId, columnInternalName, keyColumnInternalName, webUrl, filterList } = this.props;
115+
let { listId, columnInternalName, keyColumnInternalName, webUrl, filter } = this.props;
116116
let arrayItems: { key: string; name: string }[] = [];
117117
let keyColumn: string = keyColumnInternalName || 'Id';
118-
let filter: string = filterList || undefined;
119118

120119
try {
121120
let listItems = await this._spservice.getListItems(filterText, listId, columnInternalName, keyColumn, webUrl, filter);

src/services/SPService.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -47,12 +47,12 @@ export default class SPService implements ISPService {
4747
/**
4848
* Get List Items
4949
*/
50-
public async getListItems(filterText: string, listId: string, internalColumnName: string, keyInternalColumnName?: string, webUrl?: string, filterList?: string ): Promise<any[]> {
50+
public async getListItems(filterText: string, listId: string, internalColumnName: string, keyInternalColumnName?: string, webUrl?: string, filter?: string ): Promise<any[]> {
5151
let returnItems: any[];
52-
const filter: string = filterList ? `and ${filterList}` : '';
52+
const filterStr = `startswith(${internalColumnName},'${encodeURIComponent(filterText.replace("'","''"))}')${filter ? ' and ' + filter : ''}`; //string = filterList ? `and ${filterList}` : '';
5353
try {
5454
const webAbsoluteUrl = !webUrl ? this._context.pageContext.web.absoluteUrl : webUrl;
55-
const apiUrl = `${webAbsoluteUrl}/_api/web/lists('${listId}')/items?$select=${keyInternalColumnName || 'Id'},${internalColumnName}&$filter=startswith(${internalColumnName},'${encodeURIComponent(filterText.replace("'","''"))}') ${filter}`;
55+
const apiUrl = `${webAbsoluteUrl}/_api/web/lists('${listId}')/items?$select=${keyInternalColumnName || 'Id'},${internalColumnName}&$filter=${filterStr}`;
5656
const data = await this._context.spHttpClient.get(apiUrl, SPHttpClient.configurations.v1);
5757
if (data.ok) {
5858
const results = await data.json();

src/webparts/controlsTest/components/ControlsTest.tsx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -697,11 +697,11 @@ export default class ControlsTest extends React.Component<IControlsTestProps, IC
697697
<ListItemPicker listId={'76a8231b-35b6-4703-b1f4-5d03d3dfb1ca'}
698698
columnInternalName="Title"
699699
keyColumnInternalName="Id"
700-
filterList={"Title eq 'SPFx'"}
700+
filter={"Title eq 'SPFx'"}
701701
itemLimit={5}
702702
context={this.props.context}
703703
onSelectedItem={this.listItemPickerDataSelected} />
704-
704+
705705
</div>
706706

707707
<div className="ms-font-m">Services tester:

0 commit comments

Comments
 (0)