PromucFlow_constructor/app/client/src/components/propertyControls/WrappedCodeEditorControl.tsx

185 lines
4.8 KiB
TypeScript
Raw Normal View History

feat: select and multiselect label value (#24964) ## Description - Select and multi-select widgets now have two new properties under the data section label and value. - The existing options have been renamed to Source data. - Users can set the label and value of the options through these new properties. - We have written migrations to make this work for existing select widgets. #### PR fixes following issue(s) Fixes https://github.com/appsmithorg/appsmith/issues/24022 > #### 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. - Bug fix (non-breaking change which fixes an issue) - New feature (non-breaking change which adds functionality) - 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) - This change requires a documentation update > > > ## 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 - [x] Jest - [x] 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 - [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 - [x] My changes generate no new warnings - [x] I have added tests that prove my fix is effective or that my feature works - [x] 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: Rishabh Rathod <rishabh.rathod@appsmith.com>
2023-07-25 04:56:33 +00:00
import React from "react";
import type { ControlProps } from "./BaseControl";
import BaseControl from "./BaseControl";
import { StyledDynamicInput } from "./StyledControls";
import type { CodeEditorExpected } from "components/editorComponents/CodeEditor";
import type { EditorTheme } from "components/editorComponents/CodeEditor/EditorConfig";
import {
EditorModes,
EditorSize,
TabBehaviour,
} from "components/editorComponents/CodeEditor/EditorConfig";
import { isDynamicValue } from "utils/DynamicBindingUtils";
import { isString } from "utils/helpers";
import { JSToString, stringToJS } from "./utils";
import type { AdditionalDynamicDataTree } from "utils/autocomplete/customTreeTypeDefCreator";
import LazyCodeEditor from "components/editorComponents/LazyCodeEditor";
import type { WidgetProps } from "widgets/BaseWidget";
type InputTextProp = {
label: string;
value: string;
onChange: (event: React.ChangeEvent<HTMLTextAreaElement> | string) => void;
evaluatedValue?: any;
expected?: CodeEditorExpected;
placeholder?: string;
dataTreePath?: string;
additionalDynamicData?: AdditionalDynamicDataTree;
theme: EditorTheme;
};
function InputText(props: InputTextProp) {
const {
additionalDynamicData,
dataTreePath,
evaluatedValue,
expected,
onChange,
placeholder,
theme,
value,
} = props;
return (
<StyledDynamicInput>
<LazyCodeEditor
AIAssisted
additionalDynamicData={additionalDynamicData}
dataTreePath={dataTreePath}
evaluatedValue={evaluatedValue}
expected={expected}
input={{
value: value,
onChange: onChange,
}}
mode={EditorModes.TEXT_WITH_BINDING}
placeholder={placeholder}
size={EditorSize.EXTENDED}
tabBehaviour={TabBehaviour.INDENT}
theme={theme}
/>
</StyledDynamicInput>
);
}
class WrappedCodeEditorControl extends BaseControl<WrappedCodeEditorControlProps> {
wrapperCode: {
prefix: string;
suffix: string;
};
constructor(props: WrappedCodeEditorControlProps) {
super(props);
this.wrapperCode = {
prefix:
typeof props.controlConfig.wrapperCode.prefix === "function"
? props.controlConfig.wrapperCode.prefix(props.widgetProperties)
: props.controlConfig.wrapperCode.prefix,
suffix:
typeof props.controlConfig.wrapperCode.suffix === "function"
? props.controlConfig.wrapperCode.suffix(props.widgetProperties)
: props.controlConfig.wrapperCode.suffix,
};
}
render() {
const {
additionalAutoComplete,
dataTreePath,
defaultValue,
expected,
label,
propertyValue,
theme,
} = this.props;
const value =
propertyValue && isDynamicValue(propertyValue)
? this.getInputComputedValue(propertyValue)
: propertyValue
? propertyValue
: defaultValue;
// Load default value in evaluated value
if (value && !propertyValue) {
this.onTextChange(value);
}
return (
<InputText
additionalDynamicData={additionalAutoComplete}
dataTreePath={dataTreePath}
expected={expected}
label={label}
onChange={this.onTextChange}
theme={theme}
value={value}
/>
);
}
getInputComputedValue = (propertyValue: string) => {
const bindingPrefix = this.wrapperCode.prefix;
if (propertyValue.includes(bindingPrefix)) {
const value = `${propertyValue.substring(
bindingPrefix.length,
propertyValue.length - this.wrapperCode.suffix.length,
)}`;
return JSToString(value);
} else {
return propertyValue;
}
};
getComputedValue = (value: string) => {
if (
!isDynamicValue(value) &&
!this.props.additionalControlData?.isArrayValue
) {
return value;
}
const stringToEvaluate = stringToJS(value);
if (stringToEvaluate === "") {
return stringToEvaluate;
}
return `${this.wrapperCode.prefix}${stringToEvaluate}${this.wrapperCode.suffix}`;
};
onTextChange = (event: React.ChangeEvent<HTMLTextAreaElement> | string) => {
let value = "";
if (typeof event !== "string") {
value = event.target?.value;
} else {
value = event;
}
if (isString(value)) {
const output = this.getComputedValue(value);
this.updateProperty(this.props.propertyName, output);
} else {
this.updateProperty(this.props.propertyName, value);
}
};
static getControlType() {
return "WRAPPED_CODE_EDITOR";
}
}
export interface WrappedCodeEditorControlProps extends ControlProps {
controlConfig: {
wrapperCode: {
prefix: string | ((widget: WidgetProps) => string);
suffix: string | ((widget: WidgetProps) => string);
};
};
}
export default WrappedCodeEditorControl;