IClientSideComponentLoaderConfiguration interface

Paket:

@microsoft/sp-module-interfaces

Hinweis

Diese API wird als Vorschau für Entwickler bereitgestellt. Je nachdem, welches Feedback wir dazu erhalten, werden möglicherweise Änderungen vorgenommen. Verwenden Sie diese API nicht in einer Produktionsumgebung.

Diese Schnittstelle beschreibt, wie eine clientseitige Komponente von einem SharePoint-Clientframework geladen und initialisiert werden soll. Sie enthält alle Daten zum Laden eines Einstiegspunktskripts und seiner Abhängigkeitsskripts.

Eigenschaften

entryModuleId	Dies ist die ID eines der Einträge im Wörterbuch "scriptResources".
exportName	Das Modul, auf das durch das Feld "entryModuleId" verwiesen wird, kann ein Objekt mit mehreren Feldern exportieren.
internalModuleBaseUrls	Dies ist ein Array vollqualifizierter Pfade, die jedem der Skriptressourcenpfade mit dem Typ "intern" oder "lokalisiert" vorangestellt werden sollen. Wenn ein Ladevorgang fehlschlägt, versucht das Ladeprogramm, vom nächsten zu laden, bis keine Basispfade mehr vorhanden sind.
scriptResources	Dies ist ein Wörterbuch mit benannten Skriptressourcen. path Und localizedPath Module können aufeinander verweisen, und manifest Module werden voraussichtlich von der Frameworkruntime bereitgestellt. Die Ressource mit dem entryModuleId Namen in muss das exportierte Objekt der Komponente enthalten.

Details zur Eigenschaft

entryModuleId

Hinweis

Diese API wird als Vorschau für Entwickler bereitgestellt. Je nachdem, welches Feedback wir dazu erhalten, werden möglicherweise Änderungen vorgenommen. Verwenden Sie diese API nicht in einer Produktionsumgebung.

Dies ist die ID eines der Einträge im Wörterbuch "scriptResources".

entryModuleId: string;

Eigenschaftswert

string

Hinweise

Das Ladeprogramm lädt die Skriptressource herunter und wertet sie aus, auf die in diesem Feld verwiesen wird, löst alle Abhängigkeiten mit den Schlüsseln in "scriptResources" auf und gibt das exportierte Objekt an die aufrufende Funktion des Ladeprogramms zurück. Der Eintrag, auf den im Wörterbuch "scriptResources" verwiesen wird, muss vom Typ "internal" oder "localized" sein.

Unterstützte Werte: Ein Eintrag im Wörterbuch "scriptResources", der das exportierte Basismodul der Komponente definiert.

Beispiel: "myApplication.bundle"

exportName

Hinweis

Diese API wird als Vorschau für Entwickler bereitgestellt. Je nachdem, welches Feedback wir dazu erhalten, werden möglicherweise Änderungen vorgenommen. Verwenden Sie diese API nicht in einer Produktionsumgebung.

Das Modul, auf das durch das Feld "entryModuleId" verwiesen wird, kann ein Objekt mit mehreren Feldern exportieren.

exportName?: string;

Eigenschaftswert

string

Hinweise

Dieser Wert verweist optional auf den Namen eines Felds für das Objekt, das von dem Modul exportiert wird, auf das entryModuleId das Feld verweist. Wenn dieses Feld über einen Wert verfügt, wird der Wert des Felds, auf das verwiesen wird, im Objekt zurückgegeben, das von dem Modul exportiert wird, auf das entryModuleId das Feld verweist, wenn dieses Manifest anstelle des exportierten Basisobjekts geladen wird. Wenn sich entryModuleId beispielsweise auf ein Modul mit mit einem Export auf oberster Ebene von { foo: 'bar', baz: 123 } und bezieht:

• Wenn dieses Feld nicht festgelegt ist, lautet der vom Modulladeprogramm zurückgegebene Wert. { foo: 'bar', baz: 123 }

• Wenn dieses Feld auf foofestgelegt ist, lautet der vom Modulladeprogramm zurückgegebene Wert. bar

• Wenn dieses Feld auf barfestgelegt ist, ist der vom Modulladeprogramm zurückgegebene Wert undefiniert (da bar es sich nicht um einen Schlüssel im Export der obersten Ebene handelt).

Beispiel: mySpWebpart

internalModuleBaseUrls

Hinweis

Diese API wird als Vorschau für Entwickler bereitgestellt. Je nachdem, welches Feedback wir dazu erhalten, werden möglicherweise Änderungen vorgenommen. Verwenden Sie diese API nicht in einer Produktionsumgebung.

Dies ist ein Array vollqualifizierter Pfade, die jedem der Skriptressourcenpfade mit dem Typ "intern" oder "lokalisiert" vorangestellt werden sollen. Wenn ein Ladevorgang fehlschlägt, versucht das Ladeprogramm, vom nächsten zu laden, bis keine Basispfade mehr vorhanden sind.

internalModuleBaseUrls: string[];

Eigenschaftswert

string[]

Hinweise

Alle "internen" und "lokalisierten" Skriptressourcen, die nicht über vollqualifizierte URLs als "Pfad"-Feldwerte verfügen, müssen unter jedem der in dieser Eigenschaft aufgeführten Pfade gehostet werden. Wenn z. B. der Feldwert "path" eines internen Moduls ist "master_2015-04-20/my-application.bundle_1928f8a0.js" und der Wert dieses Felds ist[ "https://contoso.akamaihd.net/files/", "https://contoso.msecnd.net/files/" ], versucht das Ladeprogramm zuerst, diese Skriptressource aus der URL "https://contoso.akamaihd.net/files/master_2015-04-20/my-application.bundle_1928f8a0.js"zu laden. Wenn beim Laden von dieser URL ein Fehler auftritt, versucht das Ladeprogramm dann, diese Skriptressource aus "https://contoso.msecnd.net/files/master_2015-04-20/my-application.bundle_1928f8a0.js"zu laden. Wenn diese URL nicht geladen werden kann, kann die Komponente nicht geladen werden, und es wird ein Fehler zurückgegeben. Es ist wichtig zu beachten, dass die Unterstützung für mehrere Basis-URLs ausschließlich der Failoverunterstützung dient. Dies bedeutet, dass alle Dateien auf allen hosts vorhanden sein müssen, die in diesem Feld aufgeführt sind.

Verwendung: Basis-URLs für Skriptressourcen mit dem Typ "intern" oder "lokalisiert".

Unterstützte Werte: Jede URL, die alle internen Skripts enthält, auf die im Wörterbuch "scriptResources" verwiesen wird.

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

scriptResources

Hinweis

Diese API wird als Vorschau für Entwickler bereitgestellt. Je nachdem, welches Feedback wir dazu erhalten, werden möglicherweise Änderungen vorgenommen. Verwenden Sie diese API nicht in einer Produktionsumgebung.

Dies ist ein Wörterbuch mit benannten Skriptressourcen. path Und localizedPath Module können aufeinander verweisen, und manifest Module werden voraussichtlich von der Frameworkruntime bereitgestellt. Die Ressource mit dem entryModuleId Namen in muss das exportierte Objekt der Komponente enthalten.

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

Eigenschaftswert

{ [name: string]: IModuleConfiguration; }

Hinweise

Unterstützte Werte: Ein Wörterbuch benannter Skriptressourcen.

Beispiel:

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