PromucFlow_constructor/app/client/src/components/editorComponents/EditableText.tsx
Vaibhav Chobisa 62a4587095
fix: Renaming new JS Object not working instantly (#30010)
## Description
This PR fixes the issue of the error tooltip appearing every time on
saving a new 'JS Object name' even though it is neither a restricted
keyword nor already in use.

#### PR fixes following issue(s)
Fixes #29482 

#### Type of change
- Bug fix (non-breaking change which fixes an issue)

## Testing
#### How Has This Been Tested?
- [x] Manual
- [ ] Jest
- [ ] Cypress

#### 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
- [ ] 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/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**
- Enhanced error handling in text editing with user-friendly error
messages.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->
2024-01-09 09:54:02 +05:30

284 lines
7.1 KiB
TypeScript

import React, { useState, useEffect, useRef, useCallback } from "react";
import { useLocation } from "react-router";
import {
EditableText as BlueprintEditableText,
Classes,
} from "@blueprintjs/core";
import styled from "styled-components";
import _ from "lodash";
import { Button, toast, Tooltip } from "design-system";
export enum EditInteractionKind {
SINGLE,
DOUBLE,
}
interface EditableTextProps {
type: "text" | "password" | "email" | "phone" | "date";
defaultValue: string;
onTextChanged: (value: string) => void;
placeholder: string;
className?: string;
valueTransform?: (value: string) => string;
isEditingDefault?: boolean;
forceDefault?: boolean;
updating?: boolean;
isInvalid?: (value: string) => string | boolean;
editInteractionKind: EditInteractionKind;
hideEditIcon?: boolean;
minimal?: boolean;
onBlur?: (value?: string) => void;
beforeUnmount?: (value?: string) => void;
errorTooltipClass?: string;
maxLength?: number;
underline?: boolean;
disabled?: boolean;
multiline?: boolean;
maxLines?: number;
minLines?: number;
customErrorTooltip?: string;
useFullWidth?: boolean;
}
// using the !important keyword here is mandatory because a style is being applied to that element using the style attribute
// which has higher specificity than other css selectors. It seems the overriding style is being applied by the package itself.
const EditableTextWrapper = styled.div<{
isEditing: boolean;
minimal: boolean;
useFullWidth: boolean;
}>`
&& {
display: flex;
flex-direction: column;
justify-content: flex-start;
align-items: flex-start;
width: 100%;
& .${Classes.EDITABLE_TEXT} {
background: ${(props) =>
props.isEditing && !props.minimal
? "var(--ads-v2-color-bg-subtle)"
: "none"};
cursor: pointer;
padding: ${(props) => (!props.minimal ? "5px 5px" : "0px")};
border-radius: var(--ads-v2-border-radius);
text-transform: none;
max-width: 100%;
overflow: hidden;
display: flex;
&:before,
&:after {
display: none;
}
}
& div.${Classes.EDITABLE_TEXT_INPUT} {
text-transform: none;
width: 100%;
}
}
${({ useFullWidth }) =>
useFullWidth &&
`
> div {
width: 100%;
}
`}
`;
const TextContainer = styled.div<{
isValid: boolean;
minimal: boolean;
underline?: boolean;
}>`
color: var(--ads-v2-color-fg-emphasis-plus);
display: flex;
align-items: center;
&&&& .${Classes.EDITABLE_TEXT} {
& .${Classes.EDITABLE_TEXT_CONTENT} {
&:hover {
text-decoration: ${(props) => (props.minimal ? "underline" : "none")};
text-decoration-color: var(--ads-v2-color-border);
}
}
}
&&& .${Classes.EDITABLE_TEXT_CONTENT}:hover {
${(props) =>
props.underline
? `
border-bottom-style: solid;
border-bottom-width: 1px;
border-bottom-color: var(--ads-v2-color-border);
width: fit-content;
`
: null}
}
&& .t--action-name-edit-icon {
min-width: min-content;
}
`;
export function EditableText(props: EditableTextProps) {
const {
beforeUnmount,
className,
customErrorTooltip = "",
defaultValue,
disabled,
editInteractionKind,
errorTooltipClass,
forceDefault,
hideEditIcon,
isEditingDefault,
isInvalid,
maxLength,
maxLines,
minimal,
minLines,
multiline,
onBlur,
onTextChanged,
placeholder,
underline,
updating,
useFullWidth,
valueTransform,
} = props;
const [isEditing, setIsEditing] = useState(!!isEditingDefault);
const [value, setStateValue] = useState(defaultValue);
const [errorMessage, setErrorMessage] = useState<string | boolean>("");
const [error, setError] = useState<boolean>(false);
const inputValRef = useRef("");
const location = useLocation();
const setValue = useCallback((value) => {
inputValRef.current = value;
setStateValue(value);
}, []);
useEffect(() => {
setValue(defaultValue);
}, [defaultValue]);
useEffect(() => {
setIsEditing(!!isEditingDefault);
}, [defaultValue, isEditingDefault]);
useEffect(() => {
if (forceDefault === true) setValue(defaultValue);
}, [forceDefault, defaultValue]);
// at times onTextChange is not fired
// for example when the modal is closed on clicking the overlay
useEffect(() => {
return () => {
if (typeof beforeUnmount === "function")
beforeUnmount(inputValRef.current);
};
}, [beforeUnmount]);
// this removes the error tooltip when a user click on another
// JS object while the previous one has the name error tooltip
useEffect(() => {
setError(false);
}, [location.pathname]);
const edit = (e: any) => {
setIsEditing(true);
e.preventDefault();
e.stopPropagation();
};
const onChange = useCallback(
(_value: string) => {
onBlur && onBlur();
const _isInvalid = isInvalid ? isInvalid(_value) : false;
if (!_isInvalid) {
onTextChanged(_value);
setIsEditing(false);
} else {
toast.show(customErrorTooltip || "Invalid name", {
kind: "error",
});
}
},
[isInvalid, onTextChanged],
);
const onInputchange = useCallback(
(_value: string) => {
let finalVal: string = _value;
if (valueTransform) {
finalVal = valueTransform(_value);
}
setValue(finalVal);
const errorMessage = isInvalid && isInvalid(finalVal);
if (errorMessage) {
setError(true);
setErrorMessage(errorMessage);
} else {
setError(false);
}
},
[valueTransform, isInvalid],
);
const showEditIcon = !(
disabled ||
minimal ||
hideEditIcon ||
updating ||
isEditing
);
return (
<EditableTextWrapper
isEditing={isEditing}
minimal={!!minimal}
onClick={
editInteractionKind === EditInteractionKind.SINGLE ? edit : _.noop
}
onDoubleClick={
editInteractionKind === EditInteractionKind.DOUBLE ? edit : _.noop
}
useFullWidth={!!(useFullWidth && isEditing)}
>
<Tooltip
className={errorTooltipClass}
content={errorMessage as string}
visible={!!error}
>
<TextContainer
isValid={!error}
minimal={!!minimal}
underline={underline}
>
<BlueprintEditableText
className={className}
disabled={disabled || !isEditing}
isEditing={isEditing}
maxLength={maxLength}
maxLines={maxLines}
minLines={minLines}
multiline={multiline}
onCancel={onBlur}
onChange={onInputchange}
onConfirm={onChange}
placeholder={placeholder}
selectAllOnFocus
value={value}
/>
{showEditIcon && (
<Button
className="t--action-name-edit-icon"
isIconButton
kind="tertiary"
size="md"
startIcon="pencil-line"
/>
)}
</TextContainer>
</Tooltip>
</EditableTextWrapper>
);
}
export default EditableText;