Edit

Share via

BaseWebPartContext 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.

This base is to be extended by UI-specific WebPart's base.

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

Properties

formFactor

Form factor of the web part.
manifest

Manifest for the client-side component.
propertyPane

Accessor for common web part property pane operations.
webPartTag

Web part tag to be used for logging and telemetry.

Property Details

formFactor

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.

Form factor of the web part.

get formFactor(): WebPartFormFactor;

Property Value

WebPartFormFactor

Remarks

Web parts may behave differently based on its form factor. E.g. a web part rendering as full size may want to set up different margins that when rendering in a canvas.

manifest

Manifest for the client-side component.

readonly manifest: IClientSideWebPartManifestInstance<any>;

Property Value

IClientSideWebPartManifestInstance<any>

propertyPane

Accessor for common web part property pane operations.

get propertyPane(): IPropertyPaneAccessor;

Property Value

IPropertyPaneAccessor

webPartTag

Web part tag to be used for logging and telemetry.

get webPartTag(): string;

Property Value

string