@microsoft/sp-property-pane package

SharePoint 框架属性窗格。

接口

IDynamicDataSharedPropertyConfiguration	与共享属性相关的配置。
IDynamicDataSharedPropertyFilters	属性窗格动态数据属性筛选器。
IDynamicDataSharedSourceConfiguration	与共享源相关的配置。
IDynamicDataSharedSourceFilters	属性窗格动态数据源筛选器。
IGuidSet	表示列表项的 GUID 集。
IPopupWindowProps	弹出窗口属性。
IPropertyPaneButtonProps	PropertyPane 按钮属性。
IPropertyPaneCheckboxProps	PropertyPane 复选框组件属性。
IPropertyPaneChoiceGroupOption	PropertyPane ChoiceGroup 选项属性。
IPropertyPaneChoiceGroupOptionIconProps	PropertyPane ChoiceGroup 图标属性。
IPropertyPaneChoiceGroupProps	PropertyPane ChoiceGroup 属性。
IPropertyPaneConditionalGroup	属性窗格条件组。
IPropertyPaneConfiguration	Web 部件配置设置
IPropertyPaneCustomFieldProps	PropertyPane CustomPropertyField 属性。
IPropertyPaneDebounceProperty	属性窗格属性的定义，该属性应具有 onPropertyPaneFieldChanged 取消启动事件。
IPropertyPaneDropdownCalloutProps	PropertyPane 下拉列表标注属性。
IPropertyPaneDropdownOption	PropertyPane 下拉选项。
IPropertyPaneDropdownProps	PropertyPane 下拉组件属性。
IPropertyPaneDynamicFieldProps	PropertyPaneDynamicField 属性。
IPropertyPaneDynamicFieldSetProps	PropertyPane DynamicFieldSet 属性。
IPropertyPaneDynamicTextFieldProps	PropertyPaneDynamicData 组件属性。
IPropertyPaneField	PropertyPane 字段。
IPropertyPaneGroup	PropertyPane 组。 组是 PropertyPanePage 的一部分。
IPropertyPaneHeadingProps	PropertyPaneHeader 组件属性。
IPropertyPaneIconPickerProps	PropertyPaneIconPicker 组件属性
IPropertyPaneLabelProps	PropertyPaneLabel 组件属性。
IPropertyPaneLinkProps	PropertyPaneLink 组件属性。
IPropertyPanePage	PropertyPanePage 接口。
IPropertyPanePageHeader	PropertyPane 标头。 此标头对所有页面保持相同。
IPropertyPaneSliderProps	PropertyPaneSliderProps 组件属性。
IPropertyPaneSpinButtonProps	PropertyPaneSpinButton 组件属性。
IPropertyPaneTextFieldProps	PropertyPaneTextField 组件属性。
IPropertyPaneThumbnailPickerProps	PropertyPaneThumbnailPicker 组件属性
IPropertyPaneToggleProps	PropertyPaneToggle 组件属性。
IThumbnailFabricReactIcon	与结构图标缩略图相关的选项。
IThumbnailIconSizeImage	与图标大小图像缩略图相关的选项。
IThumbnailImage	与图像缩略图相关的选项。

类型别名

ImageFit	可用于适合图像的可能方法。
IPropertyPaneDynamicFieldFilters	属性窗格动态字段筛选器，它是源筛选器和属性筛选器的交集。
IThumbnail	要配置的缩略图图像的类型。
PropertyPaneHeadingLevel	标题级别的类型，h1-h6
ThumbnailType	支持的缩略图图像类型。

枚举

DynamicDataSharedDepth	动态数据引用的可能深度的枚举。
PagesType	多页属性窗格的页面显示类型。
PopupWindowPosition	弹出窗口的位置。
PropertyPaneButtonType	所有受支持的按钮类型的枚举。
PropertyPaneDropdownOptionType	指定 PropertyPaneDropdown () 呈现的下拉菜单中的选项类型。
PropertyPaneFieldType	所有受支持 PropertyPane 字段类型的枚举。 名称应与 office-ui-fabric-react 中的保持一致，请注意正确的字母大小写形式。

函数

