IClientSideComponentManifest interface
Alle clientseitigen Komponenten, die auf dem SharePoint-Framework basieren, benötigen ein gültiges Komponentenmanifest. Diese Schnittstelle stellt Eigenschaften dar, die für alle Typen von clientseitigen Komponenten wie Anwendungen und Webparts erforderlich sind. Komponentenspezifische Manifeste erweitern diese Schnittstelle, um eigenschaften hinzuzufügen, die für diesen Komponententyp erforderlich sind.
- Extends
Hinweise
Das Schema dieses Manifests befindet sich im Besitz von Microsoft und wird von Microsoft mit Versionsverwaltung versehen. Beim Ändern dieses Schemas sollten die folgenden Regeln beachtet werden. Dieser Regelsatz kann auch als "Manifestupgraderegeln" bezeichnet werden.
Bei geringfügigen Änderungen können diesem Schema abwärtskompatibel neue Eigenschaften hinzugefügt werden. Das heißt, der Code, der das Manifest verarbeitet, sollte in der Lage sein, das Fehlen dieser neuen Eigenschaften zu behandeln.
Versuchen Sie, Ihre Änderungen als kleinere SemVer-Inkremente zu modellieren. Hauptversionsänderungen sollten vermieden werden, da sie Entwicklern migrationskosten verursachen.
Die
'manifestVersion'sollte für alle kleinen oder großen Änderungen gestoßen werden.
Eigenschaften
| alias | Ein kurzer Name, der normalerweise vom Entwickler angegeben wird. Es muss nicht lokalisiert werden, und es wird erwartet, dass er während der Lebensdauer der Komponente gleich bleibt. Wenn eine Anwendung die |
| component |
Typ der clientseitigen Komponente. Komponenten mit dem Typ "Application" werden durch die Schnittstelle "IClientSideApplicationManifest" definiert. Komponenten mit dem Typ "WebPart" werden durch die Schnittstelle "IClientSideWebPartManifest" definiert. Komponenten mit dem Typ "Library" werden durch die Schnittstelle "IClientSideLibraryManifest" definiert. Komponenten mit dem Typ "AdaptiveCardExtension" werden durch die Schnittstelle "IAdaptiveCardExtensionManifest" definiert. |
| loader |
In diesem Teil der Konfiguration wird beschrieben, wie die Komponente von einem Client geladen und initialisiert werden soll. Sie enthält eine Enumeration von Skripts, die die Komponente zusammen mit einem einzelnen Einstiegspunktskript benötigt. |
| load |
Diese Eigenschaft wird verwendet, um ältere Komponenten beizubehalten, die fabric-CSS nicht explizit verwenden. In den meisten Fällen benötigen Webparts, die nach der Verwendung von spfx 1.1 erstellt werden, dies nicht. |
| requires |
Wenn true, verhält sich die Komponente wie folgt auf Websites, auf denen benutzerdefinierte Skripts nicht ausgeführt werden dürfen: - Wenn es sich bei der Komponente um ein Webpart handelt, ist sie in der Webpartauswahl nicht verfügbar . Jede instance der Komponente, die der Seite hinzugefügt wurde, während benutzerdefinierte Skripts ausgeführt werden dürfen, wird auf diesen Seiten nicht mehr angezeigt. Der Autor kann diese Komponenten beim Bearbeiten der Seite weiterhin entfernen. |
| safe |
Diese Eigenschaft wird aus Gründen der Abwärtskompatibilität bereitgestellt. Es hat keine Wirkung mehr. |
| version | Clientseitige Komponentenversion. Der Wert dieses Felds wird voraussichtlich vom Entwickler der clientseitigen Komponente gesteuert. |
Details zur Eigenschaft
alias
Ein kurzer Name, der normalerweise vom Entwickler angegeben wird. Es muss nicht lokalisiert werden, und es wird erwartet, dass er während der Lebensdauer der Komponente gleich bleibt. Wenn eine Anwendung die ClientSideApplication.alias -Eigenschaft überschreibt, ClientSideApplication.alias erhält Vorrang vor dem im Manifest angegebenen Wert.
alias: string;Eigenschaftswert
string
Hinweise
Verwendung: Ein Kurzname zum Identifizieren einer clientseitigen Komponente durch den Entwickler.
Unterstützte Werte: Zulässige Zeichen sind a-z, A-Z und '-'. Nicht länger als 40 Zeichen.
Beispiel: "NewFeed"
componentType
Typ der clientseitigen Komponente. Komponenten mit dem Typ "Application" werden durch die Schnittstelle "IClientSideApplicationManifest" definiert. Komponenten mit dem Typ "WebPart" werden durch die Schnittstelle "IClientSideWebPartManifest" definiert. Komponenten mit dem Typ "Library" werden durch die Schnittstelle "IClientSideLibraryManifest" definiert. Komponenten mit dem Typ "AdaptiveCardExtension" werden durch die Schnittstelle "IAdaptiveCardExtensionManifest" definiert.
componentType: ComponentType;Eigenschaftswert
Hinweise
Verwendung: Dient zum Bündeln, Laden, Aufzählen und Initialisieren von Komponenten basierend auf ihrem Inhalt.
Unterstützte Werte: "Application", "WebPart", "Library", "Extension", , "AdaptiveCardExtension"
loaderConfig
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.
In diesem Teil der Konfiguration wird beschrieben, wie die Komponente von einem Client geladen und initialisiert werden soll. Sie enthält eine Enumeration von Skripts, die die Komponente zusammen mit einem einzelnen Einstiegspunktskript benötigt.
loaderConfig: IClientSideComponentLoaderConfiguration;Eigenschaftswert
Hinweise
Verwendung: Laden einer Komponente.
Weitere Informationen und Beispiele finden Sie IClientSideComponentLoaderConfiguration unter .
loadLegacyFabricCss
Diese Eigenschaft wird verwendet, um ältere Komponenten beizubehalten, die fabric-CSS nicht explizit verwenden. In den meisten Fällen benötigen Webparts, die nach der Verwendung von spfx 1.1 erstellt werden, dies nicht.
loadLegacyFabricCss?: boolean;Eigenschaftswert
boolean
requiresCustomScript
Wenn true, verhält sich die Komponente wie folgt auf Websites, auf denen benutzerdefinierte Skripts nicht ausgeführt werden dürfen: - Wenn es sich bei der Komponente um ein Webpart handelt, ist sie in der Webpartauswahl nicht verfügbar . Jede instance der Komponente, die der Seite hinzugefügt wurde, während benutzerdefinierte Skripts ausgeführt werden dürfen, wird auf diesen Seiten nicht mehr angezeigt. Der Autor kann diese Komponenten beim Bearbeiten der Seite weiterhin entfernen.
requiresCustomScript?: boolean;Eigenschaftswert
boolean
Hinweise
Standardwert ist false. Weitere Informationen finden Sie unter https://support.office.com/en-us/article/Turn-scripting-capabilities-on-or-off-1f2c515f-5d7e-448a-9fd7-835da935584f.
Verwendung: Erfordert, dass benutzerdefiniertes Skript zulässig ist, damit diese Komponente installiert und ausgeführt werden kann.
safeWithCustomScriptDisabled
Warnung
Diese API ist nun veraltet.
Use requiresCustomScript instead of safeWithCustomScriptDisabled.
Diese Eigenschaft wird aus Gründen der Abwärtskompatibilität bereitgestellt. Es hat keine Wirkung mehr.
safeWithCustomScriptDisabled?: boolean;Eigenschaftswert
boolean
version
Clientseitige Komponentenversion. Der Wert dieses Felds wird voraussichtlich vom Entwickler der clientseitigen Komponente gesteuert.
version: string;Eigenschaftswert
string
Hinweise
Der Zweck dieses Felds besteht darin, clientseitigen Komponentenentwicklern zu helfen, ihre clientseitigen Komponenten auf verwaltete Weise zu aktualisieren. Dies hilft den Consumern der clientseitigen Komponente, Entscheidungen darüber zu treffen, wann und wie die clientseitige Komponente aktualisiert werden soll. Während der Entwickler den Code für seine clientseitige Komponente weiterentwickelt, kann er entscheiden, die MAJOR-, MINOR- oder PATCH-Version der Komponente zu erhöhen.
Alle inkompatiblen API-Änderungen sollten zu einer Major-Version führen. Abwärtskompatible Funktionsänderungen sollten zu einer Nebenversionsbeule führen, und abwärtskompatible Fehlerbehebungen sollten zu einem PATCH-Versionswechsel führen. Weitere Informationen zum Verwalten der Version Ihrer Komponenten finden http://semver.org Sie unter .
Verwendung: Versionsverwaltung und sichere Weiterentwicklung einer clientseitigen Komponente auf kontrollierte Weise.
Unterstützte Werte: Zeichenfolge, die eine semantische Version darstellt, d. h. MAJOR. KLEINER. FLICKEN
Beispiel: "1.0.0"