sp webpart base.webpartformfactor

Home > @microsoft/sp-webpart-base > WebPartFormFactor

WebPartFormFactor variable

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.

Signature:

WebPartFormFactor: {
    readonly Standard: 0;
    readonly FullSize: 1;
    readonly FullWidth: 2;
}

Remarks

This will change based on how the web part is used, not by the web part itself. In cases like web parts used in Teams tab or as App pages, it will have full size form factor. If a web part is render in a canvas, with other web parts, it will have a canvas web part form factor.