Text area using variables (#8034)

- Adding multiline props to component
- Update design and logic accordingly 
- Fix hotkey scope for right drawer



https://github.com/user-attachments/assets/65ff9641-71a4-4828-a62b-e09327b63150
This commit is contained in:
Thomas Trompette
2024-10-25 14:55:56 +02:00
committed by GitHub
parent 0144553667
commit 2e73d020a3
11 changed files with 272 additions and 95 deletions

View File

@ -1,5 +1,7 @@
import { useRightDrawer } from '@/ui/layout/right-drawer/hooks/useRightDrawer';
import { RightDrawerHotkeyScope } from '@/ui/layout/right-drawer/types/RightDrawerHotkeyScope';
import { RightDrawerPages } from '@/ui/layout/right-drawer/types/RightDrawerPages';
import { useSetHotkeyScope } from '@/ui/utilities/hotkey/hooks/useSetHotkeyScope';
import { CREATE_STEP_STEP_ID } from '@/workflow/constants/CreateStepStepId';
import { EMPTY_TRIGGER_STEP_ID } from '@/workflow/constants/EmptyTriggerStepId';
import { useStartNodeCreation } from '@/workflow/hooks/useStartNodeCreation';
@ -15,6 +17,8 @@ export const WorkflowDiagramCanvasEditableEffect = () => {
const { startNodeCreation } = useStartNodeCreation();
const { openRightDrawer, closeRightDrawer } = useRightDrawer();
const setHotkeyScope = useSetHotkeyScope();
const setWorkflowSelectedNode = useSetRecoilState(workflowSelectedNodeState);
const handleSelectionChange = useCallback(
@ -47,9 +51,11 @@ export const WorkflowDiagramCanvasEditableEffect = () => {
}
setWorkflowSelectedNode(selectedNode.id);
setHotkeyScope(RightDrawerHotkeyScope.RightDrawer, { goto: false });
openRightDrawer(RightDrawerPages.WorkflowStepEdit);
},
[
setHotkeyScope,
closeRightDrawer,
openRightDrawer,
setWorkflowSelectedNode,

View File

@ -1,5 +1,7 @@
import { useRightDrawer } from '@/ui/layout/right-drawer/hooks/useRightDrawer';
import { RightDrawerHotkeyScope } from '@/ui/layout/right-drawer/types/RightDrawerHotkeyScope';
import { RightDrawerPages } from '@/ui/layout/right-drawer/types/RightDrawerPages';
import { useSetHotkeyScope } from '@/ui/utilities/hotkey/hooks/useSetHotkeyScope';
import { useTriggerNodeSelection } from '@/workflow/hooks/useTriggerNodeSelection';
import { workflowSelectedNodeState } from '@/workflow/states/workflowSelectedNodeState';
import { WorkflowDiagramNode } from '@/workflow/types/WorkflowDiagram';
@ -11,6 +13,7 @@ import { isDefined } from 'twenty-ui';
export const WorkflowDiagramCanvasReadonlyEffect = () => {
const { openRightDrawer, closeRightDrawer } = useRightDrawer();
const setWorkflowSelectedNode = useSetRecoilState(workflowSelectedNodeState);
const setHotkeyScope = useSetHotkeyScope();
const handleSelectionChange = useCallback(
({ nodes }: OnSelectionChangeParams) => {
@ -24,9 +27,15 @@ export const WorkflowDiagramCanvasReadonlyEffect = () => {
}
setWorkflowSelectedNode(selectedNode.id);
setHotkeyScope(RightDrawerHotkeyScope.RightDrawer, { goto: false });
openRightDrawer(RightDrawerPages.WorkflowStepView);
},
[closeRightDrawer, openRightDrawer, setWorkflowSelectedNode],
[
closeRightDrawer,
openRightDrawer,
setWorkflowSelectedNode,
setHotkeyScope,
],
);
useOnSelectionChange({

View File

@ -4,9 +4,8 @@ import { currentWorkspaceMemberState } from '@/auth/states/currentWorkspaceMembe
import { useFindManyRecords } from '@/object-record/hooks/useFindManyRecords';
import { useTriggerGoogleApisOAuth } from '@/settings/accounts/hooks/useTriggerGoogleApisOAuth';
import { Select, SelectOption } from '@/ui/input/components/Select';
import { TextArea } from '@/ui/input/components/TextArea';
import { WorkflowEditGenericFormBase } from '@/workflow/components/WorkflowEditGenericFormBase';
import VariableTagInput from '@/workflow/search-variables/components/VariableTagInput';
import { VariableTagInput } from '@/workflow/search-variables/components/VariableTagInput';
import { workflowIdState } from '@/workflow/states/workflowIdState';
import { WorkflowSendEmailStep } from '@/workflow/types/Workflow';
import { useTheme } from '@emotion/react';
@ -227,20 +226,20 @@ export const WorkflowEditActionFormSendEmail = (
/>
)}
/>
<Controller
name="body"
control={form.control}
render={({ field }) => (
<TextArea
<VariableTagInput
inputId="email-body-input"
label="Body"
placeholder="Enter email body (use {{variable}} for dynamic content)"
value={field.value}
minRows={4}
onChange={(email) => {
field.onChange(email);
handleSave();
}}
multiline
/>
)}
/>

View File

@ -1,5 +1,7 @@
import { useRightDrawer } from '@/ui/layout/right-drawer/hooks/useRightDrawer';
import { RightDrawerHotkeyScope } from '@/ui/layout/right-drawer/types/RightDrawerHotkeyScope';
import { RightDrawerPages } from '@/ui/layout/right-drawer/types/RightDrawerPages';
import { useSetHotkeyScope } from '@/ui/utilities/hotkey/hooks/useSetHotkeyScope';
import { workflowCreateStepFromParentStepIdState } from '@/workflow/states/workflowCreateStepFromParentStepIdState';
import { useCallback } from 'react';
import { useSetRecoilState } from 'recoil';
@ -9,6 +11,7 @@ export const useStartNodeCreation = () => {
const setWorkflowCreateStepFromParentStepId = useSetRecoilState(
workflowCreateStepFromParentStepIdState,
);
const setHotkeyScope = useSetHotkeyScope();
/**
* This function is used in a context where dependencies shouldn't change much.
@ -18,9 +21,10 @@ export const useStartNodeCreation = () => {
(parentNodeId: string) => {
setWorkflowCreateStepFromParentStepId(parentNodeId);
setHotkeyScope(RightDrawerHotkeyScope.RightDrawer, { goto: false });
openRightDrawer(RightDrawerPages.WorkflowStepSelectAction);
},
[openRightDrawer, setWorkflowCreateStepFromParentStepId],
[openRightDrawer, setWorkflowCreateStepFromParentStepId, setHotkeyScope],
);
return {

View File

@ -4,6 +4,7 @@ import { parseEditorContent } from '@/workflow/search-variables/utils/parseEdito
import { VariableTag } from '@/workflow/search-variables/utils/variableTag';
import styled from '@emotion/styled';
import Document from '@tiptap/extension-document';
import HardBreak from '@tiptap/extension-hard-break';
import Paragraph from '@tiptap/extension-paragraph';
import Placeholder from '@tiptap/extension-placeholder';
import Text from '@tiptap/extension-text';
@ -11,6 +12,8 @@ import { EditorContent, useEditor } from '@tiptap/react';
import { isDefined } from 'twenty-ui';
import { useDebouncedCallback } from 'use-debounce';
const LINE_HEIGHT = 24;
const StyledContainer = styled.div`
display: inline-flex;
flex-direction: column;
@ -23,12 +26,18 @@ const StyledLabel = styled.div`
margin-bottom: ${({ theme }) => theme.spacing(1)};
`;
const StyledInputContainer = styled.div`
const StyledInputContainer = styled.div<{ multiline: boolean }>`
display: flex;
flex-direction: row;
position: relative;
line-height: ${({ multiline }) => (multiline ? `${LINE_HEIGHT}px` : 'auto')};
min-height: ${({ multiline }) =>
multiline ? `${3 * LINE_HEIGHT}px` : 'auto'};
max-height: ${({ multiline }) =>
multiline ? `${5 * LINE_HEIGHT}px` : 'auto'};
`;
const StyledSearchVariablesDropdownContainer = styled.div`
const StyledSearchVariablesDropdownOutsideContainer = styled.div`
display: flex;
justify-content: center;
align-items: center;
@ -38,18 +47,33 @@ const StyledSearchVariablesDropdownContainer = styled.div`
border: 1px solid ${({ theme }) => theme.border.color.medium};
`;
const StyledEditor = styled.div`
const StyledSearchVariablesDropdownInsideContainer = styled.div`
display: flex;
justify-content: center;
align-items: center;
position: absolute;
top: ${({ theme }) => theme.spacing(0.5)};
right: ${({ theme }) => theme.spacing(0.5)};
`;
const StyledEditor = styled.div<{ multiline: boolean }>`
display: flex;
height: 32px;
width: 100%;
border: 1px solid ${({ theme }) => theme.border.color.medium};
border-bottom-left-radius: ${({ theme }) => theme.border.radius.sm};
border-top-left-radius: ${({ theme }) => theme.border.radius.sm};
border-right: none;
box-sizing: border-box;
background-color: ${({ theme }) => theme.background.transparent.lighter};
overflow: hidden;
padding: ${({ theme }) => theme.spacing(2)};
padding: ${({ theme }) => `${theme.spacing(1)} ${theme.spacing(2)}`};
border-bottom-right-radius: ${({ multiline, theme }) =>
multiline ? theme.border.radius.sm : 'none'};
border-top-right-radius: ${({ multiline, theme }) =>
multiline ? theme.border.radius.sm : 'none'};
border-right: ${({ multiline }) => (multiline ? 'auto' : 'none')};
padding-right: ${({ multiline, theme }) =>
multiline ? theme.spacing(6) : theme.spacing(2)};
overflow: ${({ multiline }) => (multiline ? 'auto' : 'hidden')};
height: ${({ multiline }) => (multiline ? 'auto' : `${1.5 * LINE_HEIGHT}px`)};
.editor-content {
width: 100%;
@ -57,13 +81,14 @@ const StyledEditor = styled.div`
.tiptap {
display: flex;
align-items: center;
height: 100%;
color: ${({ theme }) => theme.font.color.primary};
font-family: ${({ theme }) => theme.font.family};
font-weight: ${({ theme }) => theme.font.weight.regular};
border: none !important;
white-space: nowrap;
align-items: ${({ multiline }) => (multiline ? 'top' : 'center')};
white-space: ${({ multiline }) => (multiline ? 'pre-wrap' : 'nowrap')};
word-wrap: ${({ multiline }) => (multiline ? 'break-word' : 'normal')};
p.is-editor-empty:first-of-type::before {
content: attr(data-placeholder);
@ -94,8 +119,9 @@ interface VariableTagInputProps {
inputId: string;
label?: string;
value?: string;
onChange?: (content: string) => void;
placeholder?: string;
multiline?: boolean;
onChange?: (content: string) => void;
}
export const VariableTagInput = ({
@ -103,8 +129,13 @@ export const VariableTagInput = ({
label,
value,
placeholder,
multiline,
onChange,
}: VariableTagInputProps) => {
const StyledSearchVariablesDropdownContainer = multiline
? StyledSearchVariablesDropdownInsideContainer
: StyledSearchVariablesDropdownOutsideContainer;
const deboucedOnUpdate = useDebouncedCallback((editor) => {
const jsonContent = editor.getJSON();
const parsedContent = parseEditorContent(jsonContent);
@ -120,6 +151,13 @@ export const VariableTagInput = ({
placeholder,
}),
VariableTag,
...(multiline
? [
HardBreak.configure({
keepMarks: false,
}),
]
: []),
],
editable: true,
onCreate: ({ editor }) => {
@ -130,6 +168,29 @@ export const VariableTagInput = ({
onUpdate: ({ editor }) => {
deboucedOnUpdate(editor);
},
editorProps: {
handleKeyDown: (view, event) => {
if (event.key === 'Enter' && !event.shiftKey) {
event.preventDefault();
const { state } = view;
const { tr } = state;
// Insert hard break using the view's state and dispatch
const transaction = tr.replaceSelectionWith(
state.schema.nodes.hardBreak.create(),
);
view.dispatch(transaction);
return true;
}
return false;
},
},
enableInputRules: false,
enablePasteRules: false,
injectCSS: false,
});
if (!editor) {
@ -139,8 +200,8 @@ export const VariableTagInput = ({
return (
<StyledContainer>
{label && <StyledLabel>{label}</StyledLabel>}
<StyledInputContainer>
<StyledEditor>
<StyledInputContainer multiline={!!multiline}>
<StyledEditor multiline={!!multiline}>
<EditorContent className="editor-content" editor={editor} />
</StyledEditor>
<StyledSearchVariablesDropdownContainer>

View File

@ -2,22 +2,17 @@ import { Editor } from '@tiptap/react';
import { initializeEditorContent } from '../initializeEditorContent';
describe('initializeEditorContent', () => {
const mockEditor = {
commands: {
insertContent: jest.fn(),
},
} as unknown as Editor;
let mockEditor: Editor;
beforeEach(() => {
jest.clearAllMocks();
mockEditor = {
commands: {
insertContent: jest.fn(),
},
} as unknown as Editor;
});
it('should handle empty string', () => {
initializeEditorContent(mockEditor, '');
expect(mockEditor.commands.insertContent).not.toHaveBeenCalled();
});
it('should insert plain text correctly', () => {
it('should handle single line text', () => {
initializeEditorContent(mockEditor, 'Hello world');
expect(mockEditor.commands.insertContent).toHaveBeenCalledTimes(1);
@ -26,7 +21,24 @@ describe('initializeEditorContent', () => {
);
});
it('should insert single variable correctly', () => {
it('should handle text with newlines', () => {
initializeEditorContent(mockEditor, 'Line 1\nLine 2');
expect(mockEditor.commands.insertContent).toHaveBeenCalledTimes(3);
expect(mockEditor.commands.insertContent).toHaveBeenNthCalledWith(
1,
'Line 1',
);
expect(mockEditor.commands.insertContent).toHaveBeenNthCalledWith(2, {
type: 'hardBreak',
});
expect(mockEditor.commands.insertContent).toHaveBeenNthCalledWith(
3,
'Line 2',
);
});
it('should handle single variable', () => {
initializeEditorContent(mockEditor, '{{user.name}}');
expect(mockEditor.commands.insertContent).toHaveBeenCalledTimes(1);
@ -36,8 +48,8 @@ describe('initializeEditorContent', () => {
});
});
it('should handle text with variable in the middle', () => {
initializeEditorContent(mockEditor, 'Hello {{user.name}} world');
it('should handle text with variables', () => {
initializeEditorContent(mockEditor, 'Hello {{user.name}}, welcome!');
expect(mockEditor.commands.insertContent).toHaveBeenCalledTimes(3);
expect(mockEditor.commands.insertContent).toHaveBeenNthCalledWith(
@ -50,17 +62,17 @@ describe('initializeEditorContent', () => {
});
expect(mockEditor.commands.insertContent).toHaveBeenNthCalledWith(
3,
' world',
', welcome!',
);
});
it('should handle multiple variables', () => {
it('should handle text with multiple variables', () => {
initializeEditorContent(
mockEditor,
'Hello {{user.firstName}} {{user.lastName}}, welcome to {{app.name}}',
'Hello {{user.firstName}} {{user.lastName}}!',
);
expect(mockEditor.commands.insertContent).toHaveBeenCalledTimes(6);
expect(mockEditor.commands.insertContent).toHaveBeenCalledTimes(5);
expect(mockEditor.commands.insertContent).toHaveBeenNthCalledWith(
1,
'Hello ',
@ -74,70 +86,84 @@ describe('initializeEditorContent', () => {
type: 'variableTag',
attrs: { variable: '{{user.lastName}}' },
});
expect(mockEditor.commands.insertContent).toHaveBeenNthCalledWith(
5,
', welcome to ',
});
it('should handle newlines with variables', () => {
initializeEditorContent(
mockEditor,
'Hello {{user.name}}\nWelcome to {{app.name}}',
);
expect(mockEditor.commands.insertContent).toHaveBeenNthCalledWith(6, {
expect(mockEditor.commands.insertContent).toHaveBeenCalledTimes(5);
expect(mockEditor.commands.insertContent).toHaveBeenNthCalledWith(
1,
'Hello ',
);
expect(mockEditor.commands.insertContent).toHaveBeenNthCalledWith(2, {
type: 'variableTag',
attrs: { variable: '{{user.name}}' },
});
expect(mockEditor.commands.insertContent).toHaveBeenNthCalledWith(3, {
type: 'hardBreak',
});
expect(mockEditor.commands.insertContent).toHaveBeenNthCalledWith(
4,
'Welcome to ',
);
expect(mockEditor.commands.insertContent).toHaveBeenNthCalledWith(5, {
type: 'variableTag',
attrs: { variable: '{{app.name}}' },
});
});
it('should handle variables at the start and end', () => {
initializeEditorContent(mockEditor, '{{start.var}} middle {{end.var}}');
expect(mockEditor.commands.insertContent).toHaveBeenCalledTimes(3);
expect(mockEditor.commands.insertContent).toHaveBeenNthCalledWith(1, {
type: 'variableTag',
attrs: { variable: '{{start.var}}' },
});
expect(mockEditor.commands.insertContent).toHaveBeenNthCalledWith(
2,
' middle ',
);
expect(mockEditor.commands.insertContent).toHaveBeenNthCalledWith(3, {
type: 'variableTag',
attrs: { variable: '{{end.var}}' },
});
it('should handle empty strings', () => {
initializeEditorContent(mockEditor, '');
expect(mockEditor.commands.insertContent).not.toHaveBeenCalled();
});
it('should handle consecutive variables', () => {
initializeEditorContent(mockEditor, '{{var1}}{{var2}}{{var3}}');
it('should handle multiple empty parts', () => {
initializeEditorContent(mockEditor, 'Hello {{user.name}} !');
expect(mockEditor.commands.insertContent).toHaveBeenCalledTimes(3);
expect(mockEditor.commands.insertContent).toHaveBeenNthCalledWith(1, {
type: 'variableTag',
attrs: { variable: '{{var1}}' },
});
expect(mockEditor.commands.insertContent).toHaveBeenNthCalledWith(
1,
'Hello ',
);
expect(mockEditor.commands.insertContent).toHaveBeenNthCalledWith(2, {
type: 'variableTag',
attrs: { variable: '{{var2}}' },
});
expect(mockEditor.commands.insertContent).toHaveBeenNthCalledWith(3, {
type: 'variableTag',
attrs: { variable: '{{var3}}' },
attrs: { variable: '{{user.name}}' },
});
expect(mockEditor.commands.insertContent).toHaveBeenNthCalledWith(
3,
' !',
);
});
it('should handle whitespace between variables', () => {
initializeEditorContent(mockEditor, '{{var1}} {{var2}} ');
it('should handle multiple newlines', () => {
initializeEditorContent(mockEditor, 'Line1\n\nLine3');
expect(mockEditor.commands.insertContent).toHaveBeenCalledTimes(4);
expect(mockEditor.commands.insertContent).toHaveBeenNthCalledWith(1, {
type: 'variableTag',
attrs: { variable: '{{var1}}' },
expect(mockEditor.commands.insertContent).toHaveBeenNthCalledWith(
1,
'Line1',
);
expect(mockEditor.commands.insertContent).toHaveBeenNthCalledWith(2, {
type: 'hardBreak',
});
expect(mockEditor.commands.insertContent).toHaveBeenNthCalledWith(2, ' ');
expect(mockEditor.commands.insertContent).toHaveBeenNthCalledWith(3, {
type: 'variableTag',
attrs: { variable: '{{var2}}' },
type: 'hardBreak',
});
expect(mockEditor.commands.insertContent).toHaveBeenNthCalledWith(4, ' ');
expect(mockEditor.commands.insertContent).toHaveBeenNthCalledWith(
4,
'Line3',
);
});
it('should handle nested variable syntax', () => {
initializeEditorContent(mockEditor, 'Hello {{user.address.city}}!');
it('should ignore malformed variable tags', () => {
initializeEditorContent(
mockEditor,
'Hello {{user.name}} and {{invalid}more}} text',
);
expect(mockEditor.commands.insertContent).toHaveBeenCalledTimes(3);
expect(mockEditor.commands.insertContent).toHaveBeenNthCalledWith(
@ -146,8 +172,24 @@ describe('initializeEditorContent', () => {
);
expect(mockEditor.commands.insertContent).toHaveBeenNthCalledWith(2, {
type: 'variableTag',
attrs: { variable: '{{user.address.city}}' },
attrs: { variable: '{{user.name}}' },
});
expect(mockEditor.commands.insertContent).toHaveBeenNthCalledWith(
3,
' and {{invalid}more}} text',
);
});
it('should handle trailing newlines', () => {
initializeEditorContent(mockEditor, 'Hello\n');
expect(mockEditor.commands.insertContent).toHaveBeenCalledTimes(2);
expect(mockEditor.commands.insertContent).toHaveBeenNthCalledWith(
1,
'Hello',
);
expect(mockEditor.commands.insertContent).toHaveBeenNthCalledWith(2, {
type: 'hardBreak',
});
expect(mockEditor.commands.insertContent).toHaveBeenNthCalledWith(3, '!');
});
});

View File

@ -236,4 +236,35 @@ describe('parseEditorContent', () => {
'Hello {{user.firstName}} {{user.lastName}}Your ID is: {{user.id}}',
);
});
it('should handle hard breaks', () => {
const input: JSONContent = {
type: 'doc',
content: [
{
type: 'paragraph',
content: [
{
type: 'text',
text: 'First line',
},
],
},
{
type: 'hardBreak',
},
{
type: 'paragraph',
content: [
{
type: 'text',
text: 'Second line',
},
],
},
],
};
expect(parseEditorContent(input)).toBe('First line\nSecond line');
});
});

View File

@ -4,23 +4,33 @@ import { Editor } from '@tiptap/react';
const REGEX_VARIABLE_TAG = /(\{\{[^}]+\}\})/;
export const initializeEditorContent = (editor: Editor, content: string) => {
const parts = content.split(REGEX_VARIABLE_TAG);
const lines = content.split(/\n/);
parts.forEach((part) => {
if (part.length === 0) {
return;
}
lines.forEach((line, index) => {
const parts = line.split(REGEX_VARIABLE_TAG);
parts.forEach((part) => {
if (part.length === 0) {
return;
}
if (part.startsWith('{{') && part.endsWith('}}')) {
if (part.startsWith('{{') && part.endsWith('}}')) {
editor.commands.insertContent({
type: 'variableTag',
attrs: { variable: part },
});
return;
}
if (isNonEmptyString(part)) {
editor.commands.insertContent(part);
}
});
// Add hard break if it's not the last line
if (index < lines.length - 1) {
editor.commands.insertContent({
type: 'variableTag',
attrs: { variable: part },
type: 'hardBreak',
});
return;
}
if (isNonEmptyString(part)) {
editor.commands.insertContent(part);
}
});
};

View File

@ -14,6 +14,10 @@ export const parseEditorContent = (json: JSONContent): string => {
return node.text || '';
}
if (node.type === 'hardBreak') {
return '\n';
}
if (node.type === 'variableTag') {
return node.attrs?.variable || '';
}