@microsoft/sp-webpart-base
Version:
SharePoint Framework support for building web parts
33 lines • 1.36 kB
JavaScript
/**
* Form factor of the web part.
*
* @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.
*
* @beta
*/
export var WebPartFormFactor;
(function (WebPartFormFactor) {
/**
* Standard form factor. This means the web part is rendered in a canvas, potentially with other web parts.
* In this case, the width is determined by the container, and web part self-adjust for height.
*/
WebPartFormFactor[WebPartFormFactor["Standard"] = 0] = "Standard";
/**
* Full size form factor. This means the web part is rendered in full size, taking all space available in the page.
*
* @remarks
* This is the case for Teams tabs or single web part App pages.
*/
WebPartFormFactor[WebPartFormFactor["FullSize"] = 1] = "FullSize";
/**
* Full width form factor. This means the web part has 100% of the width of the page, but the height is controlled
* by the web part.
*
* @alpha
*/
WebPartFormFactor[WebPartFormFactor["FullWidth"] = 2] = "FullWidth";
})(WebPartFormFactor || (WebPartFormFactor = {}));
//# sourceMappingURL=WebPartFormFactor.js.map