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

202 lines
5.1 KiB
TypeScript
Raw Normal View History

feat: Dynamic Menu Items - Menu Button Widget (#17652) * faet: Add menu items source for menu widget * feat: Add configuration panel for dynamic menu items * feat: Pass down items from sourceData to menu items widget * feat: Take menu items config from property pane for dynamic menu items * fix: Change all onMenuItemClick to onClick for dynamic menu items * feat: Create MenuComputeValue property control to add support for {{currentItem}} binding in menu widget * feat: Add JS toggles for style properties for menu widget * feat: onClick now supports currentItem for menu button widget * feat: Add currentItem autocomplete, move property pane config to separate files for menu button widget * feat: WIP - Add Dynamic Menu Items for Table Widget * Revert "feat: WIP - Add Dynamic Menu Items for Table Widget" This reverts commit 271f96211c8612bc6f073a1aab7467993b9d7e36. * fix: remove current item label by default for dynamic menu items in menu button * feat: Add source data max length 10 validation for dynamic menu items in menu button * feat: Add migrations for Dynamic Menu Items for Menu Button Widget * feat: Add cypress test for dynamic menu items for menu button * test: Update DSLMigration test with menu button widget tests * fix: Update MenuButtonWidget migration * fix: DSL migrations for menu button dynmaic items * fix: Style validations for menu widget * feat: Add more descriptive help text for configure menu items in menu button widget * feat: Change menu items source property type from dropdown to icon tabs * fix: Cy test for menu button widget to select menu items source from button tabs instead of dropdown * feat: Make ConfigureMenuItemsControl a Generic/reusable OpenNextPanelWithButtonControl * refactor: Change MenuComputeValue to MenuButtonDynamicItemsControl * refactor: Merge TABLE_PROPERTY and MENU_PROPERTY into one ARRAY_AND_ANY_PROPERTY * fix: Don't polute Menu Button DSL with properties for dynamic menu items until the source is static * style: Change color of curly braces hint in currentItem autocomplete to make it more readable * fix: remove unused import * refactor: Move child config panels to a different file, style: Change help text and placeholder for a few properties for Dynamic menu items - menu button * refactor: Change event autocomplete function name, use fast equal * refactor: Change source data validation function name and use camelCase throughout * refactor: Validation function for source data * refactor: Create different type for menuItems and configureMenuItems and reuse them property config * feat: refactor: move get items to widget instead of component * pref: Visible items to be calculated when menu button is clicked * refactor: replace !("menuItemsSource" in child) with in migration * refactor: Change controlType name from OPEN_NEXT_PANEL_WITH_BUTTON to OPEN_CONFIG_PANEL, use generic names inside OpenNextPanelWithButtonControl.tsx * refactor: Minor cleanup at MenuButtonDynamicItemsControl.tsx * refactor: Minor cleanup at MenuButtonDynamicItemsControl.tsx * fix: Change constant used in migration to a static value * test: Add tests for validations and helper for menu button * test: Add more Cypress tests for dynamic-menu-items * fix: Minor refactor at onclick handler and MenuButtonDynamicItemsControl * refactor: Rename ARRAY_AND_ANY_PROPERTY to ARRAY_TYPE_OR_TYPE * feat: Move initial source data and keys generation inside an update hook * refactor: Rename ARRAY_TYPE_OR_TYPE to ARRAY_OF_TYPE_OR_TYPE * refactor: Minor code refactor in MenuButtonWidget/widget/index.tsx * refactor: Change OpenNextPanelWithButtonControl with OpenConfigPanelControl * feat: Use traverseDSLAndMigrate for dynamic menu items migration * style: Minor code hygiene changes here and there for dynamic menu items * style: Minor code hygiene changes here and there for dynamic menu items * style: remove any type for visible items inside dynamic menu items * refactor: Change type MenuItems to MenuItem * feat: Add support for dynamic menu items (menu button) inside list widget * fix: updateMenuItemsSource hook not working when changing from DYNAMIC to STATIC menu items source * fix: Avoid empty icon name from rendering inside button and menu item * style: Fix a couple of code callouts * fix: Update import from TernServer to CodemirrorTernService * style: fix minor code callouts here and there * fix: Add check for configureMenuItems.config * fix: Add wait time after addOption click for DynamicHeight_Auto_Height_spec.js * fix: Increase the wait time for DynamicHeight_Auto_Height_spec.js to 200ms Co-authored-by: Aishwarya UR <aishwarya@appsmith.com>
2022-12-01 04:55:57 +00:00
import React from "react";
import BaseControl, { ControlProps } from "./BaseControl";
import { StyledDynamicInput } from "./StyledControls";
import CodeEditor, {
CodeEditorExpected,
} from "components/editorComponents/CodeEditor";
import {
EditorModes,
EditorSize,
EditorTheme,
TabBehaviour,
} from "components/editorComponents/CodeEditor/EditorConfig";
import { isDynamicValue } from "utils/DynamicBindingUtils";
import styled from "styled-components";
import { isString } from "utils/helpers";
import {
JSToString,
stringToJS,
} from "components/editorComponents/ActionCreator/utils";
import { AdditionalDynamicDataTree } from "utils/autocomplete/customTreeTypeDefCreator";
const PromptMessage = styled.span`
line-height: 17px;
`;
const CurlyBraces = styled.span`
color: ${(props) => props.theme.colors.codeMirror.background.hoverState};
background-color: #575757;
border-radius: 2px;
padding: 2px;
margin: 0px 2px;
font-size: 10px;
`;
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>
<CodeEditor
additionalDynamicData={additionalDynamicData}
dataTreePath={dataTreePath}
evaluatedValue={evaluatedValue}
expected={expected}
input={{
value: value,
onChange: onChange,
}}
mode={EditorModes.TEXT_WITH_BINDING}
placeholder={placeholder}
promptMessage={
<PromptMessage>
Access the current item using <CurlyBraces>{"{{"}</CurlyBraces>
currentItem
<CurlyBraces>{"}}"}</CurlyBraces>
</PromptMessage>
}
size={EditorSize.EXTENDED}
tabBehaviour={TabBehaviour.INDENT}
theme={theme}
/>
</StyledDynamicInput>
);
}
class MenuButtonDynamicItemsControl extends BaseControl<
MenuButtonDynamicItemsControlProps
> {
render() {
const {
dataTreePath,
defaultValue,
expected,
label,
propertyValue,
theme,
} = this.props;
const menuButtonId = this.props.widgetProperties.widgetName;
const value =
propertyValue && isDynamicValue(propertyValue)
? MenuButtonDynamicItemsControl.getInputComputedValue(
propertyValue,
menuButtonId,
)
: propertyValue
? propertyValue
: defaultValue;
const keys = this.props.widgetProperties.sourceDataKeys || [];
const currentItem: { [key: string]: any } = {};
Object.values(keys).forEach((key) => {
currentItem[key as keyof typeof currentItem] = undefined;
});
// Load default value in evaluated value
if (value && !propertyValue) {
this.onTextChange(value);
}
return (
<InputText
additionalDynamicData={{
currentItem,
currentIndex: -1,
}}
dataTreePath={dataTreePath}
expected={expected}
label={label}
onChange={this.onTextChange}
theme={theme}
value={value}
/>
);
}
static getBindingPrefix = (menuButtonId: string) => {
return `{{${menuButtonId}.sourceData.map((currentItem, currentIndex) => ( `;
};
static bindingSuffix = `))}}`;
static getInputComputedValue = (
propertyValue: string,
menuButtonId: string,
) => {
if (!propertyValue.includes(this.getBindingPrefix(menuButtonId))) {
return propertyValue;
}
const value = `${propertyValue.substring(
this.getBindingPrefix(menuButtonId).length,
propertyValue.length - this.bindingSuffix.length,
)}`;
const stringValue = JSToString(value);
return stringValue;
};
getComputedValue = (value: string, menuButtonId: string) => {
if (!isDynamicValue(value)) {
return value;
}
const stringToEvaluate = stringToJS(value);
if (stringToEvaluate === "") {
return stringToEvaluate;
}
return `${MenuButtonDynamicItemsControl.getBindingPrefix(
menuButtonId,
)}${stringToEvaluate}${MenuButtonDynamicItemsControl.bindingSuffix}`;
};
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.props.widgetProperties.widgetName,
);
this.updateProperty(this.props.propertyName, output);
} else {
this.updateProperty(this.props.propertyName, value);
}
};
static getControlType() {
return "MENU_BUTTON_DYNAMIC_ITEMS";
}
}
export interface MenuButtonDynamicItemsControlProps extends ControlProps {
defaultValue?: string;
}
export default MenuButtonDynamicItemsControl;