IClientSideComponentManifest interface
Tous les composants côté client basés sur l’infrastructure SharePoint ont besoin d’un manifeste de composant valide. Cette interface représente les propriétés requises par tous les types de composants côté client, comme les applications et les composants WebPart. Les manifestes spécifiques aux composants étendent cette interface pour ajouter les propriétés requises par ce type de composant.
- Extends
Remarques
Le schéma de ce manifeste est détenu et versionné par Microsoft. Les règles suivantes doivent être suivies lors de la modification de ce schéma. Cet ensemble de règles peut également être appelé « règles de mise à niveau de manifeste ».
Pour les modifications mineures, de nouvelles propriétés peuvent être ajoutées à ce schéma de manière à compatibilité descendante. C’est-à-dire que le code qui traite le manifeste doit être en mesure de gérer l’absence de ces nouvelles propriétés.
Essayez de modéliser vos modifications en tant qu’incréments SemVer mineurs. Les modifications de version majeures doivent être évitées, car elles imposent un coût de migration aux développeurs.
Le
'manifestVersion'doit être heurté pour tous les petits ou grands changements.
Propriétés
| alias | Nom court généralement donné par le développeur. Il n’a pas besoin d’être localisé et est censé rester le même pendant toute la durée de vie du composant. Si une application remplace la |
| component |
Type de composant côté client. Les composants de type « Application » sont définis par l’interface « IClientSideApplicationManifest ». Les composants de type « WebPart » sont définis par l’interface « IClientSideWebPartManifest ». Les composants de type « Library » sont définis par l’interface « IClientSideLibraryManifest ». Les composants de type « AdaptiveCardExtension » sont définis par l’interface « IAdaptiveCardExtensionManifest ». |
| loader |
Cette partie de la configuration décrit comment le composant doit être chargé et initialisé par un client. Il contient une énumération des scripts requis par le composant, ainsi qu’un script de point d’entrée unique. |
| load |
Cette propriété est utilisée pour conserver les composants plus anciens qui n’utilisent pas explicitement le css d’infrastructure. Pour la plupart, les composants WebPart générés après l’utilisation de spfx 1.1 n’en ont pas besoin. |
| requires |
Si la valeur est true, le composant se comporte comme suit sur les sites où les scripts personnalisés ne sont pas autorisés à s’exécuter : - lorsque le composant est un composant WebPart, il n’est pas disponible dans le sélecteur de composants WebPart - chaque instance du composant qui a été ajouté à la page alors que les scripts personnalisés étaient autorisés à s’exécuter, n’apparaissent plus dans ces pages. L’auteur peut toujours supprimer ces composants lors de la modification de la page |
| safe |
Cette propriété est fournie pour la compatibilité descendante. Elle n’a plus d’effet. |
| version | Version du composant côté client. La valeur de ce champ est censée être contrôlée par le développeur du composant côté client. |
Détails de la propriété
alias
Nom court généralement donné par le développeur. Il n’a pas besoin d’être localisé et est censé rester le même pendant toute la durée de vie du composant. Si une application remplace la ClientSideApplication.alias propriété , ClientSideApplication.alias est prioritaire sur la valeur fournie dans le manifeste.
alias: string;Valeur de propriété
string
Remarques
Utilisation : nom court permettant d’identifier un composant côté client par le développeur.
Valeurs prises en charge : les caractères autorisés sont a-z, A-Z et « - ». Pas plus de 40 caractères.
Exemple : "NewFeed"
componentType
Type de composant côté client. Les composants de type « Application » sont définis par l’interface « IClientSideApplicationManifest ». Les composants de type « WebPart » sont définis par l’interface « IClientSideWebPartManifest ». Les composants de type « Library » sont définis par l’interface « IClientSideLibraryManifest ». Les composants de type « AdaptiveCardExtension » sont définis par l’interface « IAdaptiveCardExtensionManifest ».
componentType: ComponentType;Valeur de propriété
Remarques
Utilisation : pour faciliter le regroupement, le chargement, l’énumération et l’initialisation des composants en fonction de leur contenu.
Valeurs prises en charge : "Application","WebPart" ,"Library" , , "Extension""AdaptiveCardExtension"
loaderConfig
Notes
Cet API est fourni en tant qu’aperçu pour les développeurs et peut être modifié en fonction des commentaires que nous avons reçus. N’utilisez pas cet API dans un environnement de production.
Cette partie de la configuration décrit comment le composant doit être chargé et initialisé par un client. Il contient une énumération des scripts requis par le composant, ainsi qu’un script de point d’entrée unique.
loaderConfig: IClientSideComponentLoaderConfiguration;Valeur de propriété
Remarques
Utilisation : chargement d’un composant.
Pour plus d’informations et d’exemples, consultez IClientSideComponentLoaderConfiguration .
loadLegacyFabricCss
Cette propriété est utilisée pour conserver les composants plus anciens qui n’utilisent pas explicitement le css d’infrastructure. Pour la plupart, les composants WebPart générés après l’utilisation de spfx 1.1 n’en ont pas besoin.
loadLegacyFabricCss?: boolean;Valeur de propriété
boolean
requiresCustomScript
Si la valeur est true, le composant se comporte comme suit sur les sites où les scripts personnalisés ne sont pas autorisés à s’exécuter : - lorsque le composant est un composant WebPart, il n’est pas disponible dans le sélecteur de composants WebPart - chaque instance du composant qui a été ajouté à la page alors que les scripts personnalisés étaient autorisés à s’exécuter, n’apparaissent plus dans ces pages. L’auteur peut toujours supprimer ces composants lors de la modification de la page
requiresCustomScript?: boolean;Valeur de propriété
boolean
Remarques
Par défaut est faux. Si vous souhaitez plus d’informations, consultez https://support.office.com/en-us/article/Turn-scripting-capabilities-on-or-off-1f2c515f-5d7e-448a-9fd7-835da935584f.
Utilisation : nécessite que le script personnalisé soit autorisé pour que ce composant soit installé et exécuté.
safeWithCustomScriptDisabled
Avertissement
Cette API est à présent déconseillée.
Use requiresCustomScript instead of safeWithCustomScriptDisabled.
Cette propriété est fournie pour la compatibilité descendante. Elle n’a plus d’effet.
safeWithCustomScriptDisabled?: boolean;Valeur de propriété
boolean
version
Version du composant côté client. La valeur de ce champ est censée être contrôlée par le développeur du composant côté client.
version: string;Valeur de propriété
string
Remarques
L’objectif de ce champ est d’aider les développeurs de composants côté client à mettre à niveau leurs composants côté client de manière managée. Cela permet aux consommateurs du composant côté client de prendre des décisions sur le moment et la façon de mettre à niveau le composant côté client. À mesure que le développeur fait évoluer le code de son composant côté client, il peut décider de changer la version MAJOR, MINOR ou PATCH du composant.
Toutes les modifications d’API incompatibles doivent entraîner un choc de version MAJOR. Les modifications apportées aux fonctionnalités à compatibilité descendante doivent entraîner une rupture de version MINOR, et les correctifs de bogues à compatibilité descendante doivent entraîner une rupture de version PATCH. Pour plus d’informations sur la gestion de la version de vos composants, consultez http://semver.org .
Utilisation : gestion de version et évolution d’un composant côté client en toute sécurité de manière contrôlée.
Valeurs prises en charge : chaîne représentant une version sémantique , c’est-à-dire MAJOR. MINEUR. RAPIÉCER
Exemple : "1.0.0"