Add-PnPApplicationCustomizer

Tip

We encourage you to make improvements to this documentation. Please navigate to https://github.com/pnp/powershell/blob/dev/documentation/Add-PnPApplicationCustomizer.md to change this file.

Adds a SharePoint Framework client side extension application customizer

Syntax

Add-PnPApplicationCustomizer
   [-Title <String>]
   [-Description <String>]
   [-Sequence <Int32>]
   [-Scope <CustomActionScope>]
   -ClientSideComponentId <Guid>
   [-ClientSideComponentProperties <String>]
   [-ClientSideHostProperties <String>]
   [-Connection <PnPConnection>]
   [<CommonParameters>]

Description

Adds a SharePoint Framework client side extension application customizer by registering a user custom action to a web or sitecollection

Examples

EXAMPLE 1

Add-PnPApplicationCustomizer -Title "CollabFooter" -ClientSideComponentId c0ab3b94-8609-40cf-861e-2a1759170b43 -ClientSideComponentProperties "{`"sourceTermSet`":`"PnP-CollabFooter-SharedLinks`",`"personalItemsStorageProperty`":`"PnP-CollabFooter-MyLinks`"}

Adds a new application customizer to the current web. This requires that a SharePoint Framework solution has been deployed containing the application customizer specified in its manifest. Be sure to run Install-PnPApp before trying this cmdlet on a site.

Parameters

-ClientSideComponentId

The Client Side Component Id of the SharePoint Framework client side extension application customizer found in the manifest

Type:Guid
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-ClientSideComponentProperties

The Client Side Component Properties of the application customizer. Specify values as a json string : "{Property1 : 'Value1', Property2: 'Value2'}"

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-ClientSideHostProperties

The Client Side Host Properties of the application customizer. Specify values as a json string : "{'preAllocatedApplicationCustomizerTopHeight': '50', 'preAllocatedApplicationCustomizerBottomHeight': '50'}"

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Connection

Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.

Type:PnPConnection
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Description

The description of the application customizer

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Scope

The scope of the CustomAction to add to. Either Web or Site; defaults to Web. 'All' is not valid for this command.

Type:CustomActionScope
Accepted values:Web, Site, All
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Sequence

Sequence of this application customizer being injected. Use when you have a specific sequence with which to have multiple application customizers being added to the page.

Type:Int32
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Title

The title of the application customizer

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False