Edit

Share via

WebPartContext class

  • Reference
Package:
@microsoft/sp-webpart-base

Web part context object. This object contains the contextual services available to a web part. e.g. a contextual instance to the http client.

Extends
BaseWebPartContext

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 WebPartContext class.

Properties

domElement

Reference to the DOM element that hosts this client-side component.
microsoftTeams

Contextual information about the current Microsoft Teams tab. This object will only be defined if a component is being hosted in Microsoft Teams.
sdks

Conditional set of SDKs provided by SPFx dependent on the environment.
statusRenderer

Web part status renderer.
widthCacheKey

This functions returns a key generated by web parts display mode, layout index, and section factor. It will return undefined if sectionFactor or display mode is undefined, else return the cache key.

Property Details

domElement

Reference to the DOM element that hosts this client-side component.

get domElement(): HTMLElement;

Property Value

HTMLElement

microsoftTeams

Warning

This API is now deprecated.

  • This function has been deprecated

Contextual information about the current Microsoft Teams tab. This object will only be defined if a component is being hosted in Microsoft Teams.

get microsoftTeams(): typeof microsoftTeams | undefined;

Property Value

typeof @microsoft/sp-webpart-base!~microsoftTeams | undefined

Remarks

For more information, please see: https://docs.microsoft.com/en-us/javascript/api/@microsoft/teams-js/?view=msteams-client-js-latest

sdks

Conditional set of SDKs provided by SPFx dependent on the environment.

get sdks(): ISDKs;

Property Value

ISDKs

statusRenderer

Web part status renderer.

get statusRenderer(): IClientSideWebPartStatusRenderer;

Property Value

IClientSideWebPartStatusRenderer

widthCacheKey

This functions returns a key generated by web parts display mode, layout index, and section factor. It will return undefined if sectionFactor or display mode is undefined, else return the cache key.

get widthCacheKey(): string | undefined;

Property Value

string | undefined