IClientSideComponentLoaderConfiguration interface

Пакет:

@microsoft/sp-module-interfaces

Примечание

Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.

В этом интерфейсе описывается загрузка и инициализация клиентской платформой SharePoint компонента на стороне клиента. Он содержит все данные для загрузки скрипта точки входа и его скриптов зависимостей.

Свойства

entryModuleId	Это идентификатор одной из записей в словаре scriptResources.
exportName	Модуль, на который ссылается поле entryModuleId, может экспортировать объект с несколькими полями.
internalModuleBaseUrls	Это массив полных путей, которые должны быть добавлены к каждому из путей к ресурсам скрипта с типом "internal" или "localized". Если не удается загрузить один из них, загрузчик будет пытаться загрузить из следующего, пока не останется базовых путей.
scriptResources	Это словарь именованных ресурсов скрипта. path и localizedPath модули могут ссылаться друг на друга, и manifest ожидается, что модули будут предоставлены средой выполнения платформы. Ресурс с именем в entryModuleId должен содержать экспортируемый объект компонента.

Сведения о свойстве

entryModuleId

Примечание

Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.

Это идентификатор одной из записей в словаре scriptResources.

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 в рабочей среде.

Это массив полных путей, которые должны быть добавлены к каждому из путей к ресурсам скрипта с типом "internal" или "localized". Если не удается загрузить один из них, загрузчик будет пытаться загрузить из следующего, пока не останется базовых путей.

internalModuleBaseUrls: string[];

Значение свойства

string[]

Комментарии

Все "внутренние" и "локализованные" ресурсы скриптов, которые не имеют полных URL-адресов в качестве значений полей "путь", должны размещаться в каждом из путей, перечисленных в этом свойстве. Например, если значение поля path внутреннего модуля равно "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-адреса для ресурсов скриптов с типом "internal" или "localized".

Поддерживаемые значения: любой URL-адрес, содержащий все внутренние скрипты, на которые ссылается словарь scriptResources.

Пример: [ "https://contoso.akamaihd.net/files/", "https://contoso.msecnd.net/files/" ]

scriptResources

Примечание

Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.

Это словарь именованных ресурсов скрипта. path и localizedPath модули могут ссылаться друг на друга, и 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"