IPropertyPaneConfiguration interface
Web part configuration settings
Properties
| current |
Page to be displayed on the PropertyPane. |
| debounce |
List of properties to debounce the |
| disable |
Whether to disable trapping focus inside property pane. |
| loading |
Number of milliseconds to be delayed before the loading indicator is shown on the property pane. |
| pages | Total number of pages on the PropertyPane. |
| show |
Indicates whether the loading indicator should be displayed on top of the property pane or not. |
Property Details
currentPage
Page to be displayed on the PropertyPane.
currentPage?: number;Property Value
number
debounceProperties
Note
This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
List of properties to debounce the onPropertyPaneFieldChanged event.
debounceProperties?: IPropertyPaneDebounceProperty[];Property Value
Remarks
If your property pane is reactive, the onPropertyPaneFieldChanged event will fire with any change to the web part properties. This may lead to jank for some property pane controls or web parts. You can use this configuration property to debounce the onPropertyPaneFieldChanged event for the properties listed; other properties will be unaffected.
disableFocusTrap
Note
This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
Whether to disable trapping focus inside property pane.
disableFocusTrap?: boolean;Property Value
boolean
loadingIndicatorDelayTime
Number of milliseconds to be delayed before the loading indicator is shown on the property pane.
loadingIndicatorDelayTime?: number;Property Value
number
Remarks
The default value is 500.
pages
Total number of pages on the PropertyPane.
pages: IPropertyPanePage[];Property Value
showLoadingIndicator
Indicates whether the loading indicator should be displayed on top of the property pane or not.
showLoadingIndicator?: boolean;Property Value
boolean
Remarks
This feature is intended to be used when the user is waiting on a promise to resolve. If set to true, overlay loading indicator appears after 500ms (web part author can override this behavior by using overlayLoadingIndicator property).
The reason why we are not showing it immediately is that our intent is to never show the loading indicator. But in real life async requests could take long and it becomes necessary to display a loading indicator to the end user.