PropertyPaneButton(targetProperty, properties)	可在 PropertyPane 上创建按钮的 Helper 方法。
PropertyPaneCheckbox(targetProperty, properties)	可在 PropertyPane 上创建复选框的 Helper 方法。
PropertyPaneChoiceGroup(targetProperty, properties)	可在 PropertyPane 上创建选项组的 Helper 方法。
PropertyPaneCustomField(properties)	帮助程序方法，用于在 PropertyPane 上创建自定义字段。
PropertyPaneDropdown(targetProperty, properties)	可在 PropertyPane 上创建下拉列表的 Helper 方法。
PropertyPaneDynamicField(targetProperty, properties)	帮助程序方法，用于在 PropertyPane 上为动态字段创建动态数据小组件。
PropertyPaneDynamicFieldSet(properties)	帮助程序方法，用于在属性窗格上为具有通用数据源的一组动态字段创建动态数据小组件。 这些字段可能基于关联的筛选器共享同一属性。
PropertyPaneDynamicTextField(targetProperty, properties)	在 PropertyPane 上创建动态 TextField 的帮助程序方法。
PropertyPaneHeading(targetProperty, properties)	用于在 PropertyPane 上创建标题的帮助程序方法。 等待重新设计时的临时解决方案
PropertyPaneHorizontalRule()	可在 PropertyPane 上创建水平规则的 Helper 方法。
PropertyPaneIconPicker(targetProperty, properties)	在 PropertyPane 上创建 IconPicker 的帮助程序方法。
PropertyPaneLabel(targetProperty, properties)	可在 PropertyPane 上创建标签的 Helper 方法。
PropertyPaneLink(targetProperty, properties)	可在 PropertyPane 上创建链接的 Helper 方法。
PropertyPaneSlider(targetProperty, properties)	可在 PropertyPane 上创建滑块的 Helper 方法。
PropertyPaneSpinButton(targetProperty, properties)	在属性窗格上创建 SpinButton 的帮助程序方法。
PropertyPaneTextField(targetProperty, properties)	可在 PropertyPane 上创建文本字段的 Helper 方法。
PropertyPaneThumbnailPicker(targetProperty, properties)	用于在 PropertyPane 上创建 ThumbnailPicker 的帮助程序方法。
PropertyPaneToggle(targetProperty, properties)	可在 PropertyPane 上创建切换的 Helper 方法。

函数详细信息

PropertyPaneButton(targetProperty, properties)

可在 PropertyPane 上创建按钮的 Helper 方法。

export declare function PropertyPaneButton(targetProperty: string, properties: IPropertyPaneButtonProps): IPropertyPaneField<IPropertyPaneButtonProps>;

参数

targetProperty

string

按钮相关的目标属性。

properties

IPropertyPaneButtonProps

强键入的按钮属性。

返回

IPropertyPaneField<IPropertyPaneButtonProps>

PropertyPaneCheckbox(targetProperty, properties)

可在 PropertyPane 上创建复选框的 Helper 方法。

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

参数

targetProperty

string

复选框相关的目标属性。

properties

IPropertyPaneCheckboxProps

强键入的复选框属性。

返回

IPropertyPaneField<IPropertyPaneCheckboxProps>

PropertyPaneChoiceGroup(targetProperty, properties)

可在 PropertyPane 上创建选项组的 Helper 方法。

export declare function PropertyPaneChoiceGroup(targetProperty: string, properties: IPropertyPaneChoiceGroupProps): IPropertyPaneField<IPropertyPaneChoiceGroupProps>;

参数

targetProperty

string

选项组相关的目标属性。

properties

IPropertyPaneChoiceGroupProps

强键入的选项组属性。

返回

IPropertyPaneField<IPropertyPaneChoiceGroupProps>

PropertyPaneCustomField(properties)

注意

此 API 以预览状态提供给开发者，可能根据我们收到的反馈更改。 请勿在生产环境中使用此 API。

帮助程序方法，用于在 PropertyPane 上创建自定义字段。

export declare function PropertyPaneCustomField(properties: IPropertyPaneCustomFieldProps): IPropertyPaneField<IPropertyPaneCustomFieldProps>;

参数

properties

IPropertyPaneCustomFieldProps

强类型自定义字段属性。

返回

IPropertyPaneField<IPropertyPaneCustomFieldProps>

