IClientSideComponentManifest interface
SharePoint フレームワーク上に構築されたすべてのクライアント側コンポーネントには、有効なコンポーネント マニフェストが必要です。 このインターフェイスは、アプリケーションや Web パーツなど、すべての種類のクライアント側コンポーネントで必要なプロパティを表します。 コンポーネント固有のマニフェストは、このインターフェイスを拡張して、そのコンポーネントの種類に必要なプロパティを追加します。
- Extends
注釈
このマニフェストのスキーマは、Microsoft によって所有およびバージョン管理されています。 このスキーマを変更するときは、次の規則に従う必要があります。 この規則のセットは、"マニフェスト アップグレード 規則" とも呼ばれます。
軽微な変更の場合は、下位互換性のある方法で新しいプロパティをこのスキーマに追加できます。 つまり、マニフェストを処理するコードは、これらの新しいプロパティがない場合に処理できる必要があります。
変更を小さな SemVer 増分としてモデル化してみてください。 メジャー バージョンの変更は、開発者に移行コストを課すので避ける必要があります。
すべての小さな変更または大きな変更に対して、
'manifestVersion'をバンプする必要があります。
プロパティ
| alias | 通常、開発者が指定する短い名前。 ローカライズする必要はないため、コンポーネントの有効期間を通じて同じままである必要があります。 アプリケーションが |
| component |
クライアント側コンポーネントの種類。 "Application" 型のコンポーネントは、"IClientSideApplicationManifest" インターフェイスによって定義されます。 "WebPart" 型のコンポーネントは、"IClientSideWebPartManifest" インターフェイスによって定義されます。 "Library" 型のコンポーネントは、"IClientSideLibraryManifest" インターフェイスによって定義されます。 "AdaptiveCardExtension" 型のコンポーネントは、"IAdaptiveCardExtensionManifest" インターフェイスによって定義されます。 |
| experimental |
試験的フラグの型指定されていないプロパティ バッグが、運用の準備ができていません。 |
| isolated |
コンポーネントを実行する必要があるドメイン。 |
| loader |
構成のこの部分では、コンポーネントをクライアントによって読み込んで初期化する方法について説明します。 これには、コンポーネントに必要なスクリプトの列挙と 1 つのエントリ ポイント スクリプトが含まれています。 |
| load |
このプロパティは、ファブリック CSS を明示的に使用しない古いコンポーネントを保持するために使用されます。 ほとんどの場合、spfx 1.1 を使用した後に Web パーツをビルドしても、これは必要ありません。 |
| preload |
このコンポーネントと共に事前に読み込む必要があるコンポーネント マニフェストの一覧。 これには、初期レンダリング時に必要な外部リソースや、必要に応じてのみ読み込む必要があるコンポーネントが含まれる場合があります。 |
| requires |
true の場合、カスタム スクリプトの実行が許可されていないサイトでは、コンポーネントは次のように動作します。コンポーネントが Web パーツの場合、Web パーツ ピッカーでは使用できません。カスタム スクリプトの実行が許可されている間にページに追加されたすべてのコンポーネントインスタンスは、それらのページに表示されなくなります。 作成者は、ページの編集中にこれらのコンポーネントを削除できます |
| safe |
このプロパティは、下位互換性のために提供されます。 効果はなくなりました。 |
| version | クライアント側コンポーネントのバージョン。 このフィールドの値は、クライアント側コンポーネントの開発者によって制御されることが予想されます。 |
プロパティの詳細
alias
通常、開発者が指定する短い名前。 ローカライズする必要はないため、コンポーネントの有効期間を通じて同じままである必要があります。 アプリケーションが ClientSideApplication.alias プロパティをオーバーライドした場合、マニフェストで指定された値よりも ClientSideApplication.alias が優先されます。
alias: string;プロパティ値
string
注釈
使用法: 開発者がクライアント側コンポーネントを識別するための短い名前。
サポートされる値: 使用できる文字は、a-z、A-Z、および '-' です。 40 文字以下。
例: "NewFeed"
componentType
クライアント側コンポーネントの種類。 "Application" 型のコンポーネントは、"IClientSideApplicationManifest" インターフェイスによって定義されます。 "WebPart" 型のコンポーネントは、"IClientSideWebPartManifest" インターフェイスによって定義されます。 "Library" 型のコンポーネントは、"IClientSideLibraryManifest" インターフェイスによって定義されます。 "AdaptiveCardExtension" 型のコンポーネントは、"IAdaptiveCardExtensionManifest" インターフェイスによって定義されます。
componentType: ComponentType;プロパティ値
注釈
使用法: コンポーネントの内容に基づくコンポーネントのバンドル、読み込み、列挙、初期化に役立ちます。
サポートされる値: "Application"、 "WebPart"、 "Library"、 "Extension"、 "AdaptiveCardExtension"
experimentalData
注意
この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。
試験的フラグの型指定されていないプロパティ バッグが、運用の準備ができていません。
experimentalData?: {
[key: string]: any;
};プロパティ値
{ [key: string]: any; }
isolatedDomain
注意
この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。
コンポーネントを実行する必要があるドメイン。
isolatedDomain?: string;プロパティ値
string
注釈
例: 'PrepSPO-appFEEAB5CE1CB0421FB1AAE5D09E0A8AAA.spgrid.com'
loaderConfig
注意
この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。
構成のこの部分では、コンポーネントをクライアントによって読み込んで初期化する方法について説明します。 これには、コンポーネントに必要なスクリプトの列挙と 1 つのエントリ ポイント スクリプトが含まれています。
loaderConfig: IClientSideComponentLoaderConfiguration;プロパティ値
注釈
使用法: コンポーネントの読み込み。
詳細と例については、「 IClientSideComponentLoaderConfiguration 」を参照してください。
loadLegacyFabricCss
このプロパティは、ファブリック CSS を明示的に使用しない古いコンポーネントを保持するために使用されます。 ほとんどの場合、spfx 1.1 を使用した後に Web パーツをビルドしても、これは必要ありません。
loadLegacyFabricCss?: boolean;プロパティ値
boolean
preloadComponents
注意
この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。
このコンポーネントと共に事前に読み込む必要があるコンポーネント マニフェストの一覧。 これには、初期レンダリング時に必要な外部リソースや、必要に応じてのみ読み込む必要があるコンポーネントが含まれる場合があります。
preloadComponents?: string[];プロパティ値
string[]
注釈
サポートされる値: マニフェスト ID の配列
例: [ "66665f5e-307f-41cf-9fec-17c5ea20f0ca", "2d02eafb-eb82-47d2-98ac-dcac4aa63969" ]
requiresCustomScript
true の場合、カスタム スクリプトの実行が許可されていないサイトでは、コンポーネントは次のように動作します。コンポーネントが Web パーツの場合、Web パーツ ピッカーでは使用できません。カスタム スクリプトの実行が許可されている間にページに追加されたすべてのコンポーネントインスタンスは、それらのページに表示されなくなります。 作成者は、ページの編集中にこれらのコンポーネントを削除できます
requiresCustomScript?: boolean;プロパティ値
boolean
注釈
既定は false です。 詳細については、「https://support.office.com/en-us/article/Turn-scripting-capabilities-on-or-off-1f2c515f-5d7e-448a-9fd7-835da935584f」を参照してください。
使用法: このコンポーネントをインストールして実行するには、カスタム スクリプトを許可する必要があります。
safeWithCustomScriptDisabled
警告
この API は非推奨になりました。
Use requiresCustomScript instead of safeWithCustomScriptDisabled.
このプロパティは、下位互換性のために提供されます。 効果はなくなりました。
safeWithCustomScriptDisabled?: boolean;プロパティ値
boolean
version
クライアント側コンポーネントのバージョン。 このフィールドの値は、クライアント側コンポーネントの開発者によって制御されることが予想されます。
version: string;プロパティ値
string
注釈
このフィールドの目的は、クライアント側コンポーネント開発者が管理された方法でクライアント側コンポーネントをアップグレードできるようにすることです。 これにより、クライアント側コンポーネントのコンシューマーは、クライアント側コンポーネントをアップグレードするタイミングと方法を決定できます。 開発者がクライアント側コンポーネントのコードを進化させるにつれて、コンポーネントの MAJOR、MINOR、または PATCH バージョンをバンプすることを決定できます。
互換性のない API のすべての変更により、MAJOR バージョンのバンプが発生する必要があります。 下位互換性のある機能の変更によってマイナー バージョンがバンプし、下位互換性のあるバグ修正によって PATCH バージョンがバンプする必要があります。 コンポーネントのバージョンを管理する方法の詳細については、「 http://semver.org 」を参照してください。
使用法: 制御された方法でクライアント側コンポーネントのバージョン管理と進化を安全に行います。
サポートされる値: セマンティック バージョン (MAJOR) を表す文字列。マイナー。パッチ
例: "1.0.0"