sp webpart base.propertypanecheckbox

Home > @microsoft/sp-webpart-base > PropertyPaneCheckbox

PropertyPaneCheckbox() function

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 Checkbox on the PropertyPane.

Signature:

export declare function PropertyPaneCheckbox(targetProperty: string, properties: IPropertyPaneCheckboxProps): IPropertyPaneField<IPropertyPaneCheckboxProps>;

Parameters

Parameter	Type	Description
targetProperty	string	Target property the checkbox is associated to.
properties	IPropertyPaneCheckboxProps	Strongly typed Checkbox properties.

Returns:

IPropertyPaneField<IPropertyPaneCheckboxProps>