注解

自定义字段的用途是帮助 Web 部件开发人员将自定义控件添加到 PropertyPane。 PropertyPane 支持大量内置字段类型。 虽然此列表满足大多数 Web 部件的要求，但在 Web 部件具有特殊需求且需要特殊控件时，也有例外的情况。 自定义字段有助于填补这一空白。

PropertyPaneDropdown(targetProperty, properties)

可在 PropertyPane 上创建下拉列表的 Helper 方法。

export declare function PropertyPaneDropdown(targetProperty: string, properties: IPropertyPaneDropdownProps): IPropertyPaneField<IPropertyPaneDropdownProps>;

参数

targetProperty

string

下拉列表相关的目标属性。

properties

IPropertyPaneDropdownProps

强键入的下拉列表属性。

返回

IPropertyPaneField<IPropertyPaneDropdownProps>

PropertyPaneDynamicField(targetProperty, properties)

帮助程序方法，用于在 PropertyPane 上为动态字段创建动态数据小组件。

export declare function PropertyPaneDynamicField(targetProperty: string, properties: IPropertyPaneDynamicFieldProps): IPropertyPaneField<IPropertyPaneDynamicFieldProps>;

参数

targetProperty

string

动态数据小组件关联的目标属性。

properties

IPropertyPaneDynamicFieldProps

返回

IPropertyPaneField<IPropertyPaneDynamicFieldProps>

PropertyPaneDynamicFieldSet(properties)

帮助程序方法，用于在属性窗格上为具有通用数据源的一组动态字段创建动态数据小组件。

这些字段可能基于关联的筛选器共享同一属性。

export declare function PropertyPaneDynamicFieldSet(properties: IPropertyPaneDynamicFieldSetProps): IPropertyPaneField<IPropertyPaneDynamicFieldSetProps>;

参数

properties

IPropertyPaneDynamicFieldSetProps

包含条目和选项，如下所述：条目 - 由小组件配置的一组条目。 每个条目都包含目标属性以及（可选）要显示的标签。 options - 为给定的动态字段集启用回调、筛选器等自定义值的选项。

返回

IPropertyPaneField<IPropertyPaneDynamicFieldSetProps>

PropertyPaneDynamicTextField(targetProperty, properties)

警告

现已弃用此 API。

• This has been replaced by PropertyPaneDynamicField

注意

此 API 以预览状态提供给开发者，可能根据我们收到的反馈更改。 请勿在生产环境中使用此 API。

在 PropertyPane 上创建动态 TextField 的帮助程序方法。

export declare function PropertyPaneDynamicTextField(targetProperty: string, properties: IPropertyPaneDynamicTextFieldProps): IPropertyPaneField<IPropertyPaneDynamicTextFieldProps>;

参数

targetProperty

string

动态文本域关联到的目标属性。

properties

IPropertyPaneDynamicTextFieldProps

PropertyPaneDynamicTextField 的属性。

返回

IPropertyPaneField<IPropertyPaneDynamicTextFieldProps>

PropertyPaneHeading(targetProperty, properties)

注意

此 API 以预览状态提供给开发者，可能根据我们收到的反馈更改。 请勿在生产环境中使用此 API。

用于在 PropertyPane 上创建标题的帮助程序方法。 等待重新设计时的临时解决方案

export declare function PropertyPaneHeading(targetProperty: string, properties: IPropertyPaneHeadingProps): IPropertyPaneField<IPropertyPaneHeadingProps>;

参数

targetProperty

string

标记相关的目标属性。

properties

IPropertyPaneHeadingProps

强键入的标记属性。

返回

IPropertyPaneField<IPropertyPaneHeadingProps>

PropertyPaneHorizontalRule()

可在 PropertyPane 上创建水平规则的 Helper 方法。

export declare function PropertyPaneHorizontalRule(): IPropertyPaneField<void>;

返回

IPropertyPaneField<void>

PropertyPaneIconPicker(targetProperty, properties)

注意

此 API 以预览状态提供给开发者，可能根据我们收到的反馈更改。 请勿在生产环境中使用此 API。

在 PropertyPane 上创建 IconPicker 的帮助程序方法。

