PromucFlow_constructor/app/client/src/layoutSystems/common/useLayoutSystemFeatures.ts
Abhinav Jha 3d42333539
fix: Fix widget name canvas issues (#28314)
## Description
Fixes the following from #28310
- Use LayoutSystemType or LayoutSystemFeatures instead of feature flags
in
[app/client/src/pages/Editor/CanvasPropertyPane/index.tsx](e7603fd213 (diff-6ffc62fd8fff7633da84c1bbf822394ff49f1d89dc4ad073fff16e2f5e5d41fd))
- In WidgetNamesCanvas use SetDragginStateFnType or
SetDraggingStateActionPayload and remove the other from the codebase.

#### PR fixes following issue(s)
Fixes #28312
Fixes #28310

#### Type of change
- Bug fix (non-breaking change which fixes an issue)

#### How Has This Been Tested?
- [x] Manual
- [ ] JUnit
- [x] Jest
- [ ] Cypress

## 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
2023-10-25 11:10:43 +05:30

76 lines
2.9 KiB
TypeScript

import { useSelector } from "react-redux";
import { LayoutSystemTypes } from "layoutSystems/types";
import { getLayoutSystemType } from "selectors/layoutSystemSelectors";
export enum LayoutSystemFeatures {
ENABLE_MAIN_CONTAINER_RESIZER = "ENABLE_MAIN_CONTAINER_RESIZER",
ENABLE_FORKING_FROM_TEMPLATES = "ENABLE_FORKING_FROM_TEMPLATES",
ENABLE_CANVAS_LAYOUT_CONTROL = "ENABLE_CANVAS_LAYOUT_CONTROL",
ENABLE_CANVAS_OVERLAY_FOR_EDITOR_UI = "ENABLE_CANVAS_OVERLAY_FOR_EDITOR_UI",
ENABLE_LAYOUT_CONVERSION = "ENABLE_LAYOUT_CONVERSION",
}
const FIXED_LAYOUT_FEATURES: Record<LayoutSystemFeatures, boolean> = {
[LayoutSystemFeatures.ENABLE_FORKING_FROM_TEMPLATES]: true,
[LayoutSystemFeatures.ENABLE_CANVAS_LAYOUT_CONTROL]: true,
[LayoutSystemFeatures.ENABLE_MAIN_CONTAINER_RESIZER]: false,
[LayoutSystemFeatures.ENABLE_CANVAS_OVERLAY_FOR_EDITOR_UI]: false,
[LayoutSystemFeatures.ENABLE_LAYOUT_CONVERSION]: true,
};
const AUTO_LAYOUT_FEATURES: Record<LayoutSystemFeatures, boolean> = {
[LayoutSystemFeatures.ENABLE_FORKING_FROM_TEMPLATES]: false,
[LayoutSystemFeatures.ENABLE_CANVAS_LAYOUT_CONTROL]: false,
[LayoutSystemFeatures.ENABLE_MAIN_CONTAINER_RESIZER]: true,
[LayoutSystemFeatures.ENABLE_CANVAS_OVERLAY_FOR_EDITOR_UI]: false,
[LayoutSystemFeatures.ENABLE_LAYOUT_CONVERSION]: true,
};
const ANVIL_FEATURES: Record<LayoutSystemFeatures, boolean> = {
[LayoutSystemFeatures.ENABLE_FORKING_FROM_TEMPLATES]: false,
[LayoutSystemFeatures.ENABLE_CANVAS_LAYOUT_CONTROL]: false,
[LayoutSystemFeatures.ENABLE_MAIN_CONTAINER_RESIZER]: true,
[LayoutSystemFeatures.ENABLE_CANVAS_OVERLAY_FOR_EDITOR_UI]: true,
[LayoutSystemFeatures.ENABLE_LAYOUT_CONVERSION]: false,
};
/**
* This Hook is mainly written to be used as a central control to enable
* layout specific features based on the type of current layout.
* This way the components using it need not be aware of what layout it is on
*
* @returns This hook returns a method, which can be used to get a boolean corresponding to the feature supplied as argument.
* The boolean will indicate if the feature is enabled for the current layout
*/
export const useLayoutSystemFeatures = () => {
const layoutSystemType = useSelector(getLayoutSystemType);
let currentFeatureSet = {} as Record<LayoutSystemFeatures, boolean>;
switch (layoutSystemType) {
case LayoutSystemTypes.FIXED:
currentFeatureSet = FIXED_LAYOUT_FEATURES;
break;
case LayoutSystemTypes.AUTO:
currentFeatureSet = AUTO_LAYOUT_FEATURES;
break;
case LayoutSystemTypes.ANVIL:
currentFeatureSet = ANVIL_FEATURES;
break;
}
/**
* This method checks if the features requested in the method,
* can be enabled for the given particular layout type
*/
return (checkFeaturesArray: LayoutSystemFeatures[]) => {
const featuresArray: boolean[] = [];
for (const checkFeature of checkFeaturesArray) {
featuresArray.push(!!currentFeatureSet[checkFeature]);
}
return featuresArray;
};
};