SharePoint Framework でライブラリ コンポーネント タイプを使用するUsing library component type in SharePoint Framework

ライブラリ コンポーネント タイプを使用すると、コードのバージョン管理および展開を個別に行うことができます。テナント アプリ カタログを通じて展開することにより、この処理は SharePoint Framework のコンポーネントに対して自動的に行われます。Library component type enables you to have independently versioned and deployed code, which is served automatically for the SharePoint Framework components with a deployment through app catalog. ライブラリ コンポーネントには、共有コードを作成するための代替オプションが用意されています。共有コードは、テナント内のすべてのコンポーネントで相互に使用および参照することができます。Library component provides you alternative option to create shared code, which can be then used and referenced cross all the components in the tenant.

ライブラリ コンポーネント ソリューションを作成するには、Yeoman ソリューション作成フロー内でコンポーネント タイプとして Library を選択します。You can create a library component solution by selecting Component Type to be Library in the Yeoman solution creation flow.

ライブラリ コンポーネントには、次のような特徴があります。Library components have following characteristics:

  • この時点でテナント内でホストできるライブラリ コンポーネントのバージョンは 1 つだけです。You can only host one library component version at the time in a tenant
  • ライブラリ コンポーネントを含むソリューションにその他のコンポーネント タイプを含めることはサポートされていません。It is not supported to have other component types included in a solution which contains library component
  • パッケージ マネージャーから、または npm link を使用して開発するときには、ライブラリに依存するソリューションをバンドルできるように、ライブラリ コンポーネント タイプを参照する必要があります。You will need to reference library component type during development time from a package manager or using npm link to be able to bundle solutions which are dependent on it
  • サイト コレクション アプリ カタログを使用してソリューションを展開する場合、ライブラリ コンポーネントはサポートされません。Library components are not supported when solution is deployed using site collection app catalog

SharePoint ソリューションでライブラリ コンポーネントの依存関係を参照するには、package.json ファイル内にその依存関係を定義します。You can reference library component dependency in the SharePoint solution by defining the dependency in the package.json file. このような依存関係がソリューション パッケージに存在する場合は、SharePoint によってページ用の依存コンポーネントが自動的に読み込まれます。When this kind of dependency exists in a solution package, SharePoint will automatically load the dependent component for the page. ライブラリ参照が解決されない場合、そのライブラリを参照していたコンポーネントで例外が発生する可能性があります。If library reference is not resolved, that can cause an exception in the component which was referring it.