PromucFlow_constructor/app/client/src/components/propertyControls/KeyValueComponent.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

231 lines
5.9 KiB
TypeScript

import React, { useState, useEffect, useCallback } from "react";
import styled from "styled-components";
import { ControlWrapper, InputGroup } from "./StyledControls";
import type { SegmentedControlOption } from "design-system";
import { Button } from "design-system";
import { generateReactKey } from "utils/generators";
import { debounce } from "lodash";
import { getNextEntityName } from "utils/AppsmithUtils";
function updateOptionLabel<T>(
options: Array<T>,
index: number,
updatedLabel: string,
) {
return options.map((option: T, optionIndex) => {
if (index !== optionIndex) {
return option;
}
return {
...option,
label: updatedLabel,
};
});
}
function updateOptionValue<T>(
options: Array<T>,
index: number,
updatedValue: string,
) {
return options.map((option, optionIndex) => {
if (index !== optionIndex) {
return option;
}
return {
...option,
value: updatedValue,
};
});
}
const StyledBox = styled.div`
width: 10px;
`;
type UpdatePairFunction = (
pair: SegmentedControlOption[],
isUpdatedViaKeyboard?: boolean,
) => any;
type KeyValueComponentProps = {
pairs: SegmentedControlOption[];
updatePairs: UpdatePairFunction;
addLabel?: string;
};
type SegmentedControlOptionWithKey = SegmentedControlOption & {
key: string;
};
const StyledInputGroup = styled(InputGroup)`
> .ads-v2-input__input-section > div {
min-width: 0px;
}
`;
export function KeyValueComponent(props: KeyValueComponentProps) {
const [renderPairs, setRenderPairs] = useState<
SegmentedControlOptionWithKey[]
>([]);
const [typing, setTyping] = useState<boolean>(false);
const { pairs } = props;
useEffect(() => {
let { pairs } = props;
pairs = Array.isArray(pairs) ? pairs.slice() : [];
const newRenderPairs: SegmentedControlOptionWithKey[] = pairs.map(
(pair) => {
return {
...pair,
key: generateReactKey(),
};
},
);
pairs.length !== 0 && !typing && setRenderPairs(newRenderPairs);
}, [props, pairs.length, renderPairs.length]);
const debouncedUpdatePairs = useCallback(
debounce((updatedPairs: SegmentedControlOption[]) => {
props.updatePairs(updatedPairs, true);
}, 200),
[props.updatePairs],
);
function updateKey(index: number, updatedKey: string) {
let { pairs } = props;
pairs = Array.isArray(pairs) ? pairs : [];
const updatedPairs = updateOptionLabel(pairs, index, updatedKey);
const updatedRenderPairs = updateOptionLabel(
renderPairs,
index,
updatedKey,
);
setRenderPairs(updatedRenderPairs);
debouncedUpdatePairs(updatedPairs);
}
function updateValue(index: number, updatedValue: string) {
let { pairs } = props;
pairs = Array.isArray(pairs) ? pairs : [];
const updatedPairs = updateOptionValue(pairs, index, updatedValue);
const updatedRenderPairs = updateOptionValue(
renderPairs,
index,
updatedValue,
);
setRenderPairs(updatedRenderPairs);
debouncedUpdatePairs(updatedPairs);
}
function deletePair(index: number, isUpdatedViaKeyboard = false) {
let { pairs } = props;
pairs = Array.isArray(pairs) ? pairs : [];
const newPairs = pairs.filter((o, i) => i !== index);
const newRenderPairs = renderPairs.filter((o, i) => i !== index);
setRenderPairs(newRenderPairs);
props.updatePairs(newPairs, isUpdatedViaKeyboard);
}
function addPair(e: React.MouseEvent) {
let { pairs } = props;
pairs = Array.isArray(pairs) ? pairs.slice() : [];
pairs.push({
label: getNextEntityName(
"Option",
pairs.map((pair: any) => pair.label),
),
value: getNextEntityName(
"OPTION",
pairs.map((pair: any) => pair.value),
),
});
const updatedRenderPairs = renderPairs.slice();
updatedRenderPairs.push({
label: getNextEntityName(
"Option",
renderPairs.map((pair: any) => pair.label),
),
value: getNextEntityName(
"OPTION",
renderPairs.map((pair: any) => pair.value),
),
key: getNextEntityName(
"OPTION",
renderPairs.map((pair: any) => pair.value),
),
});
setRenderPairs(updatedRenderPairs);
props.updatePairs(pairs, e.detail === 0);
}
function onInputFocus() {
setTyping(true);
}
function onInputBlur() {
setTyping(false);
}
return (
<>
{renderPairs.map((pair: SegmentedControlOptionWithKey, index) => {
return (
<ControlWrapper key={pair.key} orientation={"HORIZONTAL"}>
<StyledInputGroup
dataType={"text"}
onBlur={onInputBlur}
onChange={(value: string) => {
updateKey(index, value);
}}
onFocus={onInputFocus}
placeholder={"Name"}
value={pair.label}
/>
<StyledBox />
<StyledInputGroup
dataType={"text"}
onBlur={onInputBlur}
onChange={(value: string) => {
updateValue(index, value);
}}
onFocus={onInputFocus}
placeholder={"Value"}
value={pair.value}
/>
<StyledBox />
<Button
isIconButton
kind="tertiary"
onClick={(e: React.MouseEvent) => {
deletePair(index, e.detail === 0);
}}
size="sm"
startIcon="delete-bin-line"
style={{ width: "50px" }}
/>
</ControlWrapper>
);
})}
<div className="flex flex-row-reverse mt-1">
<Button
className="t--property-control-options-add"
kind="tertiary"
onClick={addPair}
size="sm"
startIcon="plus"
>
{props.addLabel || "Add option"}
</Button>
</div>
</>
);
}