Compartilhar via

IClientSideComponentManifest interface

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

Todos os componentes do lado do cliente criados na arquitetura do SharePoint precisam de um manifesto de componente válido. Esta interface representa propriedades que são necessárias para todos os tipos de componentes do lado do cliente, como Aplicações e Peças Web. Os manifestos específicos do componente irão expandir esta interface para adicionar as propriedades exigidas por esse tipo de componente.

Extends
IClientSideManifestBase

Comentários

O esquema deste manifesto pertence à Microsoft. Devem ser seguidas as seguintes regras ao alterar este esquema. Este conjunto de regras também pode ser chamado de "regras de atualização de manifestos".

  • Para pequenas alterações, podem ser adicionadas novas propriedades a este esquema de uma forma retrocompatível. Ou seja, o código que processa o manifesto deve ser capaz de lidar com a ausência dessas novas propriedades.

  • Tente modelar as suas alterações como pequenos incrementos semVer. As alterações de versões principais devem ser evitadas porque impõem um custo de migração aos programadores.

  • O 'manifestVersion' deve ser aumentado para todas as pequenas ou grandes alterações.

Propriedades

alias

Um nome abreviado normalmente dado pelo programador. Não precisa de ser localizado e espera-se que permaneça o mesmo ao longo da duração do componente. Se uma aplicação substituir a ClientSideApplication.alias propriedade, ClientSideApplication.alias é dada precedência sobre o valor fornecido no manifesto.
componentType

Tipo de componente do lado do cliente. Os componentes com o tipo "Aplicação" são definidos pela interface "IClientSideApplicationManifest". Os componentes com o tipo "Peça Web" são definidos pela interface "IClientSideWebPartManifest". Os componentes com o tipo "Biblioteca" são definidos pela interface "IClientSideLibraryManifest". Os componentes com o tipo "AdaptiveCardExtension" são definidos pela interface "IAdaptiveCardExtensionManifest".
loaderConfig

Esta parte da configuração descreve como o componente deve ser carregado e inicializado por um cliente. Contém uma enumeração de scripts de que o componente necessita, juntamente com um script de ponto de entrada único.
loadLegacyFabricCss

Esta propriedade é utilizada para manter componentes mais antigos que não utilizam explicitamente CSS de recursos de infraestrutura. Na maior parte das vezes, as peças Web compilam depois de utilizarem o spfx 1.1 não precisam disto.
requiresCustomScript

Se for verdadeiro, o componente comporta-se como o seguinte em sites onde não é permitido executar scripts personalizados: quando o componente é uma peça Web, não está disponível no seletor de peças Web , todas as instâncias do componente que foi adicionado à página enquanto os scripts personalizados tinham permissão para ser executados deixarão de aparecer nessas páginas. O autor ainda consegue remover esses componentes ao editar a página
safeWithCustomScriptDisabled

Esta propriedade é fornecida para retrocompatibilidade. Já não tem qualquer efeito.
version

Versão do componente do lado do cliente. Espera-se que o valor deste campo seja controlado pelo programador do componente do lado do cliente.

Detalhes da propriedade

alias

Um nome abreviado normalmente dado pelo programador. Não precisa de ser localizado e espera-se que permaneça o mesmo ao longo da duração do componente. Se uma aplicação substituir a ClientSideApplication.alias propriedade, ClientSideApplication.alias é dada precedência sobre o valor fornecido no manifesto.

alias: string;

Valor da propriedade

string

Comentários

Utilização: um nome abreviado para identificar um componente do lado do cliente pelo programador.

Valores suportados: os carateres permitidos são a-z, A-Z e "-". Não tem mais de 40 carateres.

Exemplo: "NewFeed"

componentType

Tipo de componente do lado do cliente. Os componentes com o tipo "Aplicação" são definidos pela interface "IClientSideApplicationManifest". Os componentes com o tipo "Peça Web" são definidos pela interface "IClientSideWebPartManifest". Os componentes com o tipo "Biblioteca" são definidos pela interface "IClientSideLibraryManifest". Os componentes com o tipo "AdaptiveCardExtension" são definidos pela interface "IAdaptiveCardExtensionManifest".

componentType: ComponentType;

Valor da propriedade

ComponentType

Comentários

Utilização: para ajudar a agregar, carregar, enumerar e inicializar componentes com base nos respetivos conteúdos.

Valores suportados: "Application", ,"WebPart" ,"Library" , "Extension","AdaptiveCardExtension"

loaderConfig

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 parte da configuração descreve como o componente deve ser carregado e inicializado por um cliente. Contém uma enumeração de scripts de que o componente necessita, juntamente com um script de ponto de entrada único.

loaderConfig: IClientSideComponentLoaderConfiguration;

Valor da propriedade

IClientSideComponentLoaderConfiguration

Comentários

Utilização: carregar um componente.

Veja IClientSideComponentLoaderConfiguration para obter mais informações e exemplos.

loadLegacyFabricCss

Esta propriedade é utilizada para manter componentes mais antigos que não utilizam explicitamente CSS de recursos de infraestrutura. Na maior parte das vezes, as peças Web compilam depois de utilizarem o spfx 1.1 não precisam disto.

loadLegacyFabricCss?: boolean;

Valor da propriedade

boolean

requiresCustomScript

Se for verdadeiro, o componente comporta-se como o seguinte em sites onde não é permitido executar scripts personalizados: quando o componente é uma peça Web, não está disponível no seletor de peças Web , todas as instâncias do componente que foi adicionado à página enquanto os scripts personalizados tinham permissão para ser executados deixarão de aparecer nessas páginas. O autor ainda consegue remover esses componentes ao editar a página

requiresCustomScript?: boolean;

Valor da propriedade

boolean

Comentários

O padão é falso. Veja https://support.office.com/en-us/article/Turn-scripting-capabilities-on-or-off-1f2c515f-5d7e-448a-9fd7-835da935584f para obter mais informações.

Utilização: requer que o Script Personalizado seja permitido para que este componente seja instalado e executado.

safeWithCustomScriptDisabled

Aviso

Essa API foi preterida.

Use requiresCustomScript instead of safeWithCustomScriptDisabled.

Esta propriedade é fornecida para retrocompatibilidade. Já não tem qualquer efeito.

safeWithCustomScriptDisabled?: boolean;

Valor da propriedade

boolean

version

Versão do componente do lado do cliente. Espera-se que o valor deste campo seja controlado pelo programador do componente do lado do cliente.

version: string;

Valor da propriedade

string

Comentários

O objetivo deste campo é ajudar os programadores de componentes do lado do cliente a atualizar os componentes do lado do cliente de forma gerida. Isto ajuda os consumidores do componente do lado do cliente a tomar decisões sobre quando e como atualizar o componente do lado do cliente. À medida que o programador evolui o código para o componente do lado do cliente, pode decidir aumentar a versão MAJOR, MINOR ou PATCH do componente.

Todas as alterações incompatíveis da API devem resultar num aumento da versão MAJOR. As alterações de funcionalidade retrocompatíveis devem resultar num aumento da versão MINOR e as correções de erros retrocompatíveis deverão resultar num aumento da versão PATCH. http://semver.org Veja para obter mais detalhes sobre como gerir a versão dos seus componentes.

Utilização: controlo de versões e evolução de um componente do lado do cliente de forma controlada.

Valores suportados: cadeia que representa uma versão semântica , ou seja, MAJOR. MENOR. PATCH

Exemplo: "1.0.0"