Edit

Share via

IPrefabAppToolboxEntry interface

  • Reference
Package:
@microsoft/sp-module-interfaces

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

This interface specifies the set of that can be provided by a PREFAB developer if the application should be available in the modern SharePoint toolbox.

Properties

description

Description of the PREFAB entry represented as a dictionary of locale keys to description values. This value will be displayed to the user in the toolbox. This description should be used in the Toolbox tooltip and other display areas.
iconImageUrl

The icon for the PREFAB app, to be displayed in the toolbox, represented as image URL. The image at the URL must be exactly 40x28 px (SPPPLAT VSO#218660 to fix the size of the icon image).
officeFabricIconFontName

The icon for the PREFAB entry, to be displayed in the toolbox, represented as a character name in the Office 365 icon font file.
title

Title of the PREFAB entry represented as a single a dictionary of locale keys to title values. This value will be displayed to the user in the toolbox.
viewId

The unique identifier of the route to be rendered if the entry is added to the page.

Property Details

description

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Description of the PREFAB entry represented as a dictionary of locale keys to description values. This value will be displayed to the user in the toolbox. This description should be used in the Toolbox tooltip and other display areas.

description: ILocalizedString;

Property Value

ILocalizedString

Remarks

Usage: display the description of the PREFAB route in the toolbox tooltip, and the page.

Supported values: a dictionary of locale keys to strings. Should always have a 'default' key.

Example: "A tool for displaying neat information."

         {
           "default": "A tool for displaying neat information.",
           "en-us": "A tool for displaying neat information.",
           "fr-fr": "Un outil d'affichage des informations soignées.",
           "zh": "用於顯示整潔資訊的工具。"
         }

iconImageUrl

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

The icon for the PREFAB app, to be displayed in the toolbox, represented as image URL. The image at the URL must be exactly 40x28 px (SPPPLAT VSO#218660 to fix the size of the icon image).

iconImageUrl?: string;

Property Value

string

Remarks

If the IPrefabAppToolboxEntry.officeFabricIconFontName field does not have a value, this field must have a value. This value can be an absolute URL (e.g. "http://example.com/icons/my-icon.png") or a relative file path (e.g. "./icons/my-icon.png"). In the latter case, the path will be resolved relative to the folder containing the input manifest. The icon file will be copied to the deployment folder like an asset, and the output manifest's iconImageUrl will be replaced with a URL relative to the URL used to load all other assets (the loaderConfig.internalModuleBaseUrls property).

Supported values: Any absolute URL.

Example: "https://contoso.akamaihd.net/files/myPREFABIcon.png"

officeFabricIconFontName

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

The icon for the PREFAB entry, to be displayed in the toolbox, represented as a character name in the Office 365 icon font file.

officeFabricIconFontName?: string;

Property Value

string

Remarks

The icon font is specified here: https://aka.ms/uifabric-icons If this field has a value, the IPrefabAppToolboxEntry.iconImageUrl field will be ignored.

Supported values: Any character name in the Office 365 Icon Font.

Example: "graph"

title

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Title of the PREFAB entry represented as a single a dictionary of locale keys to title values. This value will be displayed to the user in the toolbox.

title: ILocalizedString;

Property Value

ILocalizedString

Remarks

This title should be used in the Toolbox and other display areas.

Usage: display the name of the PREFAB route in the toolbox, and the page.

Supported values: a dictionary of locale keys to strings. Should always have a 'default' key.

Example: "My PREFAB App"

         {
           "default": "My PREFAB App"
           "en-us": "My PREFAB App",
           "fr-fr": "My PREFAB App",
           "zh": "我的 PREFAB 應用程式"
         }

viewId

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

The unique identifier of the route to be rendered if the entry is added to the page.

viewId: string;

Property Value

string