Partager via

IClientSideComponentLoaderConfiguration interface

  • Référence
Paquet:
@microsoft/sp-module-interfaces

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 interface décrit comment un composant côté client doit être chargé et initialisé par une infrastructure cliente SharePoint. Il contient toutes les données pour le chargement d’un script de point d’entrée et de ses scripts de dépendance.

Propriétés

entryModuleId

Il s’agit de l’ID de l’une des entrées du dictionnaire « scriptResources ».
exportName

Le module référencé par le champ « entryModuleId » peut exporter un objet avec plusieurs champs.
internalModuleBaseUrls

Il s’agit d’un tableau de chemins complets à ajouter à chacun des chemins de ressources de script avec le type « interne » ou « localisé ». Si le chargement échoue, le chargeur tente de charger à partir du suivant jusqu’à ce qu’il ne reste aucun chemin de base.
scriptResources

Il s’agit d’un dictionnaire de ressources de script nommées. path et localizedPath les modules peuvent faire référence les uns aux autres et manifest les modules sont censés être fournis par le runtime de l’infrastructure. La ressource nommée dans doit entryModuleId contenir l’objet exporté du composant.

Détails de la propriété

entryModuleId

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.

Il s’agit de l’ID de l’une des entrées du dictionnaire « scriptResources ».

entryModuleId: string;

Valeur de propriété

string

Remarques

Le chargeur télécharge et évalue la ressource de script référencée dans ce champ, résout toutes les dépendances par rapport aux clés dans « scriptResources » et retourne l’objet exporté à la fonction appelante du chargeur. L’entrée référencée dans le dictionnaire « scriptResources » doit être du type « interne » ou « localisé ».

Valeurs prises en charge : entrée dans le dictionnaire « scriptResources » qui définit le module exporté de base du composant.

Exemple : "myApplication.bundle"

exportName

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.

Le module référencé par le champ « entryModuleId » peut exporter un objet avec plusieurs champs.

exportName?: string;

Valeur de propriété

string

Remarques

Cette valeur fait éventuellement référence au nom d’un champ sur l’objet exporté par le module référencé par le entryModuleId champ. Lorsque ce champ a une valeur, la valeur du champ référencé sur l’objet exporté par le module référencé par le entryModuleId champ est retournée lorsque ce manifeste est chargé au lieu de l’objet exporté de base. Par exemple, si entryModuleId fait référence à un module avec avec une exportation de niveau supérieur de { foo: 'bar', baz: 123 } et :

  • si ce champ n’est pas défini, la valeur retournée par le chargeur de module est { foo: 'bar', baz: 123 }

  • si ce champ est défini sur foo, la valeur retournée par le chargeur de module est bar

  • si ce champ est défini sur bar, la valeur retournée par le chargeur de module n’est pas définie (car bar n’est pas une clé dans l’exportation de niveau supérieur).

Exemple : mySpWebpart

internalModuleBaseUrls

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.

Il s’agit d’un tableau de chemins complets à ajouter à chacun des chemins de ressources de script avec le type « interne » ou « localisé ». Si le chargement échoue, le chargeur tente de charger à partir du suivant jusqu’à ce qu’il ne reste aucun chemin de base.

internalModuleBaseUrls: string[];

Valeur de propriété

string[]

Remarques

Toutes les ressources de script « internes » et « localisées » qui n’ont pas d’URL complètes comme valeurs de champ « chemin d’accès » doivent être hébergées sous chacun des chemins répertoriés dans cette propriété. Par exemple, si la valeur du champ « chemin » d’un module interne est "master_2015-04-20/my-application.bundle_1928f8a0.js" et que la valeur de ce champ est [ "https://contoso.akamaihd.net/files/", "https://contoso.msecnd.net/files/" ], le chargeur tente d’abord de charger cette ressource de script à partir de l’URL "https://contoso.akamaihd.net/files/master_2015-04-20/my-application.bundle_1928f8a0.js". Si le chargement à partir de cette URL échoue, le chargeur tente alors de charger cette ressource de script à partir de "https://contoso.msecnd.net/files/master_2015-04-20/my-application.bundle_1928f8a0.js". Si le chargement de cette URL échoue, le chargement du composant échoue et une erreur est retournée. Il est important de noter que la prise en charge de plusieurs URL de base est uniquement pour la prise en charge du basculement. Cela signifie que tous les fichiers doivent être présents sur tous les hôtes répertoriés dans ce champ.

Utilisation : URL de base pour les ressources de script avec le type « interne » ou « localisé ».

Valeurs prises en charge : toute URL qui contient tous les scripts internes référencés dans le dictionnaire « scriptResources ».

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

scriptResources

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.

Il s’agit d’un dictionnaire de ressources de script nommées. path et localizedPath les modules peuvent faire référence les uns aux autres et manifest les modules sont censés être fournis par le runtime de l’infrastructure. La ressource nommée dans doit entryModuleId contenir l’objet exporté du composant.

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

Valeur de propriété

{ [name: string]: IModuleConfiguration; }

Remarques

Valeurs prises en charge : dictionnaire de ressources de script nommées.

Exemple :

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