IClientSideComponentManifest interface
Todos os componentes do lado do cliente criados na estrutura do SharePoint precisam de um manifesto de componente válido. Essa interface representa propriedades que são exigidas por todos os tipos de componentes do lado do cliente, como Aplicativos e Web Parts. Os manifestos específicos do componente estenderão essa interface para adicionar as propriedades exigidas por esse tipo de componente.
- Extends
Comentários
O esquema deste manifesto pertence à Microsoft e tem controle de versão. As regras a seguir devem ser seguidas ao alterar este esquema. Esse conjunto de regras também pode ser chamado de "regras de atualização de manifesto".
Para pequenas alterações, novas propriedades podem ser adicionadas a este esquema de uma forma compatível com versões anteriores. ou seja, o código que processa o manifesto deve ser capaz de lidar com a ausência dessas novas propriedades.
Tente modelar suas alterações como pequenos incrementos do SemVer. As principais alterações de versão devem ser evitadas, pois impõem um custo de migração aos desenvolvedores.
O
'manifestVersion'deve ser alterado para todas as mudanças pequenas ou grandes.
Propriedades
| alias | Um nome curto geralmente dado pelo desenvolvedor. Ele não precisa ser localizado e espera-se que permaneça o mesmo durante o tempo de vida do componente. Se um aplicativo substituir a |
| component |
Tipo de componente do lado do cliente. Os componentes com o tipo "Application" são definidos pela interface "IClientSideApplicationManifest". Os componentes com o tipo "WebPart" 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". |
| experimental |
Um saco de propriedades sem tipo para sinalizadores experimentais não prontos para produção. |
| isolated |
O domínio no qual o componente deve ser executado. |
| loader |
Essa parte da configuração descreve como o componente deve ser carregado e inicializado por um cliente. Ele contém uma enumeração de scripts que o componente requer junto com um único script de ponto de entrada. |
| load |
Essa propriedade é usada para manter componentes mais antigos que não usam explicitamente CSS de estrutura. Na maioria das vezes, as webparts construídas após o uso do spfx 1.1 não precisam disso. |
| preload |
Uma lista de manifestos de componentes que devem ser pré-carregados junto com este componente. Isso pode incluir recursos externos necessários durante a renderização inicial ou componentes que devem ser carregados somente sob demanda. |
| requires |
Se for true, o componente se comportará da seguinte maneira em sites onde os scripts personalizados não têm permissão para serem executados: - quando o componente é uma Web Part, ele não está disponível no seletor de Web Part - Cada instância do componente que foi adicionado à página enquanto os scripts personalizados foram autorizados a ser executados, não será mais exibida nessas páginas. O autor ainda pode remover esses componentes enquanto edita a página |
| safe |
Essa propriedade é fornecida para compatibilidade com versões anteriores. Ele não tem mais nenhum efeito. |
| version | Versão do componente do lado do cliente. Espera-se que o valor desse campo seja controlado pelo desenvolvedor do componente do lado do cliente. |
Detalhes da propriedade
alias
Um nome curto geralmente dado pelo desenvolvedor. Ele não precisa ser localizado e espera-se que permaneça o mesmo durante o tempo de vida do componente. Se um aplicativo substituir a ClientSideApplication.alias propriedade, ClientSideApplication.alias o terá precedência sobre o valor fornecido no manifesto.
alias: string;Valor da propriedade
string
Comentários
Uso: um nome curto para identificar um componente do lado do cliente pelo desenvolvedor.
Valores com suporte: os caracteres permitidos são a-z, A-Z e '-'. Não mais de 40 caracteres.
Exemplo: "NewFeed"
componentType
Tipo de componente do lado do cliente. Os componentes com o tipo "Application" são definidos pela interface "IClientSideApplicationManifest". Os componentes com o tipo "WebPart" 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
Comentários
Uso: para ajudar no agrupamento, carregamento, enumeração e inicialização de componentes com base em seu conteúdo.
Valores suportados: "Application", "WebPart", "Library", "Extension", "AdaptiveCardExtension"
experimentalData
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.
Um saco de propriedades sem tipo para sinalizadores experimentais não prontos para produção.
experimentalData?: {
[key: string]: any;
};Valor da propriedade
{ [key: string]: any; }
isolatedDomain
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 domínio no qual o componente deve ser executado.
isolatedDomain?: string;Valor da propriedade
string
Comentários
Exemplo: 'PrepSPO-appFEEAB5CE1CB0421FB1AAE5D09E0A8AAA.spgrid.com'
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.
Essa parte da configuração descreve como o componente deve ser carregado e inicializado por um cliente. Ele contém uma enumeração de scripts que o componente requer junto com um único script de ponto de entrada.
loaderConfig: IClientSideComponentLoaderConfiguration;Valor da propriedade
Comentários
Uso: carregando um componente.
Consulte IClientSideComponentLoaderConfiguration para obter mais informações e exemplos.
loadLegacyFabricCss
Essa propriedade é usada para manter componentes mais antigos que não usam explicitamente CSS de estrutura. Na maioria das vezes, as webparts construídas após o uso do spfx 1.1 não precisam disso.
loadLegacyFabricCss?: boolean;Valor da propriedade
boolean
preloadComponents
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.
Uma lista de manifestos de componentes que devem ser pré-carregados junto com este componente. Isso pode incluir recursos externos necessários durante a renderização inicial ou componentes que devem ser carregados somente sob demanda.
preloadComponents?: string[];Valor da propriedade
string[]
Comentários
Valores com suporte: uma matriz de IDs de manifesto
Exemplo: [ "66665f5e-307f-41cf-9fec-17c5ea20f0ca", "2d02eafb-eb82-47d2-98ac-dcac4aa63969" ]
requiresCustomScript
Se for true, o componente se comportará da seguinte maneira em sites onde os scripts personalizados não têm permissão para serem executados: - quando o componente é uma Web Part, ele não está disponível no seletor de Web Part - Cada instância do componente que foi adicionado à página enquanto os scripts personalizados foram autorizados a ser executados, não será mais exibida nessas páginas. O autor ainda pode remover esses componentes enquanto edita 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.
Uso: 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.
Essa propriedade é fornecida para compatibilidade com versões anteriores. Ele não tem mais nenhum efeito.
safeWithCustomScriptDisabled?: boolean;Valor da propriedade
boolean
version
Versão do componente do lado do cliente. Espera-se que o valor desse campo seja controlado pelo desenvolvedor do componente do lado do cliente.
version: string;Valor da propriedade
string
Comentários
O objetivo deste campo é ajudar os desenvolvedores de componentes do lado do cliente a atualizar seus componentes do lado do cliente de uma maneira gerenciada. Isso 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 desenvolvedor evolui o código para seu componente do lado do cliente, ele pode decidir aumentar a versão MAJOR, MINOR ou PATCH do componente.
Todas as alterações de API incompatíveis devem resultar em um aumento de versão PRINCIPAL. Alterações de funcionalidade compatíveis com versões anteriores devem resultar em um aumento de versão MENOR, e correções de bugs compatíveis com versões anteriores devem resultar em um aumento de versão PATCH. http://semver.org Consulte para obter mais detalhes sobre como gerenciar a versão dos seus componentes.
Uso: Controle de versão e evolução de um componente do lado do cliente com segurança e de maneira controlada.
Valores com suporte: string que representa uma versão semântica , ou seja, MAJOR. MENOR. PATCH
Exemplo: "1.0.0"