he Lightning Filter Web Part is a modern SharePoint SPFx Client Side Web Part that can be added to any modern SharePoint page to provide filter values through web part connections to a consuming web part. Lightning Filters provides an interface for configuring the filter controls for Choice Filters, Date Time Filters, Text Filters, Number Filters, and People Filters.
Modern SharePoint Filter Web Part
The Lightning Filter Web Part is a Modern SharePoint Filter Web Part built upon the Microsoft SharePoint Framework SPFx. Using the Lightning Filter web part, you can provide dynamic data connections to consuming web parts such as the Lightning Conductor or a custom Client Side Web Part that you have built for your organisation. The following documentation describes how to build a consuming SPFx Client Side Web Part.
Multiple Filter Types
The Lightning Filter web part can provide the dynamic data connections based upon Choices, Number, People, Text, and Date . Add the choice values and display text through the web part properties, and consume the connected values via dynamic data connections.
The Number filter type is useful to connect to columns such as “Percentage Complete” within a Task List, or Items in Stock represented as a number. Lightning Filters can be set to allow a single number, or a number range such as 50-100. Values can be input using slider controls or standard fields.
Modern Date Filter Web Part
Using the Modern Date Filter Web Part capabilities, you can provide a single date or a date range to a consuming web part. The date values can be consumed by the Lightning Conductor, or a custom client side web part.
Connecting to Modified Date, or Created Date either as a single date or a date range will help you to find all content created within a specific time period. Default values can be set so that documents created in the last year for example are always displayed on the page, but can be filtered further using Lightning Filters.
Using the Modern SharePoint Filter Web Part
The Lightning Filter Web Part is license exempt. Use the Lightning Filter Web Part as a filter provider for your own custom web parts, or the Lightning Conductor Web Part in order to filter columns or apply conditional formatting values.
Download a Sample SPFx Project
If you want to build your own SharePoint Framework SPFx Client Side Web Part that can consume a web part connection filter from Lightning Filters, why not get started with our example project and documentation which you can download here!