BaseApplicationCustomizer class

Package:

@microsoft/sp-application-base

This is the base class that third parties should extend when implementing a client-side extension that runs when an application is first starting.

Extends

BaseExtension<TProperties>

Remarks

In the component manifest, the "extensionType" should be set to "ApplicationCustomizer".

Example usage scenarios for an application customizer might include: rendering custom UI elements inside a SharePoint content placeholder, tracking page load statistics, or automatically logging the user out after a certain time period.

Properties

_dynamicDataSourceId	Override BaseComponent._dynamicDataSourceId to exclude instance id. Application Customizer's instance id changes per session.
context

Methods

dispose()	Disposes the component.
onPlaceholdersChanged(placeholderProvider)	This event method is called when the placeholders of the host application change, come into existence, or disappear. virtual

Property Details

_dynamicDataSourceId

Override BaseComponent._dynamicDataSourceId to exclude instance id. Application Customizer's instance id changes per session.

get _dynamicDataSourceId(): string;

Property Value

string

context

protected readonly context: ApplicationCustomizerContext;

Property Value

ApplicationCustomizerContext

Method Details

dispose()

Disposes the component.

dispose(): void;

Returns

void

Remarks

Third-party code generally does not need to call this method; it's invoked automatically when the lifecycle ends for a web part or extension. To perform custom cleanup when your component is disposed, override the method.

onPlaceholdersChanged(placeholderProvider)

This event method is called when the placeholders of the host application change, come into existence, or disappear. virtual

protected onPlaceholdersChanged(placeholderProvider: PlaceholderProvider): void;

Parameters

placeholderProvider

PlaceholderProvider

Returns

void