List Search

The Office 365 / SharePoint Online List Search WebPart displays a list from another Site/SiteCollection with a search box and WebPart connection to send Items.

Make Lists / Views available from other Sites and define the fields to show.

Configuration


WebPart Properties
Property NameDescription
Site URL Specify the full URL to the Site, serving the List.
List Name Choose your List from the available DropDownList
View Name Select a List View (optional)
Title Set a WebPart’s Title (optional)
FieldTemplate defines the listFields in order and renamed by a pipe character.
Example: id;Title|Object;
exclude listFields from beeing displayed, but also searchable: Set a "!" character in front of the FieldName:
Example:id;Title;!Descripction
Lookup fields: {FieldName:LookupFieldName}
Specials: fieldname=filter, sets the field to be a clickable filter to send to other Webparts.
=fileicon, set the proper field to be an icon
=open, will add a link on the item to open it on click
=%, will display percentual fields more correctly
[ATFjpg]=value.jpg will display the first Attachment fiel with its name value.jpg as an item (image)
Form open in Panel / Dialog / new Tab / same Tab
A-Z Fieldname Enter a field name to enable A-Z filtering
Filter fields define searchboxes to filter columns. Example: FieldName1;@FieldName2 this will create a normal text input box for list column FieldName1 and a dropdown box for list column name FieldName2.
Category field name To enable categories use a field name to filter on
Category prefix define a category value prefix (optional)
Date Format change the output string of the DateTime fields.
Custom CSS Add custom CSS to the web part / site by selector { attribute: value; }
Link Title to connected list Set the Title section with an onclick event to redirect to the connected list.
Show 'New Item' link Creates a button to create a new list item
Show record size Will show total records available at the bottom of the table.
Show only Search results Will only show a searchbox and filter the loaded data (shows only the results)
Show search box Creates an universal searchbox searching thrue all fields available
Alternate row color Set an alternate row color with names or #hex (i.E: red or blue or #ffaab1)
Default page length Set the default page length and enables pagination
enable Export to Excel Creates a button to export the table into a CSV file (Excel)
Options -
Filtering
Items to display How many items should be loaded (0 - 5000)
Request Filter Filter the API request with &$filter values.
Example: FieldInternalName Operator Value ID eq 12 Firstname ne 'Jon'
Sorting
Default order by column Nbr. Set the default sort column number started with zero '0', or use the display name.
Sort direction Ascending / Descending
Sort direction (Category) If Categories is enabled, define the default sort order
Sort in Category Enable to sort within the categories or disable to sort thru all the items
Table CSS
Header CSS Style the header section with css
Header Column CSS Style the header column section with css
Table Row Column CSS Style the table row column section with css
Table Row Hover CSS Style the table row column on mouse hover section with css
Table Item Column CSS Style the table item section with css
Table Item Hover CSS Style the table item on mouse hover section with css
A-Z Container CSS Style the A-Z container with css
A-Z Items CSS Style the A-Z container item with css
A-Z Items (available letters) CSS Style the A-Z container available items with css
A-Z Items (Active) CSS Style the A-Z container active items with css
Filter fields CSS Style the filter fields container with css
Buttons CSS Style available buttons with css
Category Row CSS Style category rows with css
Category Item CSS Style category items with css
Caching
Cache retention Time (Minutes) Set a cache retention time to speed up loading time and reduce API-Calls against SharePoint
License

Get a license

