Masquer un composant WebPart dans la boîte à outils

For scenarios where you automatically instantiate a custom web part on a modern page, you might want the web part not to be manually available for end-users. This could for example be a status web part on a home page.

Configurer le masquage du composant WebPart dans la boîte à outils

Par défaut, un composant WebPart côté client SharePoint Framework sera affiché dans la boîte à outils du composant WebPart lorsqu'un utilisateur modifie une page. Pour permettre de masquer le composant WebPart de la boîte à outils, vous ajoutez la hiddenFromToolbox propriété définie sur true dans le manifeste du composant WebPart.

Notes

Le manifeste du composant se trouve à l'emplacement suivant dans un projet : ./src/webparts/{nom-dossier-webpart}/{nom-du-webpart}.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", // Other
    "group": { "default": "Other" },
    "title": { "default": "HelloWorld" },
    "description": { "default": "HelloWorld description" },
    "officeFabricIconFontName": "Page",
    "properties": {
      "description": "HelloWorld"
    }
  }]
}

En activant le paramètre hiddenFromToolbox et en modifiant une page Web, le composant WebPart ne sera pas répertorié dans la boîte d’outils lorsque vous modifierez une page Web.