ツールボックスで Web パーツを非表示にする

モダン ページでカスタム Web パーツを自動的にインスタンス化するシナリオで、エンド ユーザーが Web パーツを手動で使用できないようにすることが必要な場合があります。 たとえば、ホーム ページの状態 Web パーツなどです。

ツールボックスから Web パーツを非表示にするよう構成する

ユーザーがページを編集するとき、SharePoint Framework のクライアント側の Web パーツが Web パーツ ツールボックスに既定で表示されます。 ツールボックスから Web パーツを非表示にするには、Web パーツのマニフェストで hiddenFromToolbox プロパティを true に設定します。

注:

コンポーネント マニフェストは、プロジェクト内の次の場所にあります: ./src/webparts/{webpart-folder-name}/{webpart-name}.manifest.json。

{
  "$schema": "https://developer.microsoft.com/json-schemas/spfx/client-side-web-part-manifest.schema.json",
  "id": "34f6d7f2-262f-460a-8b65-152d784127cb",
  "alias": "HelloWorldWebPart",
  "componentType": "WebPart",

  "version": "*",
  "manifestVersion": 2,

  "requiresCustomScript": false,
  "hiddenFromToolbox": true,

  "preconfiguredEntries": [{
    "groupId": "5c03119e-3074-46fd-976b-c60198311f70", // Advanced
    "group": { "default": "Advanced" },
    "title": { "default": "HelloWorld" },
    "description": { "default": "HelloWorld description" },
    "officeFabricIconFontName": "Page",
    "properties": {
      "description": "HelloWorld"
    }
  }]
}

hiddenFromToolbox の設定を有効にすると、ページを編集するときに、ツールボックスの一覧に Web パーツは表示されません。