We offer different kinds of license

  • a PayPal subscription
  • a conservative invoice for a defined time period

  • Office 365

    Paypal

    Select your seats count (All active accounts having access to your tenant)
    If your seats count is over 2499, please request an Offer!

    SharePoint URL*
    Request an Offer

    Post a comment

    Joe Lavia
    02/28/2019 20:12
    Hi, Is it possible to hide columns in the web part so that fields can be searched but not seen in the search results?
    Raphael
    03/01/2019 00:18
    Hello Joe Lavia,
    we have added the ability to exclude listFields from beeing displayed.
    Please add a "!" character in front of the fieldName: !Title;Description
    Olivier D
    07/02/2019 12:20
    Hi all.
    Is this web part compatible with the new modern Sharepoint pages ?
    Thanks
    Raphael
    02/16/2020 10:07
    Hello Oliver,

    yes it is compatible with the modern SharePoint pages.
    Max
    05/20/2020 09:35
    In my configuration I have the options for Filtering available (Request Filter [Fitler on the returned Items (Rest API Filter)]) but I can't find any documentation about it.
    Can you update this?
    Raphael
    05/20/2020 09:59
    Max,

    the description is updated with additional information.
    Matthias Hummler
    05/26/2020 13:50
    Hi, is it p0ssible to attach to each searchbox on colum level the same class attribute name as the field name to address some special CSS style requirements (hide some specific column search boxes)?
    Peter Dierauer
    05/29/2020 14:14
    Does this web-part work with document libraries, filtering against a files property field?
    Raphael
    05/29/2020 19:18
    Matthias,

    the web part is currently in revidsion and will be released with new functions included.
    Searchboxes can be created / defined and renamed by a separate property.
    we can send you the first beta version by email.
    Raphael
    06/01/2020 09:23
    Peter,

    it is possible to filter against list fields.
    Also within a document library, you will find some file specific fields to filter on.
    David Weyrick
    06/15/2020 16:24
    Would it be possible for the List Search web part to support conditional row formatting? Based on the value of a specific column being displayed, would color the entire row with a specific background color. This would allow data displays using the List Search web part to function similar to a SharePoint Online list view that has conditional row formatting applied (both could display the same colors).
    Raphael
    06/16/2020 08:41
    David,

    this product is still in revision and will be released in the next view days.
    We can implement this function to the new release of this web part.
    Jonas
    07/04/2020 19:54
    Is it possible to change the default backgrounds color and text color or is this something that can be added in a future version?

    If you use a dark theme (dark mode) for sharepoint as a theme the background is white and the text dark grey so its next to impossible to see it.
    Picture to show what i mean.
    https://ibb.co/H2t0qqP
    Raphael
    07/08/2020 14:52
    Jonas,

    the new release of this web part is planned on 07/09/2020.
    Please have a look at the new version.
    Michael Kirshner
    07/29/2020 20:48
    I really like the web part. However, for me to make this work, I will need to be able to connect the document library to an Embed web part, so the PDF that I select will be displayed. I would also need to connect it to the properties list, so the properties can be set from the record I select. I can do it using the Document Library web part, but I can't search. I really need both. Thank you.
    Raphael
    07/31/2020 22:12
    Michael,

    the filters / web part connection's are only working with products provided by us.
    If you can share more details by email, we probably can find a way together.
    Joe Lavia
    08/12/2020 12:27
    Hi Raphael,
    Can the field template "fieldname=filter" expression be used with modern SharePoint list web part?
    Raphael
    08/12/2020 12:41
    Livia,

    the web part can connect with other web parts provided by us.
    What do you like to achive?

    Bob Thorne
    02/09/2021 19:58
    Is there a way to filter between two dates? I've added the following code to my Filter Fields (where my date field is called KeyDate and formatted as a time/date field), but no success: any date entered hides all records, regardless of assigned date.
    KeyDate>=;KeyDate<
    Raphael
    02/10/2021 15:56
    Bob,

    To filter a daterange, please use the filter fields web part property with the following syntx: [$FieldName|RenameLabel

    It will creeate a dropdown with predefined filters to choose from and a custom item
    which is configurable by clicking the date icon on the right side next to the dropdown input box.

    Here is an Example of the configuration: Link
    Derek N
    03/02/2021 19:20
    Hi, I'm trying to use the Filtering options but neither the "Items to display" nor "Request Filters" seem to work. No matter what I enter into either field, all list items are displayed. For example, I tried to enter 1 in Items to display and expected to see just one item, but all are displayed. I also tried to filter the Title column with Title eq 'Boise' but all list items are displayed, not just the ones that have a Title of Boise. Is there another setting I'm missing somewhere?
    Raphael
    03/03/2021 07:22
    Derek,

    please update to the most recent version.
    There was a small issue on the "Items to display" option which is fixed.
    We also have added the ability to set a request filter if a list view name is used.
    Kyle Ohmann
    03/11/2021 18:30
    Hello! Love this web part but am having trouble configuring it. Is there any way you could provide more details and examples of what to put in each of the config options? Thanks!
    Kyle Ohmann
    03/11/2021 18:30
    Hello! Love this web part but am having trouble configuring it. Is there any way you could provide more details and examples of what to put in each of the config options? Thanks!
    Raphael
    03/12/2021 10:35
    Kyle,

    we are working on a new Homepage with more detailed information and if possible, also examples to look at.
    If you do have specific question / requirement, please let me know and I can assist by email.
    David Paz
    04/01/2021 23:46
    Hi, great job with this webpart. At the moment I am using the webpart in a document library with more than 140,000 items. And the big problem is that, using only the "search box", it takes too long to open or load the web part. More than 15 minutes, and that time in the company they will not accept. Is there a way that the data can be loaded, for each pagination? or is there some other way to handle these very large libraries? Thank you very much for your reply.
    Raphael
    04/05/2021 07:55
    David,

    thank you for getting in contact with us.
    SharePoint SPFx Web Part can request 1 to 5000 items a request against a SharePoint list. By default our List Search have a value set to
    3333 items each request. This would result in 43 requests against your document library.
    It is possible to increase this value by the web part property "options": searchitemcount=5000|
    Have you enabled the web part property "cache retention time"?

    This cache option will created an Indexed DB for the Items and will load the items from your hard disk drive if you visit the web part again
    Dom
    04/26/2021 05:09
    How do I filter for managed metadata fields from the term store that contain multiple values? e.g. the equivalent of this querystring:
    ?FilterField1=System_x0028_s_x0029_&FilterValue1=JIRA&FilterType1=TaxonomyFieldTypeMulti
    Raphael
    04/26/2021 08:30
    Dom,

    to filter on manged metadata fields with a API request filter, we need the following preconfiguration:
    -Having the managed metadata available in the field template property. It is possible to hide it with a leading "!" mark.
    -Using the request filter with the following syntax: substringof('Script Editor',TaxCatchAll/Term) and substringof('Domain',TaxCatchAll/Term)
    This will return all the items matching a term set including 'Script Editor' and 'Domain'
    Kyle Ohmann
    04/29/2021 13:15
    Hello!

    I am using this web part on a library that now has over 5000 documents and am getting the error "[get_items] The attempted operation is prohibited because it exceeds the list view threshold." The library was initially setup with 4 indexes because it will eventually hold 10k+ documents. How can I get this web part to work on this large library?

    Thanks,
    Kyle Ohmann
    Raphael
    04/29/2021 13:47
    Kyle,

    if a library is containing more than 5000 items, the web part will be able to receive all items if list view is set to disabled.
    You can build a request filter to get filtered items.
    Kyle Ohmann
    05/05/2021 20:06
    When using this WP on a list where I am trying to display columns that are from the Term Store I get the error "[get_items] The $expand query is not valid for field 'TaxCatchAll'" and I have no idea what it means. There isn't a column called "TaxCatchAll" in the library. I am also trying to display the Document Owner (an alias for the site column named "OwlQualityDocumentOwner") column, which is a Person or Group, but I get this error: "[get_items] The $expand query is not valid for field 'OwlQualityDocumentOwner'."
    How can I resolve these errors?
    Thanks,
    Kyle Ohmann
    Lerato
    05/06/2021 08:18
    Hi, my field "Name" contains a pdf attachment but on the webpart the field is not clickable.
    Raphael
    05/06/2021 09:49
    Lerato,

    please use the filedtemplate option:
    fieldname=open; to open the list item
    fieldname=openfile; to open the related file
    Kyle Ohmann
    05/07/2021 13:58
    I cannot get the Request Filter to work when using a "Disabled" view. I have a choice column named "Approval state" (Internal system name is "Approval_x0020_state") and I need to only include items where Approval state = "Approved". I have tried the following: Approval state eq 'Approved', Approval_x0020_state eq 'Approved' and both return this error: "[_getSlides] + [HTTP]:400 - [CorrelationId]:c294c59f-20bb-b000-fbc0-4795cd2b8b20 [Version]:16.0.0.21228 - ErrorCode: 400". Please help.

    Thanks,
    Kyle.
    Raphael
    05/07/2021 15:50
    Kyle,

    if you are available, please let us start a short screen sharing session to look into this directly on your tenant.
    I have sent you an e-mail.
    Dom
    05/25/2021 02:07
    Hi Raphael

    Using fieldname=open when displaying a list of sitepages from another site collection, but the link opens /sites/[correct sitecollection]/Lists/SiteP/DispForm.aspx?ID=6 rather than the actual page. Not sure what I'm doing wrong.
    Raphael
    05/25/2021 06:53
    Dom,

    please update to the most recent version and use the following field template option: fieldname=open{EncodedAbsUrl};
    Also make sure the EncodedAbsUrl is loaded in your field template: !EncodedAbsUrl;fieldname=open{EncodedAbsUrl};ortherfields..

    SitePages are handled different. So we had to implement a new option to solve this issue.
    Dom
    05/26/2021 01:21

    I'm successfully using the following syntax in the "Filter Fields" property :
    FieldToFilterOn:{SitePropertyInternalName}|DisplayedHeaderRow

    It works well to filter the target list based on a single value managed metadata column in the current page - thanks so much for that.

    To display the other side of the relationship, is there any way to make it work for a multiple value metadata column in the current page, using OR to check for ANY of the values in the list being filtered.

    So for example:
    Given the page containing the webpart had a multi-value metadata column called "Colour(s)", containing "Red, Blue, Green" terms
    If we have a separate list with a metadata column "Colour" - can we filter that list to only show items that are "Red", "Blue" or "Green" without having to specify the terms in the filter when they already exist in the current page's "Colour(s)" column.

    Then we can display both sides of the relationship and just represent it in meta-data - extremely powerful!
    Raphael
    05/31/2021 07:08
    Dom,

    there is currently not a dynamic filter implemented to build custom relationships to the current page with manually set conditions.
    We would need to have a look in details if we can implement such a functionality
    Kyle Ohmann
    06/02/2021 17:31
    Using the List Search WP to search a document library with the following in the Filter Fields box: $Search;##Search;#Clear. It returns results in Edge but nothing happens in Chrome. If I show the standard search box, it returns search results in both Edge & IE. What am I doing wrong?
    Raphael
    06/03/2021 06:49
    Kyle,

    Are you on the most recent version?
    The filter fields option $Label has a special function included. Please click onto the Label to open a small dialog to select / deselct all fields to search in. By default they should be active.