PromucFlow_constructor/app/client/src/components/propertyControls/CustomWidgetAddEventButtonControl.tsx
balajisoundar 5d44d4f2cf
chore: misc updates to custom widget (#30114)
#### PR fixes following issue(s)
Fixes https://github.com/appsmithorg/appsmith/issues/29991
Fixes https://github.com/appsmithorg/appsmith/issues/30154
Fixes https://github.com/appsmithorg/appsmith/issues/30020
Fixes https://github.com/appsmithorg/appsmith/issues/30019
Fixes https://github.com/appsmithorg/appsmith/issues/30130
Fixes https://github.com/appsmithorg/appsmith/issues/30159
Fixes https://github.com/appsmithorg/appsmith/issues/30223

#### 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
- [ ] Manual
- [ ] JUnit
- [ ] 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
- [ ] 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


<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->

## Summary by CodeRabbit

- **New Features**
- Custom widgets now support analytics events, enhancing visibility into
user interactions.
- Template selection, layout controls, and reference triggers in the
Custom Widget Builder are now integrated with analytics.
- Added new style options for custom widgets, including `primaryColor`,
`backgroundColor`, `borderRadius`, and `boxShadow`.

- **Bug Fixes**
  - Corrected a typo in the constant title for better clarity.
- Updated help text for the Container Widget to accurately describe the
widget's border edge.

- **Enhancements**
- Improved user interface with additional styling for reference names in
the Custom Widget Builder.
- Enhanced debugger functionality with `useCallback` optimization and
new analytics logging.

- **Refactor**
- Streamlined the property pane by introducing a new `LabelContainer`
styled component.
- Refined the handling of dynamic binding paths to ignore certain
properties efficiently.

- **Documentation**
- Added a new constant for the default model documentation URL in the
Custom Widget Builder.

<!-- end of auto-generated comment: release notes by coderabbit.ai -->
2024-01-16 10:52:17 +05:30

205 lines
5.3 KiB
TypeScript

import React from "react";
import type { ControlProps } from "./BaseControl";
import BaseControl from "./BaseControl";
import { Button, Input, Icon } from "design-system";
import type { WidgetProps } from "widgets/BaseWidget";
import styled from "styled-components";
import {
CUSTOM_WIDGET_FEATURE,
createMessage,
} from "@appsmith/constants/messages";
import AnalyticsUtil from "utils/AnalyticsUtil";
interface ButtonControlState {
showInput: boolean;
eventName: string;
pristine: boolean;
}
interface ButtonControlProps extends ControlProps {
onAdd: (widget: WidgetProps, name: string) => Record<string, unknown>;
}
const StyledErrorMessage = styled.div`
display: flex;
gap: 5px;
align-items: center;
`;
// TODO (sbalaji1192): Find a better place to maintain this variable
const RESTRICTED_NAMES = [
"onReset",
"ENTITY_TYPE",
"isVisible",
"widgetName",
"events",
"defaultModel",
"srcDoc",
"uncompiledSrcDoc",
"key",
"isCanvas",
"isSearchWildcard",
"widgetId",
"isLoading",
"parentColumnSpace",
"parentRowSpace",
"leftColumn",
"rightColumn",
"topRow",
"bottomRow",
"mobileLeftColumn",
"mobileRightColumn",
"mobileTopRow",
"mobileBottomRow",
"model",
"meta",
"componentHeight",
"componentWidth",
"type",
"__evaluation__",
];
class ButtonControl extends BaseControl<
ButtonControlProps,
ButtonControlState
> {
state = {
showInput: false,
eventName: "",
pristine: true,
};
reset = () => {
this.setState({ showInput: false, eventName: "", pristine: true });
};
onCancel = () => {
this.reset();
AnalyticsUtil.logEvent("CUSTOM_WIDGET_ADD_EVENT_CANCEL_CLICKED", {
widgetId: this.props.widgetProperties.widgetId,
});
};
onSave = () => {
const updates = this.props.onAdd(
this.props.widgetProperties,
this.state.eventName,
);
this.batchUpdateProperties(updates);
this.reset();
AnalyticsUtil.logEvent("CUSTOM_WIDGET_ADD_EVENT_SAVE_CLICKED", {
widgetId: this.props.widgetProperties.widgetId,
});
};
hasError = () => {
return (
!this.state.eventName.trim() ||
this.props.widgetProperties.hasOwnProperty(this.state.eventName.trim()) ||
this.props.widgetProperties.events.includes(
this.state.eventName.trim(),
) ||
RESTRICTED_NAMES.includes(this.state.eventName.trim())
);
};
getErrorMessages = () => {
let errorMessage = "";
if (this.state.pristine) {
return "";
} else if (
this.props.widgetProperties.hasOwnProperty(this.state.eventName.trim()) ||
this.props.widgetProperties.events.includes(this.state.eventName.trim())
) {
errorMessage = createMessage(
CUSTOM_WIDGET_FEATURE.addEvent.errors.duplicate,
);
} else if (RESTRICTED_NAMES.includes(this.state.eventName.trim())) {
errorMessage = createMessage(
CUSTOM_WIDGET_FEATURE.addEvent.errors.restricted,
);
}
return (
errorMessage && (
<StyledErrorMessage>
<Icon name="alert-line" size="sm" />
{errorMessage}
</StyledErrorMessage>
)
);
};
render() {
return (
<div className={`mt-1 ${this.state.showInput ? "" : "flex justify-end"}`}>
{this.state.showInput ? (
<div>
<div>
<Input
autoFocus
errorMessage={this.getErrorMessages()}
label={createMessage(CUSTOM_WIDGET_FEATURE.addEvent.nameLabel)}
onChange={(value: string) => {
this.setState({ eventName: value.split(/\W+/).join("_") });
}}
onKeyDown={(e: React.KeyboardEvent<HTMLInputElement>) => {
this.setState({ pristine: false });
if (e.key === "Enter" && !this.hasError()) {
this.onSave();
} else if (e.key === "Escape") {
this.onCancel();
}
}}
placeholder="Event Name"
size="md"
value={this.state.eventName}
/>
</div>
<div className="flex justify-end mt-4">
<div className="pr-2">
<Button kind="secondary" onClick={this.onCancel} size="sm">
{createMessage(CUSTOM_WIDGET_FEATURE.addEvent.cancelCTA)}
</Button>
</div>
<div className="pl-2">
<Button
isDisabled={this.hasError()}
kind="primary"
onClick={this.onSave}
size="sm"
>
{createMessage(CUSTOM_WIDGET_FEATURE.addEvent.addCTA)}
</Button>
</div>
</div>
</div>
) : (
<Button
kind="tertiary"
onClick={() => {
this.setState({ showInput: true });
AnalyticsUtil.logEvent("CUSTOM_WIDGET_ADD_EVENT_CLICKED", {
widgetId: this.props.widgetProperties.widgetId,
});
}}
size="sm"
startIcon="plus"
>
{createMessage(CUSTOM_WIDGET_FEATURE.addEvent.addEventCTA)}
</Button>
)}
</div>
);
}
static getControlType() {
return "CUSTOM_WIDGET_ADD_EVENT_BUTTON_CONTROL";
}
}
export default ButtonControl;