IPropertyPaneConfiguration interface

Page to be displayed on the PropertyPane.

currentPage?: number;

Property Value

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.

Whether to avoid showing the audience picker that allows configuration of which audiences can see this web part.

disableAudiencePicker?: boolean;

Property Value

Whether to disable trapping focus inside property pane.

disableFocusTrap?: boolean;

Property Value

Whether or not to show the "Visibility" group in the property pane.

disableVisibilityGroup?: boolean;

Property Value

Remarks

This property was created since this group should only be available for overall web part configuration, not individual items within web parts (e.g., links in quick links). Note: This group is available to 1p/3p web parts, so we may consider releasing this api for more 3p control.

Number of milliseconds to be delayed before the loading indicator is shown on the property pane.

loadingIndicatorDelayTime?: number;

Property Value

Remarks

The default value is 500.

Total number of pages on the PropertyPane.

pages: IPropertyPanePage[];

Property Value

Type of pages to be displayed on the PropertyPane. By default, it works as 'Pages' for multi pages property pane.

pagesType?: PagesType;

Property Value

Indicates whether the loading indicator should be displayed on top of the property pane or not.

showLoadingIndicator?: boolean;

Property Value

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.