IClientSideComponentLoaderConfiguration interface

注意

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

此接口描述 SharePoint 客户端框架如何加载和初始化客户端组件。 它包含用于加载入口点脚本及其依赖项脚本的所有数据。

属性

entryModuleId

这是“scriptResources”字典中其中一个条目的 ID。

exportName

“entryModuleId”字段引用的模块可以导出具有多个字段的对象。

internalModuleBaseUrls

这是一个完全限定路径的数组,这些路径将附加到每个具有“内部”或“本地化”类型的脚本资源路径。 如果加载失败,加载程序将尝试从下一个加载,直到没有剩余的基本路径。

scriptResources

这是命名脚本资源的字典。 pathlocalizedPath 模块可以相互引用, manifest 模块应由框架运行时提供。 中 entryModuleId 名为 的资源必须包含组件的导出对象。

属性详细信息

entryModuleId

注意

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

这是“scriptResources”字典中其中一个条目的 ID。

entryModuleId: string;

属性值

string

注解

加载程序将下载并评估此字段中引用的脚本资源,解析针对“scriptResources”中的键的所有依赖项,并将导出的对象返回到加载程序的调用函数。 在“scriptResources”字典中引用的条目必须是“internal”或“localized”类型。

支持的值:“scriptResources”字典中的一个条目,用于定义组件的基导出模块。

例如:"myApplication.bundle"

exportName

注意

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

“entryModuleId”字段引用的模块可以导出具有多个字段的对象。

exportName?: string;

属性值

string

注解

此值(可选)引用由 字段引用的模块导出的对象上的 entryModuleId 字段的名称。 如果此字段具有值,则加载此清单时,将返回由该字段引用 entryModuleId 的模块导出的对象上引用字段的值,而不是基本导出的对象。 例如,如果 entryModuleId 引用了具有顶级导出和 的 { foo: 'bar', baz: 123 } 模块:

  • 如果未设置此字段,则模块加载程序返回的值为 { foo: 'bar', baz: 123 }

  • 如果此字段设置为 foo,则模块加载程序返回的值为 bar

  • 如果此字段设置为 bar,则模块加载程序返回的值未定义 (因为 bar 不是顶级导出) 中的键。

例如:mySpWebpart

internalModuleBaseUrls

注意

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

这是一个完全限定路径的数组,这些路径将附加到每个具有“内部”或“本地化”类型的脚本资源路径。 如果加载失败,加载程序将尝试从下一个加载,直到没有剩余的基本路径。

internalModuleBaseUrls: string[];

属性值

string[]

注解

没有完全限定 URL 作为其“路径”字段值的所有“内部”和“本地化”脚本资源都必须托管在此属性中列出的每个路径下。 例如,如果内部模块的“路径”字段值为 "master_2015-04-20/my-application.bundle_1928f8a0.js" ,并且此字段的值为 [ "https://contoso.akamaihd.net/files/", "https://contoso.msecnd.net/files/" ],则加载程序将首先尝试从 URL "https://contoso.akamaihd.net/files/master_2015-04-20/my-application.bundle_1928f8a0.js"加载此脚本资源。 如果从该 URL 加载失败,加载程序将尝试从 "https://contoso.msecnd.net/files/master_2015-04-20/my-application.bundle_1928f8a0.js"加载此脚本资源。 如果该 URL 无法加载,组件将无法加载,并且将返回错误。 请务必注意,对多个基 URL 的支持纯粹是为了故障转移支持。 这意味着所有文件必须存在于此字段中列出的所有主机上。

用法:具有“内部”或“本地化”类型的脚本资源的基 URL。

支持的值:包含“scriptResources”字典中引用的所有内部脚本的任何 URL。

例如:[ "https://contoso.akamaihd.net/files/", "https://contoso.msecnd.net/files/" ]

scriptResources

注意

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

这是命名脚本资源的字典。 pathlocalizedPath 模块可以相互引用, manifest 模块应由框架运行时提供。 中 entryModuleId 名为 的资源必须包含组件的导出对象。

scriptResources: {
        [name: string]: IModuleConfiguration;
    };

属性值

{ [name: string]: IModuleConfiguration; }

注解

支持的值:命名脚本资源的字典。

示例:

 {
   "myApplication.bundle": {
     "type": "path",
     "path": "master_2015-04-20/my-application.bundle_1928f8a0.js"
   },
   "@microsoft/sp-client-base": {
     "type": "component",
     "id": "af59c2b3-2da7-41fd-8b72-3939817960af",
     "version": "latest"
   },
   "@microsoft/sp-client-preview": {
     "type": "component",
     "id": "4d5eb168-6729-49a8-aec7-0e397f486b6e",
     "version": "latest"
   },
   "jQuery": {
     "type": "component",
     "id": "00000000-0000-0000-0000-000000000000",
     "version": "2.2.4",
     "path": "https://code.jquery.com/jquery-2.2.4.min.js"
   },
   "myApplication_strings": {
     "type": "localizedPath",
     "defaultPath": "master_2015-04-20/my-application_strings_default_af378e0d.js",
     "paths": {
       "en-us": "master_2015-04-20/my-application_strings_en-us_d38ff012.js",
       "fr-fr": "master_2015-04-20/my-application_strings_fr-fr_138af7e4.js"
     }
   }
 }