@microsoft/sp-webpart-base package
SharePoint 框架对生成 Web 部件的支持。
类
| BaseClientSideWebPart |
此抽象类实现客户端 Web 部件的基本功能。 每个客户端 Web 部件都需要从此类继承。 |
| BaseWebPart |
此抽象类为客户端 Web 部件实现与 UI 无关的基本功能。 目的是允许在 2D 和 MR Web 部件之间使用通用核心。 |
| BaseWebPartContext |
Web 部件上下文对象。 此对象包含可用于 Web 部件的上下文服务。 例如 http 客户端的上下文实例。 此基础将由特定于 UI 的 WebPart 基础进行扩展。 |
| WebPartContext |
Web 部件上下文对象。 此对象包含可用于 Web 部件的上下文服务。 例如 http 客户端的上下文实例。 |
接口
| IClientSideWebPartStatusRenderer |
由组件实现的接口，该组件应显示 Web 部件的加载指示器和错误消息。 |
| IDynamicDataSharedPropertyConfiguration |
与共享属性相关的配置。 |
| IDynamicDataSharedPropertyFilters |
属性窗格动态数据属性筛选器。 |
| IDynamicDataSharedSourceConfiguration |
与共享源相关的配置。 |
| IDynamicDataSharedSourceFilters |
属性窗格动态数据源筛选器。 |
| IMicrosoftTeams |
提供对 Teams SDK 和 Teams 上下文的访问权限。 仅在 Teams 中加载 Web 部件时提供。 |
| IPropertyPaneAccessor |
Web 部件上下文属性窗格访问器接口。 提供一些最常用的操作来访问属性窗格和内容面板。 |
| IPropertyPaneButtonProps |
PropertyPane 按钮属性。 |
| IPropertyPaneCheckboxProps |
PropertyPane 复选框组件属性。 |
| IPropertyPaneChoiceGroupOption |
PropertyPane ChoiceGroup 选项属性。 |
| IPropertyPaneChoiceGroupOptionIconProps |
PropertyPane ChoiceGroup 图标属性。 |
| IPropertyPaneChoiceGroupProps |
PropertyPane ChoiceGroup 属性。 |
| IPropertyPaneConditionalGroup |
属性窗格条件组。 |
| IPropertyPaneConfiguration |
Web 部件配置设置 |
| IPropertyPaneCustomFieldProps |
PropertyPane CustomPropertyField 属性。 |
| IPropertyPaneDropdownCalloutProps |
PropertyPane 下拉列表标注属性。 |
| IPropertyPaneDropdownOption |
PropertyPane 下拉选项。 |
| IPropertyPaneDropdownProps |
PropertyPane 下拉组件属性。 |
| IPropertyPaneDynamicFieldFilters |
属性窗格动态字段筛选器，它是源筛选器和属性筛选器的交集。 |
| IPropertyPaneDynamicFieldProps |
PropertyPaneDynamicField 属性。 |
| IPropertyPaneDynamicFieldSetProps |
PropertyPane DynamicFieldSet 属性。 |
| IPropertyPaneDynamicTextFieldProps |
|
| IPropertyPaneField |
PropertyPane 字段。 |
| IPropertyPaneGroup |
PropertyPane 组。 组是 PropertyPanePage 的一部分。 |
| IPropertyPaneLabelProps |
PropertyPaneLabel 组件属性。 |
| IPropertyPaneLinkProps |
PropertyPaneLink 组件属性。 |
| IPropertyPanePage |
PropertyPanePage 接口。 |
| IPropertyPanePageHeader |
PropertyPane 标头。 此标头对所有页面保持相同。 |
| IPropertyPaneSliderProps |
PropertyPaneSliderProps 组件属性。 |
| IPropertyPaneTextFieldProps |
PropertyPaneTextField 组件属性。 |
| IPropertyPaneToggleProps |
PropertyPaneToggle 组件属性。 |
| ISDKs |
SPFx 提供的条件 SDK 集依赖于环境。 |
| ISerializedWebPartData |
此结构表示 Web 部件的序列化状态的一部分，由该 Web 部件控制。 它由 IWebPartData 扩展，包含由框架添加到序列化数据的其他数据。 |
| IWebPartContext |
客户端 Web 部件的基本上下文接口。 |
| IWebPartData |
此结构表示 Web 部件的序列化状态。 |
| IWebPartPropertiesMetadata |
此结构用于将 Web 部件属性的元数据定义为字符串映射到 |
| IWebPartPropertyMetadata |
这是用于中的映射值的结构 |
枚举
| DynamicDataSharedDepth |
动态数据引用的可能深度的枚举。 |
| PropertyPaneButtonType |
所有受支持的按钮类型的枚举。 |
| PropertyPaneDropdownOptionType |
指定 PropertyPaneDropdown () 呈现的下拉菜单中的选项类型。 |
| PropertyPaneFieldType |
所有受支持 PropertyPane 字段类型的枚举。 名称应与 office-ui-fabric-react 中的保持一致，请注意正确的字母大小写形式。 |
| WebPartFormFactor |
Web 部件的外形规格。 |
函数
函数详细信息
PropertyPaneButton(targetProperty, properties)
警告
现已弃用此 API。
This is obsolete now. This function has been moved to @microsoft/sp-property-pane. Please consume it from there.
可在 PropertyPane 上创建按钮的 Helper 方法。
export declare function PropertyPaneButton(targetProperty: string, properties: IPropertyPaneButtonProps): IPropertyPaneField<IPropertyPaneButtonProps>;参数
- targetProperty
-
string
按钮相关的目标属性。
- properties
- IPropertyPaneButtonProps
强键入的按钮属性。
返回
注解
我们在此处留下了原始实现，以避免破坏公共 API 协定。
PropertyPaneCheckbox(targetProperty, properties)
警告
现已弃用此 API。
This is obsolete now. This function has been moved to @microsoft/sp-property-pane. Please consume it from there.
可在 PropertyPane 上创建复选框的 Helper 方法。
export declare function PropertyPaneCheckbox(targetProperty: string, properties: IPropertyPaneCheckboxProps): IPropertyPaneField<IPropertyPaneCheckboxProps>;参数
- targetProperty
-
string
复选框相关的目标属性。
- properties
- IPropertyPaneCheckboxProps
强键入的复选框属性。
返回
注解
我们在此处留下了原始实现，以避免破坏公共 API 协定。
PropertyPaneChoiceGroup(targetProperty, properties)
警告
现已弃用此 API。
This is obsolete now. This function has been moved to @microsoft/sp-property-pane. Please consume it from there.
可在 PropertyPane 上创建选项组的 Helper 方法。
export declare function PropertyPaneChoiceGroup(targetProperty: string, properties: IPropertyPaneChoiceGroupProps): IPropertyPaneField<IPropertyPaneChoiceGroupProps>;参数
- targetProperty
-
string
选项组相关的目标属性。
- properties
- IPropertyPaneChoiceGroupProps
强键入的选项组属性。
返回
注解
我们在此处留下了原始实现，以避免破坏公共 API 协定。
PropertyPaneCustomField(properties)
警告
现已弃用此 API。
This is obsolete now. This function has been moved to @microsoft/sp-property-pane. Please consume it from there.
注意
此 API 以预览状态提供给开发者，可能根据我们收到的反馈更改。 请勿在生产环境中使用此 API。
帮助程序方法，用于在 PropertyPane 上创建自定义字段。
export declare function PropertyPaneCustomField(properties: IPropertyPaneCustomFieldProps): IPropertyPaneField<IPropertyPaneCustomFieldProps>;参数
- properties
- IPropertyPaneCustomFieldProps
强类型自定义字段属性。
返回
注解
我们在此处留下了原始实现，以避免破坏公共 API 协定。
PropertyPaneDropdown(targetProperty, properties)
警告
现已弃用此 API。
This is obsolete now. This function has been moved to @microsoft/sp-property-pane. Please consume it from there.
可在 PropertyPane 上创建下拉列表的 Helper 方法。
export declare function PropertyPaneDropdown(targetProperty: string, properties: IPropertyPaneDropdownProps): IPropertyPaneField<IPropertyPaneDropdownProps>;参数
- targetProperty
-
string
下拉列表相关的目标属性。
- properties
- IPropertyPaneDropdownProps
强键入的下拉列表属性。
返回
注解
我们在此处留下了原始实现，以避免破坏公共 API 协定。
PropertyPaneDynamicField(targetProperty, properties)
警告
现已弃用此 API。
This is obsolete now. This function has been moved to @microsoft/sp-property-pane. Please consume it from there.
帮助程序方法，用于在 PropertyPane 上为动态字段创建动态数据小组件。
export declare function PropertyPaneDynamicField(targetProperty: string, properties: IPropertyPaneDynamicFieldProps): IPropertyPaneField<IPropertyPaneDynamicFieldProps>;参数
- targetProperty
-
string
动态数据小组件关联的目标属性。
- properties
- IPropertyPaneDynamicFieldProps
返回
注解
我们在此处留下了原始实现，以避免破坏公共 API 协定。
PropertyPaneDynamicFieldSet(properties)
警告
现已弃用此 API。
This is obsolete now. This function has been moved to @microsoft/sp-property-pane. Please consume it from there.
帮助程序方法，用于在属性窗格上为具有通用数据源的一组动态字段创建动态数据小组件。
这些字段可能基于关联的筛选器共享同一属性。
export declare function PropertyPaneDynamicFieldSet(properties: IPropertyPaneDynamicFieldSetProps): IPropertyPaneField<IPropertyPaneDynamicFieldSetProps>;参数
- properties
- IPropertyPaneDynamicFieldSetProps
包含条目和选项，如下所述：条目 - 由小组件配置的一组条目。 每个条目都包含目标属性以及（可选）要显示的标签。 options - 为给定的动态字段集启用回调、筛选器等自定义值的选项。
返回
注解
我们在此处留下了原始实现，以避免破坏公共 API 协定。
PropertyPaneDynamicTextField(targetProperty, properties)
警告
现已弃用此 API。
This has been replaced by PropertyPaneDynamicField and moved to @microsoft/sp-property-pane. Please consume it from there.
注意
此 API 以预览状态提供给开发者，可能根据我们收到的反馈更改。 请勿在生产环境中使用此 API。
在 PropertyPane 上创建动态 TextField 的帮助程序方法。
export declare function PropertyPaneDynamicTextField(targetProperty: string, properties: IPropertyPaneDynamicTextFieldProps): IPropertyPaneField<IPropertyPaneDynamicTextFieldProps>;参数
- targetProperty
-
string
动态文本域关联到的目标属性。
- properties
- IPropertyPaneDynamicTextFieldProps
PropertyPaneDynamicTextField 的属性。
返回
注解
我们在此处留下了原始实现，以避免破坏公共 API 协定。
PropertyPaneHorizontalRule()
警告
现已弃用此 API。
This is obsolete now. This function has been moved to @microsoft/sp-property-pane. Please consume it from there.
可在 PropertyPane 上创建水平规则的 Helper 方法。
export declare function PropertyPaneHorizontalRule(): IPropertyPaneField<void>;返回
IPropertyPaneField<void>
注解
我们在此处留下了原始实现，以避免破坏公共 API 协定。
PropertyPaneLabel(targetProperty, properties)
警告
现已弃用此 API。
This is obsolete now. This function has been moved to @microsoft/sp-property-pane. Please consume it from there.
可在 PropertyPane 上创建标签的 Helper 方法。
export declare function PropertyPaneLabel(targetProperty: string, properties: IPropertyPaneLabelProps): IPropertyPaneField<IPropertyPaneLabelProps>;参数
- targetProperty
-
string
标记相关的目标属性。
- properties
- IPropertyPaneLabelProps
强键入的标记属性。
返回
注解
我们在此处留下了原始实现，以避免破坏公共 API 协定。
PropertyPaneLink(targetProperty, properties)
警告
现已弃用此 API。
This is obsolete now. This function has been moved to @microsoft/sp-property-pane. Please consume it from there.
可在 PropertyPane 上创建链接的 Helper 方法。
export declare function PropertyPaneLink(targetProperty: string, properties: IPropertyPaneLinkProps): IPropertyPaneField<IPropertyPaneLinkProps>;参数
- targetProperty
-
string
链接相关的目标属性。
- properties
- IPropertyPaneLinkProps
强键入的链接属性。
返回
注解
我们在此处留下了原始实现，以避免破坏公共 API 协定。
PropertyPaneSlider(targetProperty, properties)
警告
现已弃用此 API。
This is obsolete now. This function has been moved to @microsoft/sp-property-pane. Please consume it from there.
可在 PropertyPane 上创建滑块的 Helper 方法。
export declare function PropertyPaneSlider(targetProperty: string, properties: IPropertyPaneSliderProps): IPropertyPaneField<IPropertyPaneSliderProps>;参数
- targetProperty
-
string
滑块相关的目标属性。
- properties
- IPropertyPaneSliderProps
强键入的滑块属性。
返回
注解
我们在此处留下了原始实现，以避免破坏公共 API 协定。
PropertyPaneTextField(targetProperty, properties)
警告
现已弃用此 API。
This is obsolete now. This function has been moved to @microsoft/sp-property-pane. Please consume it from there.
可在 PropertyPane 上创建文本字段的 Helper 方法。
export declare function PropertyPaneTextField(targetProperty: string, properties: IPropertyPaneTextFieldProps): IPropertyPaneField<IPropertyPaneTextFieldProps>;参数
- targetProperty
-
string
文本字段相关的目标属性。
- properties
- IPropertyPaneTextFieldProps
强键入的文本字段属性。
返回
注解
我们在此处留下了原始实现，以避免破坏公共 API 协定。
PropertyPaneToggle(targetProperty, properties)
警告
现已弃用此 API。
This is obsolete now. This function has been moved to @microsoft/sp-property-pane. Please consume it from there.
可在 PropertyPane 上创建切换的 Helper 方法。
export declare function PropertyPaneToggle(targetProperty: string, properties: IPropertyPaneToggleProps): IPropertyPaneField<IPropertyPaneToggleProps>;参数
- targetProperty
-
string
切换相关的目标属性。
- properties
- IPropertyPaneToggleProps
强键入的切换属性。
返回
注解
我们在此处留下了原始实现，以避免破坏公共 API 协定。