PromucFlow_constructor/app/client/src/widgets/ButtonGroupWidget/widget/index.tsx
balajisoundar 2608e3dbd3
chore: Move the widget config to widget class (#26073)
## Description
- Remove the config objects from widget and config maps from the widget
factory.
- Introduce methods in widget development API to dynamically fetch this
items.
- freeze the widget configuration.

#### PR fixes following issue(s)
Fixes https://github.com/appsmithorg/appsmith/issues/26008
> 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.
- 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
- [ ] 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
- [x] 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
- [x] 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-09-06 17:45:04 +05:30

839 lines
29 KiB
TypeScript

import type { Alignment } from "@blueprintjs/core";
import type { IconName } from "@blueprintjs/icons";
import type { ButtonPlacement, ButtonVariant } from "components/constants";
import { ButtonPlacementTypes, ButtonVariantTypes } from "components/constants";
import { EventType } from "constants/AppsmithActionConstants/ActionConstants";
import { ValidationTypes } from "constants/WidgetValidation";
import type { SetterConfig, Stylesheet } from "entities/AppTheming";
import { get } from "lodash";
import React from "react";
import type { WidgetProps, WidgetState } from "widgets/BaseWidget";
import BaseWidget from "widgets/BaseWidget";
import { MinimumPopupRows } from "WidgetProvider/constants";
import ButtonGroupComponent from "../component";
import { getStylesheetValue } from "./helpers";
import { DefaultAutocompleteDefinitions } from "widgets/WidgetUtils";
import type { AutocompletionDefinitions } from "WidgetProvider/constants";
import { FILL_WIDGET_MIN_WIDTH } from "constants/minWidthConstants";
import { klona as clone } from "klona/full";
import { ResponsiveBehavior } from "utils/autoLayout/constants";
import { BlueprintOperationTypes } from "WidgetProvider/constants";
import IconSVG from "../icon.svg";
import { WIDGET_TAGS } from "constants/WidgetConstants";
class ButtonGroupWidget extends BaseWidget<
ButtonGroupWidgetProps,
WidgetState
> {
static type = "BUTTON_GROUP_WIDGET";
static getConfig() {
return {
name: "Button Group", // The display name which will be made in uppercase and show in the widgets panel ( can have spaces )
iconSVG: IconSVG,
needsMeta: false, // Defines if this widget adds any meta properties
isCanvas: false, // Defines if this widget has a canvas within in which we can drop other widgets
searchTags: ["click", "submit"],
tags: [WIDGET_TAGS.BUTTONS],
};
}
static getDefaults() {
return {
rows: 4,
columns: 24,
widgetName: "ButtonGroup",
orientation: "horizontal",
buttonVariant: ButtonVariantTypes.PRIMARY,
isVisible: true,
version: 1,
animateLoading: true,
responsiveBehavior: ResponsiveBehavior.Fill,
minWidth: FILL_WIDGET_MIN_WIDTH,
groupButtons: {
groupButton1: {
label: "Favorite",
iconName: "heart",
id: "groupButton1",
widgetId: "",
buttonType: "SIMPLE",
placement: "CENTER",
isVisible: true,
isDisabled: false,
index: 0,
menuItems: {},
},
groupButton2: {
label: "Add",
iconName: "add",
id: "groupButton2",
buttonType: "SIMPLE",
placement: "CENTER",
widgetId: "",
isVisible: true,
isDisabled: false,
index: 1,
menuItems: {},
},
groupButton3: {
label: "More",
iconName: "more",
id: "groupButton3",
buttonType: "MENU",
placement: "CENTER",
widgetId: "",
isVisible: true,
isDisabled: false,
index: 2,
menuItems: {
menuItem1: {
label: "First Option",
backgroundColor: "#FFFFFF",
id: "menuItem1",
widgetId: "",
onClick: "",
isVisible: true,
isDisabled: false,
index: 0,
},
menuItem2: {
label: "Second Option",
backgroundColor: "#FFFFFF",
id: "menuItem2",
widgetId: "",
onClick: "",
isVisible: true,
isDisabled: false,
index: 1,
},
menuItem3: {
label: "Delete",
iconName: "trash",
iconColor: "#FFFFFF",
iconAlign: "right",
textColor: "#FFFFFF",
backgroundColor: "#DD4B34",
id: "menuItem3",
widgetId: "",
onClick: "",
isVisible: true,
isDisabled: false,
index: 2,
},
},
},
},
blueprint: {
operations: [
{
type: BlueprintOperationTypes.MODIFY_PROPS,
fn: (widget: WidgetProps & { children?: WidgetProps[] }) => {
const groupButtons = clone(widget.groupButtons);
const dynamicBindingPathList: any[] = get(
widget,
"dynamicBindingPathList",
[],
);
Object.keys(groupButtons).map((groupButtonKey) => {
groupButtons[groupButtonKey].buttonColor = get(
widget,
"childStylesheet.button.buttonColor",
"{{appsmith.theme.colors.primaryColor}}",
);
dynamicBindingPathList.push({
key: `groupButtons.${groupButtonKey}.buttonColor`,
});
});
const updatePropertyMap = [
{
widgetId: widget.widgetId,
propertyName: "dynamicBindingPathList",
propertyValue: dynamicBindingPathList,
},
{
widgetId: widget.widgetId,
propertyName: "groupButtons",
propertyValue: groupButtons,
},
];
return updatePropertyMap;
},
},
],
},
};
}
static getAutoLayoutConfig() {
return {
autoDimension: {
height: true,
},
widgetSize: [
{
viewportMinWidth: 0,
configuration: (props: ButtonGroupWidgetProps) => {
let minWidth = 120;
const buttonLength = Object.keys(props.groupButtons).length;
if (props.orientation === "horizontal") {
// 120 is the width of the button, 8 is widget padding, 1 is the gap between buttons
minWidth = 120 * buttonLength + 8 + (buttonLength - 1) * 1;
}
return {
minWidth: `${minWidth}px`,
minHeight: "40px",
};
},
},
],
disableResizeHandles: {
vertical: true,
},
};
}
static getAutocompleteDefinitions(): AutocompletionDefinitions {
return {
"!doc":
"The Button group widget represents a set of buttons in a group. Group can have simple buttons or menu buttons with drop-down items.",
"!url": "https://docs.appsmith.com/widget-reference/button-group",
isVisible: DefaultAutocompleteDefinitions.isVisible,
};
}
static getPropertyPaneContentConfig() {
return [
{
sectionName: "Data",
children: [
{
helpText: "Group Buttons",
propertyName: "groupButtons",
controlType: "GROUP_BUTTONS",
label: "Buttons",
isBindProperty: false,
isTriggerProperty: false,
dependencies: ["childStylesheet"],
panelConfig: {
editableTitle: true,
titlePropertyName: "label",
panelIdPropertyName: "id",
updateHook: (
props: any,
propertyPath: string,
propertyValue: string,
) => {
return [
{
propertyPath,
propertyValue,
},
];
},
contentChildren: [
{
sectionName: "Data",
children: [
{
propertyName: "buttonType",
label: "Button type",
controlType: "ICON_TABS",
fullWidth: true,
helpText: "Sets button type",
options: [
{
label: "Simple",
value: "SIMPLE",
},
{
label: "Menu",
value: "MENU",
},
],
defaultValue: "SIMPLE",
isJSConvertible: true,
isBindProperty: true,
isTriggerProperty: false,
validation: {
type: ValidationTypes.TEXT,
params: {
allowedValues: ["SIMPLE", "MENU"],
},
},
},
{
hidden: (
props: ButtonGroupWidgetProps,
propertyPath: string,
) => {
const buttonType = get(
props,
`${propertyPath.split(".", 2).join(".")}.buttonType`,
"",
);
return buttonType !== "MENU";
},
dependencies: ["groupButtons"],
helpText: "Menu items",
propertyName: "menuItems",
controlType: "MENU_ITEMS",
label: "Menu items",
isBindProperty: false,
isTriggerProperty: false,
panelConfig: {
editableTitle: true,
titlePropertyName: "label",
panelIdPropertyName: "id",
updateHook: (
props: any,
propertyPath: string,
propertyValue: string,
) => {
return [
{
propertyPath,
propertyValue,
},
];
},
contentChildren: [
{
sectionName: "Label",
children: [
{
propertyName: "label",
helpText: "Sets the label of a menu item",
label: "Text",
controlType: "INPUT_TEXT",
placeholderText: "Enter label",
isBindProperty: true,
isTriggerProperty: false,
validation: { type: ValidationTypes.TEXT },
},
],
},
{
sectionName: "General",
children: [
{
propertyName: "isVisible",
helpText:
"Controls the visibility of menu item",
label: "Visible",
controlType: "SWITCH",
isJSConvertible: true,
isBindProperty: true,
isTriggerProperty: false,
validation: {
type: ValidationTypes.BOOLEAN,
},
},
{
propertyName: "isDisabled",
helpText: "Disables menu item",
label: "Disabled",
controlType: "SWITCH",
isJSConvertible: true,
isBindProperty: true,
isTriggerProperty: false,
validation: {
type: ValidationTypes.BOOLEAN,
},
},
],
},
{
sectionName: "Events",
children: [
{
helpText: "when the menu item is clicked",
propertyName: "onClick",
label: "onClick",
controlType: "ACTION_SELECTOR",
isJSConvertible: true,
isBindProperty: true,
isTriggerProperty: true,
},
],
},
],
styleChildren: [
{
sectionName: "Icon",
children: [
{
propertyName: "iconName",
label: "Icon",
helpText:
"Sets the icon to be used for a menu item",
controlType: "ICON_SELECT",
isJSConvertible: true,
isBindProperty: true,
isTriggerProperty: false,
validation: { type: ValidationTypes.TEXT },
},
{
propertyName: "iconAlign",
label: "Position",
helpText:
"Sets the icon alignment of a menu item",
controlType: "ICON_TABS",
fullWidth: false,
options: [
{
startIcon: "skip-left-line",
value: "left",
},
{
startIcon: "skip-right-line",
value: "right",
},
],
defaultValue: "left",
isBindProperty: false,
isTriggerProperty: false,
validation: { type: ValidationTypes.TEXT },
},
],
},
{
sectionName: "Color",
children: [
{
propertyName: "backgroundColor",
helpText:
"Sets the background color of a menu item",
label: "Background color",
controlType: "COLOR_PICKER",
isJSConvertible: true,
isBindProperty: true,
isTriggerProperty: false,
validation: { type: ValidationTypes.TEXT },
},
{
propertyName: "iconColor",
helpText: "Sets the icon color of a menu item",
label: "Icon Color",
controlType: "COLOR_PICKER",
isBindProperty: false,
isTriggerProperty: false,
},
{
propertyName: "textColor",
helpText: "Sets the text color of a menu item",
label: "Text color",
controlType: "COLOR_PICKER",
isBindProperty: false,
isTriggerProperty: false,
},
],
},
],
},
},
],
},
{
sectionName: "Label",
children: [
{
propertyName: "label",
helpText: "Sets the label of a menu item",
label: "Text",
controlType: "INPUT_TEXT",
placeholderText: "Enter label",
isBindProperty: true,
isTriggerProperty: false,
validation: { type: ValidationTypes.TEXT },
},
],
},
{
sectionName: "General",
children: [
{
propertyName: "isVisible",
helpText: "Controls the visibility of the widget",
label: "Visible",
controlType: "SWITCH",
isJSConvertible: true,
isBindProperty: true,
isTriggerProperty: false,
validation: { type: ValidationTypes.BOOLEAN },
},
{
propertyName: "isDisabled",
helpText: "Disables input to the widget",
label: "Disabled",
controlType: "SWITCH",
isJSConvertible: true,
isBindProperty: true,
isTriggerProperty: false,
validation: { type: ValidationTypes.BOOLEAN },
},
],
},
{
sectionName: "Events",
hidden: (
props: ButtonGroupWidgetProps,
propertyPath: string,
) => {
const buttonType = get(
props,
`${propertyPath}.buttonType`,
"",
);
return buttonType === "MENU";
},
children: [
{
helpText: "when the button is clicked",
propertyName: "onClick",
label: "onClick",
controlType: "ACTION_SELECTOR",
isJSConvertible: true,
isBindProperty: true,
isTriggerProperty: true,
},
],
},
],
styleChildren: [
{
sectionName: "Icon",
children: [
{
propertyName: "iconName",
label: "Icon",
helpText: "Sets the icon to be used for a button",
controlType: "ICON_SELECT",
isJSConvertible: true,
isBindProperty: true,
isTriggerProperty: false,
validation: { type: ValidationTypes.TEXT },
},
{
propertyName: "iconAlign",
label: "Position",
helpText: "Sets the icon alignment of a button",
controlType: "ICON_TABS",
fullWidth: false,
options: [
{
startIcon: "skip-left-line",
value: "left",
},
{
startIcon: "skip-right-line",
value: "right",
},
],
defaultValue: "left",
isBindProperty: false,
isTriggerProperty: false,
validation: { type: ValidationTypes.TEXT },
},
{
propertyName: "placement",
label: "Placement",
controlType: "DROP_DOWN",
helpText: "Sets the space between items",
options: [
{
label: "Start",
value: ButtonPlacementTypes.START,
},
{
label: "Between",
value: ButtonPlacementTypes.BETWEEN,
},
{
label: "Center",
value: ButtonPlacementTypes.CENTER,
},
],
defaultValue: ButtonPlacementTypes.CENTER,
isJSConvertible: true,
isBindProperty: true,
isTriggerProperty: false,
validation: {
type: ValidationTypes.TEXT,
params: {
allowedValues: [
ButtonPlacementTypes.START,
ButtonPlacementTypes.BETWEEN,
ButtonPlacementTypes.CENTER,
],
default: ButtonPlacementTypes.CENTER,
},
},
},
],
},
{
sectionName: "Color",
children: [
{
getStylesheetValue,
propertyName: "buttonColor",
helpText: "Changes the color of the button",
label: "Button color",
controlType: "COLOR_PICKER",
isJSConvertible: true,
isBindProperty: true,
isTriggerProperty: false,
validation: { type: ValidationTypes.TEXT },
},
],
},
],
},
},
],
},
{
sectionName: "General",
children: [
{
helpText: "Controls the visibility of the widget",
propertyName: "isVisible",
label: "Visible",
controlType: "SWITCH",
isJSConvertible: true,
isBindProperty: true,
isTriggerProperty: false,
validation: { type: ValidationTypes.BOOLEAN },
},
{
propertyName: "isDisabled",
label: "Disabled",
controlType: "SWITCH",
helpText: "Disables clicks to this widget",
isJSConvertible: true,
isBindProperty: true,
isTriggerProperty: false,
validation: { type: ValidationTypes.BOOLEAN },
},
{
propertyName: "animateLoading",
label: "Animate loading",
controlType: "SWITCH",
helpText: "Controls the loading of the widget",
defaultValue: true,
isJSConvertible: true,
isBindProperty: true,
isTriggerProperty: false,
validation: { type: ValidationTypes.BOOLEAN },
},
],
},
];
}
static getPropertyPaneStyleConfig() {
return [
{
sectionName: "General",
children: [
{
propertyName: "buttonVariant",
label: "Button variant",
controlType: "ICON_TABS",
fullWidth: true,
helpText: "Sets the variant of the button",
options: [
{
label: "Primary",
value: ButtonVariantTypes.PRIMARY,
},
{
label: "Secondary",
value: ButtonVariantTypes.SECONDARY,
},
{
label: "Tertiary",
value: ButtonVariantTypes.TERTIARY,
},
],
defaultValue: ButtonVariantTypes.PRIMARY,
isJSConvertible: true,
isBindProperty: true,
isTriggerProperty: false,
validation: {
type: ValidationTypes.TEXT,
params: {
allowedValues: [
ButtonVariantTypes.PRIMARY,
ButtonVariantTypes.SECONDARY,
ButtonVariantTypes.TERTIARY,
],
default: ButtonVariantTypes.PRIMARY,
},
},
},
{
helpText: "Controls widget orientation",
propertyName: "orientation",
label: "Orientation",
controlType: "ICON_TABS",
fullWidth: true,
options: [
{
label: "Horizontal",
value: "horizontal",
},
{
label: "Vertical",
value: "vertical",
},
],
defaultValue: "horizontal",
isBindProperty: true,
isTriggerProperty: false,
validation: { type: ValidationTypes.TEXT },
},
],
},
{
sectionName: "Border and shadow",
children: [
{
propertyName: "borderRadius",
label: "Border radius",
helpText:
"Rounds the corners of the icon button's outer border edge",
controlType: "BORDER_RADIUS_OPTIONS",
isJSConvertible: true,
isBindProperty: true,
isTriggerProperty: false,
validation: { type: ValidationTypes.TEXT },
},
{
propertyName: "boxShadow",
label: "Box shadow",
helpText:
"Enables you to cast a drop shadow from the frame of the widget",
controlType: "BOX_SHADOW_OPTIONS",
isJSConvertible: true,
isBindProperty: true,
isTriggerProperty: false,
validation: { type: ValidationTypes.TEXT },
},
],
},
];
}
static getStylesheetConfig(): Stylesheet {
return {
borderRadius: "{{appsmith.theme.borderRadius.appBorderRadius}}",
boxShadow: "none",
childStylesheet: {
button: {
buttonColor: "{{appsmith.theme.colors.primaryColor}}",
},
},
};
}
handleClick = (onClick: string | undefined, callback: () => void): void => {
if (onClick) {
super.executeAction({
triggerPropertyName: "onClick",
dynamicString: onClick,
event: {
type: EventType.ON_CLICK,
callback,
},
});
}
};
static getSetterConfig(): SetterConfig {
return {
__setters: {
setVisibility: {
path: "isVisible",
type: "boolean",
},
setDisabled: {
path: "isDisabled",
type: "boolean",
},
},
};
}
getPageView() {
const { componentWidth } = this.getComponentDimensions();
const minPopoverWidth = MinimumPopupRows * this.props.parentColumnSpace;
return (
<ButtonGroupComponent
borderRadius={this.props.borderRadius}
boxShadow={this.props.boxShadow}
buttonClickHandler={this.handleClick}
buttonMinWidth={this.isAutoLayoutMode ? 120 : undefined}
buttonVariant={this.props.buttonVariant}
groupButtons={this.props.groupButtons}
isDisabled={this.props.isDisabled}
minHeight={this.isAutoLayoutMode ? this.props.minHeight : undefined}
minPopoverWidth={minPopoverWidth}
orientation={this.props.orientation}
renderMode={this.props.renderMode}
widgetId={this.props.widgetId}
width={componentWidth}
/>
);
}
}
export interface ButtonGroupWidgetProps extends WidgetProps {
orientation: string;
isDisabled: boolean;
borderRadius?: string;
boxShadow?: string;
buttonVariant: ButtonVariant;
groupButtons: Record<
string,
{
widgetId: string;
id: string;
index: number;
isVisible?: boolean;
isDisabled?: boolean;
label?: string;
buttonType?: string;
buttonColor?: string;
iconName?: IconName;
iconAlign?: Alignment;
placement?: ButtonPlacement;
onClick?: string;
menuItems: Record<
string,
{
widgetId: string;
id: string;
index: number;
isVisible?: boolean;
isDisabled?: boolean;
label?: string;
backgroundColor?: string;
textColor?: string;
iconName?: IconName;
iconColor?: string;
iconAlign?: Alignment;
onClick?: string;
}
>;
}
>;
}
export default ButtonGroupWidget;