## Description Create a Basewidget wrapper that supplies Widget Onion as per the layout system. involves extracting widget layers presently in the BaseWidget into HOCs and hooks and make sure layout systems can be scaled. Make sure Modal widget is handled as a overlay widget whose wrappers are supplied by basewidget instead of modal widget implementing its own editing blocks. This PR also separates the drag n drop logic for both auto layout and fixed layout. They are moved into respective Layout system folders to have clear sepsration of concern #### PR fixes following issue(s) Fixes #26674 Fixes #26675 Fixes #26676 Fixes #26570 Fixes #26590 Fixes #26591 Fixes #26592 <img width="931" alt="BaseWidgetHOC" src="https://github.com/appsmithorg/appsmith/assets/35134347/22f4cf1e-e4c5-4475-83a8-6818e7cebe70"> [Miro Link to view the new system](https://miro.com/app/board/uXjVM6vRgf8=/?moveToWidget=3458764560239189204&cot=14) > if no issue exists, please create an issue and ask the maintainers about this first > > #### Media > A video or a GIF is preferred. when using Loom, don’t embed because it looks like it’s a GIF. instead, just link to the video > > #### Type of change > Please delete options that are not relevant. - Breaking change (fix or feature that would cause existing functionality to not work as expected) - Chore (housekeeping or task changes that don't impact user perception) > > > ## Testing > #### How Has This Been Tested? > Please describe the tests that you ran to verify your changes. Also list any relevant details for your test configuration. > Delete anything that is not relevant - [x] Manual - [ ] JUnit - [ ] Jest - [ ] Cypress > > #### Test Plan > Add Testsmith test cases links that relate to this PR > > #### Issues raised during DP testing > Link issues raised during DP testing for better visiblity and tracking (copy link from comments dropped on this PR) > > > ## Checklist: #### Dev activity - [ ] My code follows the style guidelines of this project - [ ] I have performed a self-review of my own code - [ ] I have commented my code, particularly in hard-to-understand areas - [ ] I have made corresponding changes to the documentation - [ ] My changes generate no new warnings - [ ] I have added tests that prove my fix is effective or that my feature works - [ ] New and existing unit tests pass locally with my changes - [ ] PR is being merged under a feature flag #### QA activity: - [ ] [Speedbreak features](https://github.com/appsmithorg/TestSmith/wiki/Guidelines-for-test-plans#speedbreakers-) have been covered - [ ] Test plan covers all impacted features and [areas of interest](https://github.com/appsmithorg/TestSmith/wiki/Guidelines-for-test-plans#areas-of-interest-) - [ ] Test plan has been peer reviewed by project stakeholders and other QA members - [ ] Manually tested functionality on DP - [ ] We had an implementation alignment call with stakeholders post QA Round 2 - [ ] Cypress test cases have been added and approved by SDET/manual QA - [ ] Added `Test Plan Approved` label after Cypress tests were reviewed - [ ] Added `Test Plan Approved` label after JUnit tests were reviewed --------- Co-authored-by: rahulramesha <rahul@appsmith.com> Co-authored-by: rahulramesha <71900764+rahulramesha@users.noreply.github.com> Co-authored-by: Preet Sidhu <preetsidhu.bits@gmail.com> Co-authored-by: Aswath K <aswath.sana@gmail.com>
209 lines
6.2 KiB
TypeScript
209 lines
6.2 KiB
TypeScript
import {
|
|
GridDefaults,
|
|
MAIN_CONTAINER_WIDGET_ID,
|
|
} from "constants/WidgetConstants";
|
|
import type { CanvasWidgetsReduxState } from "reducers/entityReducers/canvasWidgetsReducer";
|
|
import type { FlattenedWidgetProps } from "WidgetProvider/constants";
|
|
import {
|
|
getBottomRow,
|
|
getTopRow,
|
|
getWidgetMinMaxDimensionsInPixel,
|
|
getWidgetRows,
|
|
setDimensions,
|
|
} from "./flexWidgetUtils";
|
|
|
|
/**
|
|
* Determine whether the parent height should be updated or not.
|
|
* 1. Update if computed height of all children is not equal to parent height.
|
|
* 2. Do not update if the widget is a list item container.
|
|
* @param widget | FlattenedWidgetProps : Current widget.
|
|
* @param widgets | CanvasWidgetsReduxState : All widgets.
|
|
* @param parentHeight | number : Current height of the widget.
|
|
* @param computedHeight | number : Min height required to render all children.
|
|
* @param mainCanvasWidth | number : Width of the main canvas.
|
|
* @returns boolean
|
|
*/
|
|
export function shouldUpdateParentHeight(
|
|
widgets: CanvasWidgetsReduxState,
|
|
widget: FlattenedWidgetProps,
|
|
computedHeight: number,
|
|
parentHeight: number,
|
|
): boolean {
|
|
if (
|
|
widget?.isListItemContainer ||
|
|
(widget.parentId && widgets[widget.parentId].type === "LIST_WIDGET_V2") ||
|
|
widget.type === "LIST_WIDGET_V2"
|
|
)
|
|
return false;
|
|
|
|
if (widget.parentId && widgets[widget.parentId].type === "TABS_WIDGET") {
|
|
return true;
|
|
}
|
|
|
|
return computedHeight !== parentHeight;
|
|
}
|
|
|
|
/**
|
|
* Compute total height required by the canvas.
|
|
* @param parent | FlattenedWidgetProps : Parent widget.
|
|
* @param computedHeight | number : Min height required to render all children.
|
|
* @returns number
|
|
*/
|
|
export function getComputedHeight(
|
|
parent: FlattenedWidgetProps,
|
|
widgets: CanvasWidgetsReduxState,
|
|
computedHeight: number,
|
|
mainCanvasWidth: number,
|
|
): number {
|
|
let res: number = computedHeight;
|
|
/**
|
|
* add padding buffer for canvas.
|
|
* if parentRowSpace === 1, => type === CANVAS_WIDGET
|
|
*/
|
|
if (parent.type === "CANVAS_WIDGET")
|
|
res +=
|
|
parent.widgetId === MAIN_CONTAINER_WIDGET_ID
|
|
? GridDefaults.MAIN_CANVAS_EXTENSION_OFFSET
|
|
: 2;
|
|
|
|
/**
|
|
* If widget is a Tabs widget, and tabs are visible,
|
|
* add 4 rows to the height to accommodate the tab header.
|
|
*/
|
|
if (parent.type === "TABS_WIDGET" && parent?.shouldShowTabs) res += 4;
|
|
|
|
const minHeight: number =
|
|
parent.widgetId !== MAIN_CONTAINER_WIDGET_ID
|
|
? (getWidgetMinMaxDimensionsInPixel(parent, mainCanvasWidth)?.minHeight ||
|
|
0) / GridDefaults.DEFAULT_GRID_ROW_HEIGHT
|
|
: (parent.minHeight || 0) / GridDefaults.DEFAULT_GRID_ROW_HEIGHT;
|
|
/**
|
|
* If the widget is a canvas widget and it's parent is not the main container,
|
|
* then we need to check the parent's minHeight as well.
|
|
* e.g. an empty canvas may require only 5 rows.
|
|
* However a tab widget requires a min of 30 rows. So the child canvas must comply.
|
|
*/
|
|
let containerMinHeight = 0;
|
|
if (
|
|
parent.type === "CANVAS_WIDGET" &&
|
|
parent.parentId &&
|
|
parent.parentId !== MAIN_CONTAINER_WIDGET_ID
|
|
) {
|
|
const container = widgets[parent.parentId];
|
|
containerMinHeight =
|
|
(getWidgetMinMaxDimensionsInPixel(container, mainCanvasWidth)
|
|
?.minHeight || 0) / GridDefaults.DEFAULT_GRID_ROW_HEIGHT;
|
|
if (container.type === "TABS_WIDGET" && container?.shouldShowTabs)
|
|
containerMinHeight -= 4;
|
|
}
|
|
res = Math.max(res, minHeight, containerMinHeight);
|
|
return res;
|
|
}
|
|
|
|
/**
|
|
* Set the new height of the parent widget.
|
|
* @param parent | FlattenedWidgetProps : Parent widget.
|
|
* @param height | number : Height to be set.
|
|
* @param modalHeight | number : Height of the modal.
|
|
* @param isMobile | boolean : Is mobile viewport.
|
|
* @returns FlattenedWidgetProps
|
|
*/
|
|
export function updateParentHeight(
|
|
parent: FlattenedWidgetProps,
|
|
height: number,
|
|
modalHeight: number,
|
|
isMobile = false,
|
|
): FlattenedWidgetProps {
|
|
const parentTopRow: number = getTopRow(parent, isMobile);
|
|
let updatedParent = setDimensions(
|
|
parent,
|
|
parentTopRow,
|
|
parentTopRow + height,
|
|
null,
|
|
null,
|
|
isMobile,
|
|
);
|
|
/**
|
|
* For Modal widget, set additional height property
|
|
*/
|
|
if (parent.type === "MODAL_WIDGET") {
|
|
// Add a couple of pixels to the modal height to avoid scrollbars.
|
|
const bufferForModal = 2;
|
|
updatedParent = {
|
|
...updatedParent,
|
|
height: modalHeight + bufferForModal,
|
|
};
|
|
}
|
|
return updatedParent;
|
|
}
|
|
|
|
/**
|
|
* Get height of modal widget. => rows * rowSpace
|
|
* @param parent | FlattenedWidgetProps
|
|
* @param computedHeight | number
|
|
* @param divisor | number
|
|
* @returns number
|
|
*/
|
|
export function getModalHeight(
|
|
parent: FlattenedWidgetProps,
|
|
computedHeight: number,
|
|
divisor: number,
|
|
): number {
|
|
let res: number = computedHeight;
|
|
// if (parent.parentRowSpace === 1) res -= 2;
|
|
res *= divisor;
|
|
if (parent.type === "MODAL_WIDGET")
|
|
res *= divisor === 1 ? GridDefaults.DEFAULT_GRID_ROW_HEIGHT : 1;
|
|
return res;
|
|
}
|
|
|
|
export function getDivisor(widget: FlattenedWidgetProps): number {
|
|
return widget.type === "CANVAS_WIDGET"
|
|
? GridDefaults.DEFAULT_GRID_ROW_HEIGHT
|
|
: 1;
|
|
}
|
|
|
|
export function getContainerLikeWidgetHeight(
|
|
widgets: CanvasWidgetsReduxState,
|
|
parent: FlattenedWidgetProps,
|
|
isMobile: boolean,
|
|
metaProps?: Record<string, any>,
|
|
): number {
|
|
if (!parent.children || !parent.children.length)
|
|
return getWidgetRows(parent, isMobile);
|
|
let children: string[] = parent?.children;
|
|
|
|
/**
|
|
* If the parent is a tabs widget,
|
|
* then we need to get the selected tab widget id
|
|
*/
|
|
if (parent.type === "TABS_WIDGET") {
|
|
if (
|
|
metaProps &&
|
|
metaProps[parent.widgetId] &&
|
|
metaProps[parent.widgetId]?.selectedTabWidgetId
|
|
) {
|
|
children = [metaProps[parent.widgetId]?.selectedTabWidgetId];
|
|
} else children = [parent.children[0]];
|
|
}
|
|
return getTotalRowsOfAllChildren(widgets, children, isMobile);
|
|
}
|
|
|
|
export function getTotalRowsOfAllChildren(
|
|
widgets: CanvasWidgetsReduxState,
|
|
children: string[],
|
|
isMobile: boolean,
|
|
): number {
|
|
if (!children || !children.length) return 0;
|
|
let top = 10000,
|
|
bottom = 0;
|
|
for (const childId of children) {
|
|
const child = widgets[childId];
|
|
if (!child) continue;
|
|
const divisor = getDivisor(child);
|
|
top = Math.min(top, getTopRow(child, isMobile));
|
|
bottom = Math.max(bottom, getBottomRow(child, isMobile) / divisor);
|
|
}
|
|
return bottom - top;
|
|
}
|