BaseApplicationContext class

Package:

@microsoft/sp-application-base

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.

Context object for a client-side applications.

Extends

BaseComponentContext

Remarks

The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the BaseApplicationContext class.

Properties

chrome	The application page chrome
loadType	The application load type
navigator	The application navigator
prefetchedDataEvent	An event that gets fired when the application prefetched data is available.
preloadedData	The preloaded data used by SPFx
suiteNavManager	The SuiteNav manager

Property Details

chrome

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 application page chrome

get chrome(): _ISPPageChrome | undefined;

Property Value

@msinternal/sp-page-chrome!default:interface | undefined

loadType

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 application load type

get loadType(): ApplicationLoadType;

Property Value

@microsoft/sp-application-base!_ApplicationLoadType:enum

navigator

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 application navigator

get navigator(): Navigator | undefined;

Property Value

@microsoft/sp-application-base!_Navigator:class | undefined

prefetchedDataEvent

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.

An event that gets fired when the application prefetched data is available.

get prefetchedDataEvent(): SPEvent<PrefetchedDataEventArgs>;

Property Value

SPEvent<@microsoft/sp-application-base!_PrefetchedDataEventArgs:class>

preloadedData

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 preloaded data used by SPFx

get preloadedData(): _IPreloadedData;

Property Value

@microsoft/sp-loader!_IPreloadedData:interface

suiteNavManager

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 SuiteNav manager

get suiteNavManager(): ISuiteNavManager | undefined;

Property Value

@msinternal/sp-suite-nav!ISuiteNavManager:interface | undefined

Remarks

The SuiteNav manager is defined only after the application starts rendering. Chromeless application do not have a SuiteNav manager. Applications that disable the suiteNav do not have a SuiteNav manager.