Compartilhar via

IClientSideComponentLoaderConfiguration interface

  • Referência
Pacote:
@microsoft/sp-module-interfaces

Observação

Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.

Esta interface descreve como um componente do lado do cliente deve ser carregado e inicializado por uma arquitetura de cliente do SharePoint. Contém todos os dados para carregar um script de ponto de entrada e os respetivos scripts de dependência.

Propriedades

entryModuleId

Este é o ID de uma das entradas no dicionário "scriptResources".
exportName

O módulo referenciado pelo campo "entryModuleId" pode exportar um objeto com vários campos.
internalModuleBaseUrls

Trata-se de uma matriz de caminhos completamente qualificados a serem pré-anexados a cada um dos caminhos de recursos de script com o tipo "interno" ou "localizado". Se não for possível carregar, o carregador tentará carregar a partir do seguinte até não existirem caminhos de base restantes.
scriptResources

Este é um dicionário de recursos de script nomeados. path e localizedPath os módulos podem referenciar-se mutuamente e manifest espera-se que os módulos sejam fornecidos pelo runtime da arquitetura. O recurso com o entryModuleId nome no tem de conter o objeto exportado do componente.

Detalhes da propriedade

entryModuleId

Observação

Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.

Este é o ID de uma das entradas no dicionário "scriptResources".

entryModuleId: string;

Valor da propriedade

string

Comentários

O carregador irá transferir e avaliar o recurso de script referenciado neste campo, resolve todas as dependências em relação às chaves em "scriptResources" e devolverá o objeto exportado à função de chamada do carregador. A entrada referenciada no dicionário "scriptResources" tem de ser do tipo "interno" ou "localizado".

Valores suportados: uma entrada no dicionário "scriptResources" que define o módulo exportado base do componente.

Exemplo: "myApplication.bundle"

exportName

Observação

Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.

O módulo referenciado pelo campo "entryModuleId" pode exportar um objeto com vários campos.

exportName?: string;

Valor da propriedade

string

Comentários

Opcionalmente, este valor referencia o nome de um campo no objeto exportado pelo módulo referenciado pelo entryModuleId campo. Quando este campo tem um valor, o valor do campo referenciado no objeto exportado pelo módulo referenciado pelo entryModuleId campo é devolvido quando este manifesto é carregado em vez do objeto exportado de base. Por exemplo, se entryModuleId se referir a um módulo com uma exportação de nível superior de { foo: 'bar', baz: 123 } e:

  • se este campo não estiver definido, o valor devolvido pelo carregador do módulo é { foo: 'bar', baz: 123 }

  • se este campo estiver definido como foo, o valor devolvido pelo carregador do módulo é bar

  • se este campo estiver definido barcomo , o valor devolvido pelo carregador do módulo é indefinido (como bar não é uma chave na exportação de nível superior).

Exemplo: mySpWebpart

internalModuleBaseUrls

Observação

Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.

Trata-se de uma matriz de caminhos completamente qualificados a serem pré-anexados a cada um dos caminhos de recursos de script com o tipo "interno" ou "localizado". Se não for possível carregar, o carregador tentará carregar a partir do seguinte até não existirem caminhos de base restantes.

internalModuleBaseUrls: string[];

Valor da propriedade

string[]

Comentários

Todos os recursos de script "internos" e "localizados" que não tenham URLs completamente qualificados, uma vez que os respetivos valores de campo "path" têm de ser alojados em cada um dos caminhos listados nesta propriedade. Por exemplo, se o valor do campo "caminho" de um módulo interno for "master_2015-04-20/my-application.bundle_1928f8a0.js" e o valor deste campo for [ "https://contoso.akamaihd.net/files/", "https://contoso.msecnd.net/files/" ], o carregador tentará primeiro carregar este recurso de script a partir do URL "https://contoso.akamaihd.net/files/master_2015-04-20/my-application.bundle_1928f8a0.js". Se o carregamento desse URL falhar, o carregador tentará carregar este recurso de script a partir de "https://contoso.msecnd.net/files/master_2015-04-20/my-application.bundle_1928f8a0.js". Se esse URL não carregar, o componente não será carregado e será devolvido um erro. É importante ter em atenção que o suporte para vários URLs base é apenas para suporte de ativação pós-falha. Isto significa que todos os ficheiros têm de estar presentes em todos os anfitriões listados neste campo.

Utilização: URLs base para recursos de script com o tipo "interno" ou "localizado".

Valores suportados: qualquer URL que contenha todos os scripts internos referenciados no dicionário "scriptResources".

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

scriptResources

Observação

Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.

Este é um dicionário de recursos de script nomeados. path e localizedPath os módulos podem referenciar-se mutuamente e manifest espera-se que os módulos sejam fornecidos pelo runtime da arquitetura. O recurso com o entryModuleId nome no tem de conter o objeto exportado do componente.

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

Valor da propriedade

{ [name: string]: IModuleConfiguration; }

Comentários

Valores suportados: um dicionário de recursos de script nomeados.

Exemplo:

 {
   "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"
     }
   }
 }