export declare function PropertyPaneIconPicker(targetProperty: string, properties: IPropertyPaneIconPickerProps): IPropertyPaneField<IPropertyPaneIconPickerProps>;

参数

targetProperty

string

图标选取器关联的目标属性。

properties

IPropertyPaneIconPickerProps

强类型 IconPicker 属性。

返回

IPropertyPaneField<IPropertyPaneIconPickerProps>

PropertyPaneLabel(targetProperty, properties)

可在 PropertyPane 上创建标签的 Helper 方法。

export declare function PropertyPaneLabel(targetProperty: string, properties: IPropertyPaneLabelProps): IPropertyPaneField<IPropertyPaneLabelProps>;

参数

targetProperty

string

标记相关的目标属性。

properties

IPropertyPaneLabelProps

强键入的标记属性。

返回

IPropertyPaneField<IPropertyPaneLabelProps>

PropertyPaneLink(targetProperty, properties)

可在 PropertyPane 上创建链接的 Helper 方法。

export declare function PropertyPaneLink(targetProperty: string, properties: IPropertyPaneLinkProps): IPropertyPaneField<IPropertyPaneLinkProps>;

参数

targetProperty

string

链接相关的目标属性。

properties

IPropertyPaneLinkProps

强键入的链接属性。

返回

IPropertyPaneField<IPropertyPaneLinkProps>

PropertyPaneSlider(targetProperty, properties)

可在 PropertyPane 上创建滑块的 Helper 方法。

export declare function PropertyPaneSlider(targetProperty: string, properties: IPropertyPaneSliderProps): IPropertyPaneField<IPropertyPaneSliderProps>;

参数

targetProperty

string

滑块相关的目标属性。

properties

IPropertyPaneSliderProps

强键入的滑块属性。

返回

IPropertyPaneField<IPropertyPaneSliderProps>

PropertyPaneSpinButton(targetProperty, properties)

注意

此 API 以预览状态提供给开发者，可能根据我们收到的反馈更改。 请勿在生产环境中使用此 API。

在属性窗格上创建 SpinButton 的帮助程序方法。

export declare function PropertyPaneSpinButton(targetProperty: string, properties: IPropertyPaneSpinButtonProps): IPropertyPaneField<IPropertyPaneSpinButtonProps>;

参数

targetProperty

string

旋转按钮关联的目标属性。

properties

IPropertyPaneSpinButtonProps

强类型旋转按钮属性。

返回

IPropertyPaneField<IPropertyPaneSpinButtonProps>

PropertyPaneTextField(targetProperty, properties)

可在 PropertyPane 上创建文本字段的 Helper 方法。

export declare function PropertyPaneTextField(targetProperty: string, properties: IPropertyPaneTextFieldProps): IPropertyPaneField<IPropertyPaneTextFieldProps>;

参数

targetProperty

string

文本字段相关的目标属性。

properties

IPropertyPaneTextFieldProps

强键入的文本字段属性。

返回

IPropertyPaneField<IPropertyPaneTextFieldProps>

PropertyPaneThumbnailPicker(targetProperty, properties)

注意

此 API 以预览状态提供给开发者，可能根据我们收到的反馈更改。 请勿在生产环境中使用此 API。

用于在 PropertyPane 上创建 ThumbnailPicker 的帮助程序方法。

export declare function PropertyPaneThumbnailPicker(targetProperty: string, properties: IPropertyPaneThumbnailPickerProps): IPropertyPaneField<IPropertyPaneThumbnailPickerProps>;

参数

targetProperty

string

缩略图选取器关联的目标属性。

properties

IPropertyPaneThumbnailPickerProps

强类型 ThumbnailPicker 属性。

返回

IPropertyPaneField<IPropertyPaneThumbnailPickerProps>

PropertyPaneToggle(targetProperty, properties)

可在 PropertyPane 上创建切换的 Helper 方法。

export declare function PropertyPaneToggle(targetProperty: string, properties: IPropertyPaneToggleProps): IPropertyPaneField<IPropertyPaneToggleProps>;

参数

targetProperty

string

切换相关的目标属性。

properties

IPropertyPaneToggleProps

强键入的切换属性。

返回

IPropertyPaneField<IPropertyPaneToggleProps>