sp-dev-fx-webparts/samples/react-list-search/README.md

7.4 KiB

List Search

Summary

This list search web part allows the user to show data from lists or libraries. The web part can be used to (for more details see images below):

Merge items from different lists/libraries

Merge items from different lists/libraries

Select render of the selected fields

Select render of the selected fields

Open documents in modal window

Open documents in modal window

Open documents in new tab

Open documents in new tab

Use of dynamic data

Use of dynamic data

Open selected item with same data

Open selected item with same data

Open selected item with selected properties

Open selected item with selected properties

Redirect to url depends on selected item

Redirect to url depends on selected item

Compatibility

SPFx 1.13.1 Node.js v14 Compatible with SharePoint Online Does not work with SharePoint 2019 Does not work with SharePoint 2016 (Feature Pack 2) Teams Incompatible Local Workbench Incompatible Hosted Workbench Compatible Compatible with Remote Containers

Applies to

Solution

Solution Author(s)
react-list-search Alberto Gutiérrez (@albertogperez)

Version history

Version Date Comments
1.0.0 December 20, 2020 Initial release
1.1.0 April 25, 2021 List item modern audience support
1.2.0 January 01, 2022 Upgraded for SPFx v1.13.1

Minimal Path to Awesome

Dev Mode

This sample can also be opened with VS Code Remote Development. Visit https://aka.ms/spfx-devcontainer for further instructions.

  • Clone this repository
  • In the command line run:
    • Navigate to list-search-webpart
    • npm install
    • gulp serve
    • Open the workbench on your Office 365 Developer tenant
    • Test out the web part

Sppkg

  • Download .sppkg files from sppkg folder
  • Upload files to App Catalog
  • Approve the API permissions in the new SP admin center (only needed if you are going to enable list item modern audience)

Features

This Web Part illustrates the following concepts on top of the SharePoint Framework:

Video

Building List Search web part for showing data flexibly from lists or libraries

Help

We do not support samples, but this community is always willing to help, and we want to improve these samples. We use GitHub to track issues, which makes it easy for community members to volunteer their time and help resolve issues.

If you're having issues building the solution, please run spfx doctor from within the solution folder to diagnose incompatibility issues with your environment.

You can try looking at issues related to this sample to see if anybody else is having the same issues.

You can also try looking at discussions related to this sample and see what the community is saying.

If you encounter any issues while using this sample, create a new issue.

For questions regarding this sample, create a new question.

Finally, if you have an idea for improvement, make a suggestion.

Disclaimer

THIS CODE IS PROVIDED AS IS WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING ANY IMPLIED WARRANTIES OF FITNESS FOR A PARTICULAR PURPOSE, MERCHANTABILITY, OR NON-INFRINGEMENT.