@microsoft/sp-webpart-base/lib/core/WebPartFormFactor.d.ts

SharePoint Framework support for building web parts

/**
 * 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 declare enum 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.
     */
    Standard = 0,
    /**
     * 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.
     */
    FullSize = 1,
    /**
     * 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
     */
    FullWidth = 2
}
//# sourceMappingURL=WebPartFormFactor.d.ts.map