PromucFlow_constructor/app/client/src/components/propertyControls/DropDownControl.tsx
albinAppsmith 629999f124
feat: [epic] appsmith design system version 2 deduplication (#22030)
## Description

### Fixes
- [x] https://github.com/appsmithorg/appsmith/issues/19383
- [x] https://github.com/appsmithorg/appsmith/issues/19384
- [x] https://github.com/appsmithorg/appsmith/issues/19385
- [x] https://github.com/appsmithorg/appsmith/issues/19386
- [x] https://github.com/appsmithorg/appsmith/issues/19387
- [x] https://github.com/appsmithorg/appsmith/issues/19388
- [x] https://github.com/appsmithorg/appsmith/issues/19389
- [x] https://github.com/appsmithorg/appsmith/issues/19390
- [x] https://github.com/appsmithorg/appsmith/issues/19391
- [x] https://github.com/appsmithorg/appsmith/issues/19392
- [x] https://github.com/appsmithorg/appsmith/issues/19393
- [x] https://github.com/appsmithorg/appsmith/issues/19394
- [x] https://github.com/appsmithorg/appsmith/issues/19395
- [x] https://github.com/appsmithorg/appsmith/issues/19396
- [x] https://github.com/appsmithorg/appsmith/issues/19397
- [x] https://github.com/appsmithorg/appsmith/issues/19398
- [x] https://github.com/appsmithorg/appsmith/issues/19399
- [x] https://github.com/appsmithorg/appsmith/issues/19400
- [x] https://github.com/appsmithorg/appsmith/issues/19401
- [x] https://github.com/appsmithorg/appsmith/issues/19402
- [x] https://github.com/appsmithorg/appsmith/issues/19403
- [x] https://github.com/appsmithorg/appsmith/issues/19404
- [x] https://github.com/appsmithorg/appsmith/issues/19405
- [x] https://github.com/appsmithorg/appsmith/issues/19406
- [x] https://github.com/appsmithorg/appsmith/issues/19407
- [x] https://github.com/appsmithorg/appsmith/issues/19408
- [x] https://github.com/appsmithorg/appsmith/issues/19409

Fixes # (issue)
> 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


## How Has This Been Tested?
> Please describe the tests that you ran to verify your changes. Provide
instructions, so we can reproduce.
> Please also list any relevant details for your test configuration.
> Delete anything that is not important

- 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:
- [ ] Test plan has been approved by relevant developers
- [ ] Test plan has been peer reviewed by QA
- [ ] Cypress test cases have been added and approved by either SDET or
manual QA
- [ ] Organized project review call with relevant stakeholders after
Round 1/2 of QA
- [ ] Added Test Plan Approved label after reveiwing all Cypress test

---------

Co-authored-by: Ankita Kinger <ankita@appsmith.com>
Co-authored-by: akash-codemonk <67054171+akash-codemonk@users.noreply.github.com>
Co-authored-by: Tanvi Bhakta <tanvi@appsmith.com>
Co-authored-by: Arsalan <arsalanyaldram0211@outlook.com>
Co-authored-by: Aman Agarwal <aman@appsmith.com>
Co-authored-by: Rohit Agarwal <rohit_agarwal@live.in>
Co-authored-by: Nilesh Sarupriya <nilesh@appsmith.com>
Co-authored-by: Nilesh Sarupriya <20905988+nsarupr@users.noreply.github.com>
Co-authored-by: Tanvi Bhakta <tanvibhakta@gmail.com>
Co-authored-by: Aishwarya UR <aishwarya@appsmith.com>
Co-authored-by: Parthvi Goswami <parthvigoswami@Parthvis-MacBook-Pro.local>
Co-authored-by: Vijetha-Kaja <vijetha@appsmith.com>
Co-authored-by: Parthvi <80334441+Parthvi12@users.noreply.github.com>
Co-authored-by: Apple <nandan@thinkify.io>
Co-authored-by: Saroj <43822041+sarojsarab@users.noreply.github.com>
Co-authored-by: Sangeeth Sivan <74818788+berzerkeer@users.noreply.github.com>
Co-authored-by: Ashok Kumar M <35134347+marks0351@users.noreply.github.com>
Co-authored-by: Aishwarya-U-R <91450662+Aishwarya-U-R@users.noreply.github.com>
Co-authored-by: rahulramesha <rahul@appsmith.com>
Co-authored-by: Aswath K <aswath.sana@gmail.com>
Co-authored-by: Preet Sidhu <preetsidhu.bits@gmail.com>
Co-authored-by: Vijetha-Kaja <119562824+Vijetha-Kaja@users.noreply.github.com>
Co-authored-by: Shrikant Sharat Kandula <shrikant@appsmith.com>
2023-05-20 00:07:06 +05:30

253 lines
7.6 KiB
TypeScript

import React from "react";
import styled from "styled-components";
import { Option, Select, Text, Icon } from "design-system";
import type { ControlProps } from "./BaseControl";
import BaseControl from "./BaseControl";
import { isNil } from "lodash";
import { isDynamicValue } from "utils/DynamicBindingUtils";
import type { DSEventDetail } from "utils/AppsmithUtils";
import { DSEventTypes, DS_EVENT } from "utils/AppsmithUtils";
import { emitInteractionAnalyticsEvent } from "utils/AppsmithUtils";
const FlagWrapper = styled.span`
font-family: "Twemoji Country Flags";
font-size: 20px;
line-height: 19px;
margin-right: 10px;
height: 100%;
position: relative;
top: 1px;
overflow: initial !important;
`;
class DropDownControl extends BaseControl<DropDownControlProps> {
containerRef = React.createRef<HTMLDivElement>();
componentDidMount() {
this.containerRef.current?.addEventListener(
DS_EVENT,
this.handleAdsEvent as (arg0: Event) => void,
);
}
componentWillUnmount() {
this.containerRef.current?.removeEventListener(
DS_EVENT,
this.handleAdsEvent as (arg0: Event) => void,
);
}
handleAdsEvent = (e: CustomEvent<DSEventDetail>) => {
if (
e.detail.component === "Dropdown" &&
e.detail.event === DSEventTypes.KEYPRESS
) {
emitInteractionAnalyticsEvent(this.containerRef.current, {
key: e.detail.meta.key,
});
e.stopPropagation();
}
};
render() {
let defaultSelected: string | string[] | undefined = undefined;
if (this.props.isMultiSelect) {
defaultSelected = [];
}
const options =
typeof this.props.options === "function"
? this.props.options(this.props.widgetProperties)
: this.props?.options || [];
if (this.props.defaultValue) {
if (this.props.isMultiSelect) {
const defaultValueSet = new Set(this.props.defaultValue);
defaultSelected = options
.filter((option) => defaultValueSet.has(option.value))
.map((option) => option.value);
} else {
defaultSelected = options.find(
(option) => option.value === this.props.defaultValue,
)?.value;
}
}
let selected: string | string[];
if (this.props.isMultiSelect) {
const propertyValueSet = new Set(this.props.propertyValue);
selected = options
.filter((option) => propertyValueSet.has(option.value))
.map((option) => option.value);
} else {
const computedValue =
!isNil(this.props.propertyValue) &&
isDynamicValue(this.props.propertyValue) &&
// "dropdownUsePropertyValue" comes from the property config. This is set to true when
// the actual propertyValue (not the evaluated) is to be used for finding the option from "options".
!this.props.dropdownUsePropertyValue
? this.props.evaluatedValue
: this.props.propertyValue;
selected = options.find(
(option) => option.value === computedValue,
)?.value;
}
return (
<div className="w-full h-full" ref={this.containerRef}>
<Select
defaultValue={defaultSelected}
isMultiSelect={this.props.isMultiSelect}
onDeselect={this.onDeselect}
onSelect={this.onSelect}
optionFilterProp="label"
optionLabelProp={this.props.hideSubText ? "label" : "children"}
placeholder={this.props.placeholderText}
showSearch={this.props.enableSearch}
value={selected}
virtual={this.props.virtual || false}
>
{options.map((option, index) => (
<Option
className="t--dropdown-option"
key={index}
label={option.label}
value={option.value}
>
{/* Show Flag if present */}
{option.leftElement && (
<FlagWrapper>{option.leftElement}</FlagWrapper>
)}
{/* Show icon if present */}
{option.icon && (
<Icon className="mr-1" name={option.icon} size="md" />
)}
{option.subText ? (
this.props.hideSubText ? (
// Show subText below the main text eg - DatePicker control
<div className="w-full flex flex-col">
<Text kind="action-m">{option.label}</Text>
<Text kind="action-s">{option.subText}</Text>
</div>
) : (
// Show subText to the right side eg - Label fontsize control
<div className="w-full flex justify-between items-end">
<Text kind="action-m">{option.label}</Text>
<Text kind="action-s">{option.subText}</Text>
</div>
)
) : (
// Only show the label eg - Auto height control
<Text kind="action-m">{option.label}</Text>
)}
</Option>
))}
</Select>
</div>
);
}
onSelect = (value?: string): void => {
if (!isNil(value)) {
let selectedValue: string | string[] = this.props.propertyValue;
if (this.props.isMultiSelect) {
if (Array.isArray(selectedValue)) {
const index = selectedValue.indexOf(value);
if (index >= 0) {
selectedValue = [
...selectedValue.slice(0, index),
...selectedValue.slice(index + 1),
];
} else {
selectedValue = [...selectedValue, value];
}
} else {
selectedValue = [selectedValue, value];
}
} else {
selectedValue = value;
}
this.updateProperty(this.props.propertyName, selectedValue);
}
};
onDeselect = (value?: string) => {
if (!isNil(value)) {
let selectedValue: string | string[] = this.props.propertyValue;
if (this.props.isMultiSelect) {
if (Array.isArray(selectedValue)) {
const index = selectedValue.indexOf(value);
if (index >= 0) {
selectedValue = [
...selectedValue.slice(0, index),
...selectedValue.slice(index + 1),
];
}
} else {
selectedValue = [];
}
} else {
selectedValue = "";
}
this.updateProperty(this.props.propertyName, selectedValue);
}
};
isOptionSelected = (selectedOption: any) => {
return selectedOption.value === this.props.propertyValue;
};
static getControlType() {
return "DROP_DOWN";
}
static canDisplayValueInUI(
config: DropDownControlProps,
value: any,
): boolean {
const options =
typeof config?.options === "function"
? config?.options(config.widgetProperties)
: config?.options || [];
const allowedValues = new Set(
options?.map((x: { value: string | number }) => x.value.toString()),
);
if (config.isMultiSelect) {
try {
const values = JSON.parse(value);
for (const x of values) {
if (!allowedValues.has(x.toString())) return false;
}
} catch {
return false;
}
return true;
} else {
return allowedValues.has(value);
}
}
}
export interface DropDownControlProps extends ControlProps {
options?: any[] | ((props: ControlProps["widgetProperties"]) => any[]);
defaultValue?: string;
virtual?: boolean;
placeholderText: string;
searchPlaceholderText: string;
isMultiSelect?: boolean;
dropdownHeight?: string;
enableSearch?: boolean;
propertyValue: string;
optionWidth?: string;
hideSubText?: boolean;
dropdownUsePropertyValue?: boolean;
}
export default DropDownControl;