Edit

Share via

IClientSideWebPartManifestEntry interface

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

This interface specifies the set of properties that can be pre-configured by a Web Part developer. Each pre-configured instance of the Web Part will need a copy of these properties. Organization admins and content authors can modify these properties on a need basis.

Properties

dataVersion

Definition: Use this field to specify the data version of the pre-configured data provided to the web part. Note that data version is different from the version field in the manifest.
description

Description of the web part 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.
fullPageAppIconImageUrl

The icon for the Application pages.
group

The group name in web part picker to contain the web part in the classic page. If no value is provided, then the web part will be displayed in the Miscellaneous group.
groupId

The group id to determine which modern group contains the web part in modern site page. The SharePoint Framework reserves group ids for predefined groups. The developer can pick one from those groups. If the developer fills an id not in the predefined groups, it falls back to Other group.
iconImageUrl

The icon for the web part, to be displayed in the toolbox, represented an 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 Web Part, to be displayed in the toolbox, represented as a character name in the Office 365 icon font file.
properties

Every web part is expected to have some custom properties. For example, an image web part might define properties for the image URL and caption text. A list web part may have the list ID and list title as its properties, and so on.
tags

This field is used to tag a web part with keywords that are different from the web part group name. Tags can be used for categorization and searching of web parts. For example, in the web part toolbox.
title

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

Property Details

dataVersion

Definition: Use this field to specify the data version of the pre-configured data provided to the web part. Note that data version is different from the version field in the manifest.

dataVersion?: string;

Property Value

string

Remarks

The manifest version is used to control the versioning of the web part code, while data version is used to control the versioning of the serialized data of the web part. Refer to dataVersion field of your web part for more information.

Usage: versioning and evolving the serialized data of the web part

Type: string representing a semantic version with only two parts

Supported values: MAJOR.MINOR

Example: "1.0"

description

Description of the web part 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

The Web Part developer may give an initial description to the web part. The organization admin and page author will have the ability to change this description as per need.

Usage: display the description of the web part in the toolbox tooltip, web part gallery 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": "用於顯示整潔資訊的工具。"
         }

fullPageAppIconImageUrl

The icon for the Application pages.

fullPageAppIconImageUrl?: string;

Property Value

string

Remarks

If this field is not defined, then the iconimageurl is used instead as the icon for Full Page apps. 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.

Supported values: Any absolute URL.

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

group

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 group name in web part picker to contain the web part in the classic page. If no value is provided, then the web part will be displayed in the Miscellaneous group.

group?: ILocalizedString;

Property Value

ILocalizedString

Remarks

Example: { "default": "Media and Content" }

groupId

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 group id to determine which modern group contains the web part in modern site page. The SharePoint Framework reserves group ids for predefined groups. The developer can pick one from those groups. If the developer fills an id not in the predefined groups, it falls back to Other group.

groupId: PredefinedGroup | string;

Property Value

PredefinedGroup | string

Remarks

Supported values: the GUID from PredefinedGroup list

Example: "cf066440-0614-43d6-98ae-0b31cf14c7c3"

iconImageUrl

The icon for the web part, to be displayed in the toolbox, represented an 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 IClientSideWebPartManifestEntry.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/myWebpartIcon.png"

officeFabricIconFontName

The icon for the Web Part, 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 IClientSideWebPartManifestEntry.iconImageUrl field will be ignored.

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

Example: "graph"

properties

Every web part is expected to have some custom properties. For example, an image web part might define properties for the image URL and caption text. A list web part may have the list ID and list title as its properties, and so on.

properties: TProperties;

Property Value

TProperties

Remarks

The SharePoint Framework passes these properties to the web parts when they are loaded. The web part developer fully controls the schema for these properties. The web part developer should follow versioning rules when updating the properties.

Usage: rendering of the web part

Example: {"imageSource": "https://contoso.akamaihd.net/files/contosoLogo.jpg", "captionText": "Contoso logo"}"

tags

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 field is used to tag a web part with keywords that are different from the web part group name. Tags can be used for categorization and searching of web parts. For example, in the web part toolbox.

tags?: ILocalizedString[];

Property Value

ILocalizedString[]

Remarks

Example [{ "default": "image" }, { "default": "media" }, { "default": "picture" }, ...]

title

Title of the web part 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. The Web Part developer may give an initial title to the web part. The organization admin and page author will have the ability to change this title as per need.

Usage: display the name of the web part in the toolbox, web part gallery and the page.

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

Example: "My Webpart"

         {
           "default": "My WebPart"
           "en-us": "My WebPart",
           "fr-fr": "Ma WebPart",
           "zh": "我的 web 部件"
         }