PromucFlow_constructor/app/client/src/utils/PropertyControlRegistry.tsx
balajisoundar 33f9411024
chore: [one click binding] allow switching between js mode and non js mode on property control (#24355)
## Description
Now, on table data property of Table widget, we can switch between js
mode and non js mode when there is a value.

#### PR fixes following issue(s)
Fixes https://github.com/appsmithorg/appsmith/issues/24354
#### 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
- [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
- [ ] PR is being merged under a feature flag


#### QA activity:
- [ ] [Speedbreak
features](https://github.com/appsmithorg/TestSmith/wiki/Test-plan-implementation#speedbreaker-features-to-consider-for-every-change)
have been covered
- [ ] Test plan covers all impacted features and [areas of
interest](https://github.com/appsmithorg/TestSmith/wiki/Guidelines-for-test-plans/_edit#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-06-16 14:46:56 +05:30

92 lines
2.7 KiB
TypeScript

import React from "react";
import PropertyControlFactory from "./PropertyControlFactory";
import type { PropertyControlPropsType } from "components/propertyControls";
import { PropertyControls } from "components/propertyControls";
import type { ControlProps } from "components/propertyControls/BaseControl";
import type BaseControl from "components/propertyControls/BaseControl";
import type { InteractionAnalyticsEventDetail } from "./AppsmithUtils";
import {
interactionAnalyticsEvent,
INTERACTION_ANALYTICS_EVENT,
} from "./AppsmithUtils";
function withAnalytics(WrappedControl: typeof BaseControl) {
return class AnalyticsHOC extends React.PureComponent<ControlProps> {
containerRef = React.createRef<any>();
constructor(props: ControlProps) {
super(props);
}
componentDidMount() {
this.containerRef.current?.addEventListener(
INTERACTION_ANALYTICS_EVENT,
this.handleKbdEvent,
);
}
componentWillUnmount() {
this.containerRef.current?.removeEventListener(
INTERACTION_ANALYTICS_EVENT,
this.handleKbdEvent,
);
}
handleKbdEvent = (e: Event) => {
const event = e as CustomEvent<InteractionAnalyticsEventDetail>;
if (!event.detail?.propertyName) {
e.stopPropagation();
this.containerRef.current?.dispatchEvent(
interactionAnalyticsEvent({
key: event.detail.key,
propertyType: AnalyticsHOC.getControlType(),
propertyName: this.props.propertyName,
widgetType: this.props.widgetProperties.type,
}),
);
}
};
static getControlType() {
return WrappedControl.getControlType();
}
render() {
return (
<div ref={this.containerRef}>
<WrappedControl {...this.props} />
</div>
);
}
};
}
class PropertyControlRegistry {
static registerPropertyControlBuilders() {
Object.values(PropertyControls).forEach(
(Control: typeof BaseControl & { getControlType: () => string }) => {
const ControlWithAnalytics = withAnalytics(Control);
const controlType = ControlWithAnalytics.getControlType();
PropertyControlFactory.registerControlBuilder(
controlType,
{
buildPropertyControl(
controlProps: PropertyControlPropsType,
): JSX.Element {
return <ControlWithAnalytics {...controlProps} />;
},
},
{
canDisplayValueInUI: Control.canDisplayValueInUI,
shouldValidateValueOnDynamicPropertyOff:
Control.shouldValidateValueOnDynamicPropertyOff,
},
Control.getInputComputedValue,
);
},
);
}
}
export default PropertyControlRegistry;