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

70 lines
1.6 KiB
TypeScript
Raw Normal View History

chore: Custom widget (alpha) (#27571) The alpha version of the Custom widget that takes a user component and renders it on the app. Fixes https://github.com/appsmithorg/appsmith/issues/28601 #### 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 - [ ] 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 - [ ] 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 - [ ] 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 `release_custom_widgets_enabled` #### 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
2023-11-14 04:33:37 +00:00
import React from "react";
import { Button } from "design-system";
import type { ControlProps } from "./BaseControl";
import BaseControl from "./BaseControl";
export type HTMLDocumentBuidlerControlProps = ControlProps & {
propertyList: string;
generateProperty: (property: string) => ControlProps;
srcDoc: {
html: string;
css: string;
js: string;
};
};
class HTMLDocumentBuilderControl extends BaseControl<
HTMLDocumentBuidlerControlProps,
{
widgetBuilder: any;
}
> {
state = {
widgetBuilder: null,
};
onConfigure = () => {
const widgetBuilder = window.open(
window.origin + "/widgets/builder",
"_blank",
);
this.setState({ widgetBuilder });
const props = this.props;
widgetBuilder?.addEventListener("message", (event: any) => {
if (event.data.type === "BUILDER_READY") {
widgetBuilder.postMessage({
type: "BUILDER_READY_ACK",
srcDoc: props.widgetProperties.srcDoc,
model:
props.widgetProperties.__evaluation__.evaluatedValues.defaultModel,
});
} else if (event.data.type === "BUILDER_UPDATE") {
props.onPropertyChange?.(props.propertyName, event.data.srcDoc);
}
});
};
render() {
return (
<Button
kind="secondary"
// eslint-disable-next-line @typescript-eslint/ban-ts-comment
// @ts-ignore
onClick={() => this.onConfigure()}
size="sm"
>
configure
</Button>
);
}
static getControlType() {
return "HTML_DOCUMENT_BUILDER";
}
}
export default HTMLDocumentBuilderControl;