## Description
1. Add new ```appPositioningType``` : ANVIL.
2. Create new code path and folder structure for Anvil layout system.
3. Move common pieces of functionalities between autoLayout and anvil to
anvil folder structure (e.g. ```CanvasResizer```).
4. Create ```AnvilFlexComponent```.
5. Use WDS Flex component in AnvilFlexComponent.
6. Pass min max size props in a data structure that is supported by
container queries in the Flex component.
e.g. min-width: { base: "120px", "480px": "200px" }
7. Supply the following flex properties (flex-grow flex-shrink
flex-basis) to widgets depending on their ```responsiveBehvaiour```:
a) Fill: ```flex: 1 1 0%;```
b) Hug: ```flex: 0 0 auto;```
#### PR fixes following issue(s)
Fixes # (issue number)
1. [#26987](https://github.com/appsmithorg/appsmith/issues/26987)
2. [#26609](https://github.com/appsmithorg/appsmith/issues/26609)
3. [#26611](https://github.com/appsmithorg/appsmith/issues/26611)
#### Type of change
- New feature (non-breaking change which adds functionality)
## 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
- [x] Jest
- [ ] Cypress
## Checklist:
#### Dev activity
- [x] My code follows the style guidelines of this project
- [x] I have performed a self-review of my own code
- [x] 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
- [x] 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
- [x] 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: Ashok Kumar M <35134347+marks0351@users.noreply.github.com>
Co-authored-by: Aswath K <aswath.sana@gmail.com>
Co-authored-by: rahulramesha <rahul@appsmith.com>
Co-authored-by: rahulramesha <71900764+rahulramesha@users.noreply.github.com>
233 lines
6.4 KiB
TypeScript
233 lines
6.4 KiB
TypeScript
import { FlexLayerAlignment } from "layoutSystems/common/utils/constants";
|
|
import { isArray } from "lodash";
|
|
import type { CanvasWidgetsReduxState } from "reducers/entityReducers/canvasWidgetsReducer";
|
|
import { updateWidgetPositions } from "./positionUtils";
|
|
import type { FlexLayer, LayerChild } from "./types";
|
|
|
|
/**
|
|
* Transform movedWidgets to FlexLayer format,
|
|
* and determine if the new widgets have a fill child.
|
|
* @param movedWidgets
|
|
* @param allWidgets
|
|
* @param alignment
|
|
* @returns FlexLayer
|
|
*/
|
|
export function createFlexLayer(
|
|
movedWidgets: string[],
|
|
allWidgets: CanvasWidgetsReduxState,
|
|
alignment: FlexLayerAlignment,
|
|
): FlexLayer {
|
|
const children = [];
|
|
if (movedWidgets && movedWidgets.length) {
|
|
for (const id of movedWidgets) {
|
|
const widget = allWidgets[id];
|
|
if (!widget) continue;
|
|
children.push({ id, align: alignment });
|
|
}
|
|
}
|
|
return { children };
|
|
}
|
|
|
|
/**
|
|
* Remove moved widgets from current layers.
|
|
* Return non-empty layers.
|
|
* @param allWidgets
|
|
* @param movedWidgets
|
|
* @param flexLayers
|
|
* @returns FlexLayer[]
|
|
*/
|
|
export function removeWidgetsFromCurrentLayers(
|
|
movedWidgets: string[],
|
|
flexLayers: FlexLayer[],
|
|
): FlexLayer[] {
|
|
if (!flexLayers || !flexLayers.length) return [];
|
|
return flexLayers?.reduce((acc: FlexLayer[], layer: FlexLayer) => {
|
|
const children = layer.children.filter(
|
|
(each: LayerChild) => movedWidgets.indexOf(each.id) === -1,
|
|
);
|
|
if (children.length) {
|
|
acc.push({
|
|
...layer,
|
|
children,
|
|
});
|
|
}
|
|
return acc;
|
|
}, []);
|
|
}
|
|
|
|
/**
|
|
* For all moved widgets,
|
|
* delete relationship with previous parent and
|
|
* add relationship with new parent
|
|
* @param movedWidgets
|
|
* @param widgets
|
|
* @param parentId
|
|
* @returns widgets
|
|
*/
|
|
export function updateRelationships(
|
|
movedWidgets: string[],
|
|
allWidgets: CanvasWidgetsReduxState,
|
|
parentId: string,
|
|
onlyUpdateFlexLayers = false,
|
|
isMobile = false,
|
|
mainCanvasWidth: number,
|
|
metaProps?: Record<string, any>,
|
|
): CanvasWidgetsReduxState {
|
|
const widgets = { ...allWidgets };
|
|
// Check if parent has changed
|
|
const orphans = movedWidgets.filter(
|
|
(item) => widgets[item].parentId !== parentId,
|
|
);
|
|
const prevParents: string[] = [];
|
|
if (orphans && orphans.length) {
|
|
//parent has changed
|
|
orphans.forEach((item) => {
|
|
// remove from previous parent
|
|
const prevParentId = widgets[item].parentId;
|
|
if (prevParentId !== undefined) {
|
|
prevParents.push(prevParentId);
|
|
const prevParent = Object.assign({}, widgets[prevParentId]);
|
|
if (isArray(prevParent.children)) {
|
|
const updatedPrevParent = {
|
|
...prevParent,
|
|
children: onlyUpdateFlexLayers
|
|
? prevParent.children
|
|
: prevParent.children.filter((each) => each !== item),
|
|
flexLayers:
|
|
prevParent.flexLayers !== undefined &&
|
|
removeWidgetsFromCurrentLayers(
|
|
movedWidgets,
|
|
prevParent.flexLayers,
|
|
),
|
|
};
|
|
widgets[prevParentId] = updatedPrevParent;
|
|
}
|
|
}
|
|
|
|
// add to new parent
|
|
if (!onlyUpdateFlexLayers) {
|
|
widgets[item] = {
|
|
...widgets[item],
|
|
parentId: parentId,
|
|
};
|
|
}
|
|
});
|
|
}
|
|
if (prevParents.length) {
|
|
for (const id of prevParents) {
|
|
const updatedWidgets = updateWidgetPositions(
|
|
widgets,
|
|
id,
|
|
isMobile,
|
|
mainCanvasWidth,
|
|
false,
|
|
metaProps,
|
|
);
|
|
return updatedWidgets;
|
|
}
|
|
}
|
|
return widgets;
|
|
}
|
|
|
|
/**
|
|
* If widgets are dropped into a new vertical position in an auto-layout canvas,
|
|
* then add a new FlexLayer to contain the new widgets.
|
|
* Use the layerIndex to add the new layer at the right position.
|
|
* @param newLayer | FlexLayer
|
|
* @param allWidgets | CanvasWidgetsReduxState
|
|
* @param parentId | string
|
|
* @param layers | FlexLayer[]
|
|
* @param layerIndex | number
|
|
* @returns CanvasWidgetsReduxState
|
|
*/
|
|
export function addNewLayer(
|
|
newLayer: FlexLayer,
|
|
allWidgets: CanvasWidgetsReduxState,
|
|
parentId: string,
|
|
layers: FlexLayer[],
|
|
layerIndex = 0,
|
|
): CanvasWidgetsReduxState {
|
|
const widgets: CanvasWidgetsReduxState = Object.assign({}, allWidgets);
|
|
const canvas = widgets[parentId];
|
|
|
|
const pos = layerIndex > layers.length ? layers.length : layerIndex;
|
|
|
|
const updatedCanvas = {
|
|
...canvas,
|
|
flexLayers: [...layers.slice(0, pos), newLayer, ...layers.slice(pos)],
|
|
};
|
|
|
|
const updatedWidgets = {
|
|
...widgets,
|
|
[parentId]: updatedCanvas,
|
|
};
|
|
|
|
return updatedWidgets;
|
|
}
|
|
|
|
/**
|
|
*
|
|
* @param newLayer | FlexLayer : FlexLayer comprised of the moved widgets and selected alignment.
|
|
* @param allWidgets | CanvasWidgetsReduxState
|
|
* @param parentId | string : new parentId
|
|
* @param layers | FlexLayer[] : flexLayers of new parent.
|
|
* @param layerIndex | number : index of existing layer to add the moved widgets to.
|
|
* @param rowIndex | number : starting index of the moved widgets within an alignment in the selected layer.
|
|
* @returns CanvasWidgetsReduxState
|
|
*/
|
|
export function updateExistingLayer(
|
|
newLayer: FlexLayer,
|
|
allWidgets: CanvasWidgetsReduxState,
|
|
parentId: string,
|
|
layers: FlexLayer[],
|
|
layerIndex = 0,
|
|
rowIndex: number,
|
|
): CanvasWidgetsReduxState {
|
|
try {
|
|
const widgets: CanvasWidgetsReduxState = { ...allWidgets };
|
|
const canvas = widgets[parentId];
|
|
if (!canvas || !newLayer) return widgets;
|
|
|
|
const map: { [key: string]: LayerChild[] } = {
|
|
[FlexLayerAlignment.Start]: [],
|
|
[FlexLayerAlignment.Center]: [],
|
|
[FlexLayerAlignment.End]: [],
|
|
};
|
|
|
|
for (const child of layers[layerIndex]?.children) {
|
|
map[child.align] = [...map[child.align], child];
|
|
}
|
|
const alignment = newLayer.children[0].align;
|
|
map[alignment] = [
|
|
...map[alignment].slice(0, rowIndex),
|
|
...newLayer?.children,
|
|
...map[alignment].slice(rowIndex),
|
|
];
|
|
|
|
// merge the selected layer with the new layer.
|
|
const selectedLayer = {
|
|
...layers[layerIndex],
|
|
children: [
|
|
...map[FlexLayerAlignment.Start],
|
|
...map[FlexLayerAlignment.Center],
|
|
...map[FlexLayerAlignment.End],
|
|
],
|
|
};
|
|
|
|
const updatedCanvas = {
|
|
...canvas,
|
|
flexLayers: [
|
|
...layers.slice(0, layerIndex),
|
|
selectedLayer,
|
|
...layers.slice(layerIndex + 1),
|
|
],
|
|
};
|
|
|
|
const updatedWidgets = { ...widgets, [parentId]: updatedCanvas };
|
|
return updatedWidgets;
|
|
} catch (e) {
|
|
// console.error("#### update existing layer error", e);
|
|
return allWidgets;
|
|
}
|
|
}
|