次の方法で共有

IClientSideComponentLoaderConfiguration interface

  • リファレンス
パッケージ:
@microsoft/sp-module-interfaces

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。

このインターフェイスでは、クライアント側コンポーネントを SharePoint クライアント フレームワークによって読み込んで初期化する方法について説明します。 エントリポイント スクリプトとその依存関係スクリプトを読み込むためのすべてのデータが含まれています。

プロパティ

entryModuleId

これは、"scriptResources" ディクショナリ内のいずれかのエントリの ID です。
exportName

"entryModuleId" フィールドによって参照されるモジュールは、複数のフィールドを持つオブジェクトをエクスポートできます。
internalModuleBaseUrls

これは、"internal" または "localized" 型の各スクリプト リソース パスの先頭に付加される完全修飾パスの配列です。 読み込みに失敗した場合、ローダーはベース パスが残らなくなるまで、次のパスからの読み込みを試みます。
scriptResources

これは、名前付きスクリプト リソースのディクショナリです。 path モジュールと localizedPath モジュールは相互に参照され、 manifest モジュールはフレームワーク ランタイムによって提供されることが予想されます。 entryModuleIdでという名前のリソースには、コンポーネントのエクスポートされたオブジェクトが含まれている必要があります。

プロパティの詳細

entryModuleId

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。

これは、"scriptResources" ディクショナリ内のいずれかのエントリの ID です。

entryModuleId: string;

プロパティ値

string

注釈

ローダーは、このフィールドで参照されているスクリプト リソースをダウンロードして評価し、"scriptResources" 内のキーに対するすべての依存関係を解決し、エクスポートされたオブジェクトをローダーの呼び出し関数に返します。 "scriptResources" ディクショナリで参照されるエントリは、"内部" 型または "ローカライズされた" 型である必要があります。

サポートされている値: コンポーネントのエクスポートされた基本モジュールを定義する "scriptResources" ディクショナリ内のエントリ。

例: "myApplication.bundle"

exportName

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。

"entryModuleId" フィールドによって参照されるモジュールは、複数のフィールドを持つオブジェクトをエクスポートできます。

exportName?: string;

プロパティ値

string

注釈

この値は、必要に応じて、 entryModuleId フィールドによって参照されるモジュールによってエクスポートされたオブジェクトのフィールドの名前を参照します。 このフィールドに値がある場合、 entryModuleId フィールドによって参照されるモジュールによってエクスポートされたオブジェクトの参照フィールドの値は、このマニフェストがエクスポートされた基本オブジェクトの代わりに読み込まれるときに返されます。 たとえば、entryModuleId が最上位レベルの { foo: 'bar', baz: 123 } とのエクスポートを持つモジュールを参照する場合は、次のようになります。

  • このフィールドが未設定の場合、モジュール ローダーによって返される値は { foo: 'bar', baz: 123 }

  • このフィールドが foo に設定されている場合、モジュール ローダーによって返される値は bar

  • このフィールドが bar に設定されている場合、モジュール ローダーによって返される値は未定義です ( bar は最上位レベルのエクスポートのキーではないため)。

例: mySpWebpart

internalModuleBaseUrls

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。

これは、"internal" または "localized" 型の各スクリプト リソース パスの先頭に付加される完全修飾パスの配列です。 読み込みに失敗した場合、ローダーはベース パスが残らなくなるまで、次のパスからの読み込みを試みます。

internalModuleBaseUrls: string[];

プロパティ値

string[]

注釈

"path" フィールド値として完全修飾 URL を持たない "内部" および "ローカライズされた" スクリプト リソースはすべて、このプロパティに一覧表示されている各パスの下でホストする必要があります。 たとえば、内部モジュールの "path" フィールド値が "master_2015-04-20/my-application.bundle_1928f8a0.js" され、このフィールドの値が [ "https://contoso.akamaihd.net/files/", "https://contoso.msecnd.net/files/" ]されている場合、ローダーは最初に URL "https://contoso.akamaihd.net/files/master_2015-04-20/my-application.bundle_1928f8a0.js"からこのスクリプト リソースの読み込みを試みます。 その URL からの読み込みが失敗した場合、ローダーは "https://contoso.msecnd.net/files/master_2015-04-20/my-application.bundle_1928f8a0.js"からこのスクリプト リソースの読み込みを試みます。 その URL の読み込みに失敗すると、コンポーネントの読み込みに失敗し、エラーが返されます。 複数の基本 URL のサポートは、フェールオーバーのサポートのみを目的としているため、注意が必要です。 つまり、このフィールドに一覧表示されているすべてのホストにすべてのファイルが存在する必要があります。

使用法: "internal" または "localized" 型のスクリプト リソースのベース URL。

サポートされる値: "scriptResources" ディクショナリで参照されるすべての内部スクリプトを含む任意の URL。

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

scriptResources

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。 この API は運用環境で使用しないでください。

これは、名前付きスクリプト リソースのディクショナリです。 path モジュールと localizedPath モジュールは相互に参照され、 manifest モジュールはフレームワーク ランタイムによって提供されることが予想されます。 entryModuleIdでという名前のリソースには、コンポーネントのエクスポートされたオブジェクトが含まれている必要があります。

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

プロパティ値

{ [name: string]: IModuleConfiguration; }

注釈

サポートされる値: 名前付きスクリプト リソースのディクショナリ。

例:

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