IClientSideComponentManifest interface
基于 SharePoint 框架构建的所有客户端组件都需要有效的组件清单。 此接口表示所有类型的客户端组件（如应用程序和 Web 部件）所需的属性。 特定于组件的清单将扩展此接口，以添加该组件类型所需的属性。
注解
此清单的架构由Microsoft拥有和版本控制。 更改此架构时，应遵循以下规则。 此规则集也可以称为“清单升级规则”。
对于次要更改，可以向后兼容的方式将新属性添加到此架构。 即处理清单的代码应能够处理这些新属性的缺失。
尝试将更改建模为次要 SemVer 增量。 应避免主要版本更改，因为它们会给开发人员带来迁移成本。
'manifestVersion'对于所有小更改或大更改，应颠簸 。
属性
| alias | 通常由开发人员提供的短名称。 它不需要本地化，预计在组件的生存期内保持不变。 如果应用程序替代 属性 |
| component |
客户端组件的类型。 类型为“Application”的组件由“IClientSideApplicationManifest”接口定义。 具有“WebPart”类型的组件由“IClientSideWebPartManifest”接口定义。 具有“库”类型的组件由“IClientSideLibraryManifest”接口定义。 具有“AdaptiveCardExtension”类型的组件由“IAdaptiveCardExtensionManifest”接口定义。 |
| experimental |
未准备好用于生产的实验标志的未类型化属性包。 |
| isolated |
组件应在其上运行的域。 |
| loader |
配置中的这一部分介绍了客户端如何加载和初始化组件。 它包含组件所需的脚本枚举以及单个入口点脚本。 |
| load |
此属性用于保留未显式使用构造 CSS 的旧组件。 在大多数情况下，使用 spfx 1.1 后生成的 Web 部件不需要这样做。 |
| preload |
必须随此组件一起预加载的组件清单列表。 这些资源可能包括初始呈现期间所需的外部资源，或应仅按需加载的组件。 |
| requires |
如果为 true，则组件在不允许运行自定义脚本的站点上的行为如下： - 当组件是 Web 部件时，该组件在 Web 部件选取器中不可用 - 在允许运行自定义脚本时添加到页面的组件的每个实例将不再出现在这些页面中。 作者在编辑页面时仍能够删除这些组件 |
| safe |
提供此属性是为了向后兼容。 它不再有任何影响。 |
| version | 客户端组件版本。 此字段的值应由客户端组件的开发人员控制。 |
属性详细信息
alias
通常由开发人员提供的短名称。 它不需要本地化，预计在组件的生存期内保持不变。 如果应用程序替代 属性 ClientSideApplication.alias ， ClientSideApplication.alias 则 优先于清单中提供的值。
alias: string;属性值
string
注解
用法：开发人员用于标识客户端组件的短名称。
支持的值：允许的字符为 a-z、A-Z 和“-”。 不超过 40 个字符。
例如："NewFeed"
componentType
客户端组件的类型。 类型为“Application”的组件由“IClientSideApplicationManifest”接口定义。 具有“WebPart”类型的组件由“IClientSideWebPartManifest”接口定义。 具有“库”类型的组件由“IClientSideLibraryManifest”接口定义。 具有“AdaptiveCardExtension”类型的组件由“IAdaptiveCardExtensionManifest”接口定义。
componentType: ComponentType;属性值
注解
用法：帮助根据组件的内容捆绑、加载、枚举和初始化组件。
支持的值： "Application"、 "WebPart"、、 "Library"、 "Extension"、 "AdaptiveCardExtension"
experimentalData
注意
此 API 以预览状态提供给开发者，可能根据我们收到的反馈更改。 请勿在生产环境中使用此 API。
未准备好用于生产的实验标志的未类型化属性包。
experimentalData?: {
[key: string]: any;
};属性值
{ [key: string]: any; }
isolatedDomain
注意
此 API 以预览状态提供给开发者，可能根据我们收到的反馈更改。 请勿在生产环境中使用此 API。
组件应在其上运行的域。
isolatedDomain?: string;属性值
string
注解
例如：'PrepSPO-appFEEAB5CE1CB0421FB1AAE5D09E0A8AAA.spgrid.com'
loaderConfig
注意
此 API 以预览状态提供给开发者，可能根据我们收到的反馈更改。 请勿在生产环境中使用此 API。
配置中的这一部分介绍了客户端如何加载和初始化组件。 它包含组件所需的脚本枚举以及单个入口点脚本。
loaderConfig: IClientSideComponentLoaderConfiguration;属性值
注解
用法：加载组件。
有关详细信息和示例，请参阅 IClientSideComponentLoaderConfiguration 。
loadLegacyFabricCss
此属性用于保留未显式使用构造 CSS 的旧组件。 在大多数情况下，使用 spfx 1.1 后生成的 Web 部件不需要这样做。
loadLegacyFabricCss?: boolean;属性值
boolean
preloadComponents
注意
此 API 以预览状态提供给开发者，可能根据我们收到的反馈更改。 请勿在生产环境中使用此 API。
必须随此组件一起预加载的组件清单列表。 这些资源可能包括初始呈现期间所需的外部资源，或应仅按需加载的组件。
preloadComponents?: string[];属性值
string[]
注解
支持的值：清单 ID 的数组
例如：[ "66665f5e-307f-41cf-9fec-17c5ea20f0ca", "2d02eafb-eb82-47d2-98ac-dcac4aa63969" ]
requiresCustomScript
如果为 true，则组件在不允许运行自定义脚本的站点上的行为如下： - 当组件是 Web 部件时，该组件在 Web 部件选取器中不可用 - 在允许运行自定义脚本时添加到页面的组件的每个实例将不再出现在这些页面中。 作者在编辑页面时仍能够删除这些组件
requiresCustomScript?: boolean;属性值
boolean
注解
默认值为 false。 有关详细信息，请参阅 https://support.office.com/en-us/article/Turn-scripting-capabilities-on-or-off-1f2c515f-5d7e-448a-9fd7-835da935584f。
用法：需要允许自定义脚本才能安装和运行此组件。
safeWithCustomScriptDisabled
警告
现已弃用此 API。
Use requiresCustomScript instead of safeWithCustomScriptDisabled.
提供此属性是为了向后兼容。 它不再有任何影响。
safeWithCustomScriptDisabled?: boolean;属性值
boolean
version
客户端组件版本。 此字段的值应由客户端组件的开发人员控制。
version: string;属性值
string
注解
此字段的用途是帮助客户端组件开发人员以托管方式升级其客户端组件。 这有助于客户端组件的使用者决定何时以及如何升级客户端组件。 当开发人员改进其客户端组件的代码时，他们可以决定使用组件的 MAJOR、MINOR 或 PATCH 版本。
所有不兼容的 API 更改都应导致主要版本颠簸。 向后兼容的功能更改应会导致 MINOR 版本颠簸，向后兼容的 bug 修复应会导致 PATCH 版本颠簸。 有关如何管理组件的版本的更多详细信息，请参阅 http://semver.org 。
用法：以受控方式安全地对客户端组件进行版本控制和演变。
支持的值：表示 语义版本的 字符串，即 MAJOR。次要。补丁
例如："1.0.0"