## Description This PR's adds the custom widget. #### PR fixes following issue(s) Fixes #28607 Fixes #28610 Fixes #28615 Fixes #28608 Fixes #28612 > 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 - New feature (non-breaking change which adds functionality) > > > ## 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 - [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 - [x] 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** - Introduced search functionality with a wildcard option for unmatched widget searches. - Added new routes for custom widget editing. - Implemented additional editor modes for HTML and CSS. - Created new code templates and help components for custom widget builders. - Enhanced property controls with new button controls for custom widget editing. - Updated theming interfaces and constants for better theming support. - Added the CustomWidget component for embedding custom widgets in iframes. - Expanded widgets library to include the CustomWidget. - **Enhancements** - Improved `CodeEditor` with additional modes, props, and resize behavior. - Enhanced `PropertyPaneControlConfig` interface with dynamic dependencies and additional properties. - Refined custom widget scripts with communication channel and event handling. - **Bug Fixes** - Fixed visibility logic for the `ExternalWidget` card. - **Documentation** - Added new messages and documentation links for custom widget features. - **Tests** - Implemented new Cypress tests for custom widget default components and property pane interactions. - Updated workspace commands in Cypress tests. - **Refactor** - Streamlined `PropertyControl` state management and editing functions. - Refactored code editor hint helper logic. - **Style** - Added `borderLess` prop to style components without borders. - **Chores** - Updated constants and messages related to custom widget features. - Adjusted webpack configuration to ignore specific module warnings. <!-- end of auto-generated comment: release notes by coderabbit.ai -->
192 lines
4.8 KiB
TypeScript
192 lines
4.8 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";
|
|
|
|
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();
|
|
};
|
|
|
|
onSave = () => {
|
|
const updates = this.props.onAdd(
|
|
this.props.widgetProperties,
|
|
this.state.eventName,
|
|
);
|
|
this.batchUpdateProperties(updates);
|
|
this.reset();
|
|
};
|
|
|
|
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 })}
|
|
size="sm"
|
|
startIcon="plus"
|
|
>
|
|
{createMessage(CUSTOM_WIDGET_FEATURE.addEvent.addEventCTA)}
|
|
</Button>
|
|
)}
|
|
</div>
|
|
);
|
|
}
|
|
|
|
static getControlType() {
|
|
return "CUSTOM_WIDGET_ADD_EVENT_BUTTON_CONTROL";
|
|
}
|
|
}
|
|
|
|
export default ButtonControl;
|