-
Notifications
You must be signed in to change notification settings - Fork 5
sp webpart base.propertypanecustomfield
Home > @microsoft/sp-webpart-base > PropertyPaneCustomField
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.
Warning: This API is now obsolete.
This is obsolete now. This function has been moved to
@microsoft/sp-property-pane. Please consume it from there.
Helper method to create a custom field on the PropertyPane.
Signature:
export declare function PropertyPaneCustomField(properties: IPropertyPaneCustomFieldProps): IPropertyPaneField<IPropertyPaneCustomFieldProps>;| Parameter | Type | Description |
|---|---|---|
| properties | IPropertyPaneCustomFieldProps | Strongly typed Custom field properties. |
Returns:
IPropertyPaneField<IPropertyPaneCustomFieldProps>
The purpose of the custom field is to help the web part developer to add a custom control to the PropertyPane. The PropertyPane supports a host of inbuilt field types. While this list meets the demands of most web parts, but there are exceptional cases when web parts have special needs and need a special control. The custom field helps fill that gap.