sp-dev-fx-webparts/samples/react-custompropertypanecontrols/README.md

page_type	products	languages	extensions
sample	office-sp	javascript typescript	contentType technologies platforms createdDate samples SharePoint Framework React 1/1/2016 12:00:00 AM

Custom property pane controls built in React

Summary

Sample custom property pane controls built in React for use with SharePoint Framework client-side web parts.

Asynchronous drop-down

Drop-down that loads its options asynchronously.

This control supports promises and chaining for cascading drop-downs where value from one field determines values in other drop-down fields.

Drop-down with external data without using a custom control

Cascading drop-downs in the property pane both using external data.

Compatibility

Applies to

• SharePoint Framework Developer Preview
• Office 365 developer tenant

Solution

Solution	Author(s)
react-custompropertypanecontrols	Waldek Mastykarz (MVP, Rencore, @waldekm)
react-custompropertypanecontrols	Alex Terentiev (@alexaterentiev)

Version history

Version	Date	Comments
2.0.2	Jan 26, 2022	Upgraded to SPFx 1.14.0-beta.5. This new version contains updated API for showLoadingIndicator
2.0.1	May 1, 2017	Updated to SPFx GA
2.0.0	November 22, 2016	Added new sample web part (Dropdown with remote data (without custom controls))
1.0.0	October 17, 2016	Initial release

Minimal Path to Awesome

• clone this repo
• $ npm i
• $ gulp serve nobrowser

Asynchronous drop-down

By default the control uses mock data. If you want to test the control with SharePoint, change the commented sections in the DropdownWithRemoteDataWebPart.ts file inside the loadLists and loadItems functions and deploy the sample web part to your SharePoint developer tenant.

Drop-down with external data without using a custom control

By default the web part uses mock data. If you want to test it with SharePoint, change the commented sections in the DropdownWithRemoteDataWithoutCustomControlsWebPart.ts file inside the loadLists and loadItems methods and deploy the sample web part to your SharePoint tenant.

Features

Sample web parts in this solution illustrate the following concepts on top of the SharePoint Framework:

• using React for building custom property pane controls for use with SharePoint Framework client-side web parts
• building custom property pane controls using TypeScript
• updating web part properties from custom property pane controls
• linking multiple custom property pane controls together
• loading data for use in custom property pane controls asynchronously without blocking the web part
• forcing React components to repaint using an external trigger
• displaying a custom loading indicator
• reacting to web part property changes
• updating properties of web part property pane controls
• refreshing the web part property pane from the web part

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.