The open alternative to Salesforce, designed for AI.
TypeScript crmcrm-systemcustomergood-first-issuegraphqlhacktoberfestjavascriptmarketingmonoreponestjsopen-sourcepostgresqlreactreactjssalestypescriptweb
Clean up CodeEditorHeader API (#27376)
Raphaël Bosi456581b70000
diff --git a/packages/twenty-docs/snippets/ui/generated/components/code-editor/code-editor-header.mdx b/packages/twenty-docs/snippets/ui/generated/components/code-editor/code-editor-header.mdxindex 76d0e4b8325..c481477273c 100644--- a/packages/twenty-docs/snippets/ui/generated/components/code-editor/code-editor-header.mdx+++ b/packages/twenty-docs/snippets/ui/generated/components/code-editor/code-editor-header.mdx@@ -11,14 +11,30 @@* npx nx generate:ui twenty-docs*/}-<ParamField body="leftNodes" type="ReactNode[]">- Elements shown at the start of the header, such as tabs.+<ParamField body="className" type="string">+ Additional CSS class applied to the root element.</ParamField>-<ParamField body="rightNodes" type="ReactNode[]">- Elements shown at the end of the header, such as actions.+<ParamField body="endElement" type="ReactNode">+ Content shown at the end of the header, such as actions. Use a fragment for multiple elements.</ParamField>-<ParamField body="title" type="string">- Text shown at the start of the header, after `leftNodes`.+<ParamField body="ref" type="Ref<HTMLDivElement>">+ Ref forwarded to the rendered root element, a div by default.+</ParamField>++<ParamField body="render" type="ReactElement<unknown, string | JSXElementConstructor<any>> | ComponentRenderFn<HTMLProps, {}>">+ Replace the root div or compose it with another component. Native props and refs target the rendered root.+</ParamField>++<ParamField body="startElement" type="ReactNode">+ Content shown at the start of the header, before the title, such as tabs. Use a fragment for multiple elements.+</ParamField>++<ParamField body="style" type="CSSProperties">+ Inline styles applied to the root element.+</ParamField>++<ParamField body="title" type="ReactNode">+ Content shown after `startElement`. This is visible header content, not the native HTML title attribute.</ParamField>diff --git a/packages/twenty-docs/ui/components/code-editor/code-editor.mdx b/packages/twenty-docs/ui/components/code-editor/code-editor.mdxindex 2ee4ec1d280..e0a4d384776 100644--- a/packages/twenty-docs/ui/components/code-editor/code-editor.mdx+++ b/packages/twenty-docs/ui/components/code-editor/code-editor.mdx@@ -64,11 +64,11 @@ export const ScriptEditor = ({ script, onRun }: ScriptEditorProps) => (<div><CodeEditorHeadertitle="index.ts"- rightNodes={[- <Button key="run" size="sm" onClick={onRun}>+ endElement={+ <Button size="sm" onClick={onRun}>Run- </Button>,- ]}+ </Button>+ }/><CodeEditor language="typescript" value={script} variant="with-header" /></div>@@ -77,6 +77,8 @@ export const ScriptEditor = ({ script, onRun }: ScriptEditorProps) => (`variant="with-header"` removes the editor's top border so it joins the header. Use `borderless` when the editor sits inside a surface that already has a border.+The header accepts node content in `title`, `startElement`, and `endElement`. Use fragments for multiple tabs or actions. Native props, `className`, `style`, and `ref` target its root div. Use `render` to replace that root, for example `render={<header />}`. The `title` prop supplies visible content; to set a native title attribute, pass it on the element supplied to `render`.+## Size and appearanceThe editor is 450px tall by default. Set `height` to a number of pixels or a CSS length. `autoHeight` grows the editor with its content, and `resizable` adds a handle below it to drag the height. When both are set, `resizable` applies.diff --git a/packages/twenty-front-component-renderer/src/__stories__/twenty-ui-gallery/twenty-ui-input-gallery.front-component.tsx b/packages/twenty-front-component-renderer/src/__stories__/twenty-ui-gallery/twenty-ui-input-gallery.front-component.tsxindex 35334dcad72..16062b75150 100644--- a/packages/twenty-front-component-renderer/src/__stories__/twenty-ui-gallery/twenty-ui-input-gallery.front-component.tsx+++ b/packages/twenty-front-component-renderer/src/__stories__/twenty-ui-gallery/twenty-ui-input-gallery.front-component.tsx@@ -20,6 +20,7 @@ import {Switch,} from 'twenty-ui/primitives/input';import { ThemeProvider } from 'twenty-ui/theme';+import { Text } from 'twenty-ui/primitives/typography';import {ComponentGallery,type GalleryEntry,@@ -60,7 +61,14 @@ const INPUT_ENTRIES: GalleryEntry[] = [},{name: 'CodeEditorHeader',- node: <CodeEditorHeader title="Editor" />,+ node: (+ <CodeEditorHeader+ title={<Text>Editor</Text>}+ endElement={<Button size="sm">Format</Button>}+ render={<header />}+ aria-label="Code editor"+ />+ ),},{name: 'IconButton (elevated)',diff --git a/packages/twenty-front-component-renderer/src/__stories__/twenty-ui-gallery/utils/inputTest.ts b/packages/twenty-front-component-renderer/src/__stories__/twenty-ui-gallery/utils/inputTest.tsindex 86b2f78a3d5..0a2e8f22dcb 100644--- a/packages/twenty-front-component-renderer/src/__stories__/twenty-ui-gallery/utils/inputTest.ts+++ b/packages/twenty-front-component-renderer/src/__stories__/twenty-ui-gallery/utils/inputTest.ts@@ -7,6 +7,16 @@ import { galleryRenderTest } from '@/__stories__/twenty-ui-gallery/utils/galleryexport const inputTest: TwentyUiGalleryPlayFunction = async (context) => {await galleryRenderTest(context);+ const editorHeader = within(context.canvasElement).getByLabelText(+ 'Code editor',+ );++ expect(editorHeader.tagName).toBe('HEADER');+ await expect(within(editorHeader).getByText('Editor')).toBeVisible();+ await expect(+ within(editorHeader).getByRole('button', { name: 'Format' }),+ ).toBeVisible();+const segmentedControl = within(within(context.canvasElement).getByRole('radiogroup', { name: 'Choose' }),);diff --git a/packages/twenty-front/src/modules/settings/logic-functions/components/tabs/SettingsLogicFunctionCodeEditorTab.tsx b/packages/twenty-front/src/modules/settings/logic-functions/components/tabs/SettingsLogicFunctionCodeEditorTab.tsxindex 5c212459205..db9ba26d0c3 100644--- a/packages/twenty-front/src/modules/settings/logic-functions/components/tabs/SettingsLogicFunctionCodeEditorTab.tsx+++ b/packages/twenty-front/src/modules/settings/logic-functions/components/tabs/SettingsLogicFunctionCodeEditorTab.tsx@@ -65,7 +65,7 @@ export const SettingsLogicFunctionCodeEditorTab = ({title={t`Code your function`}description={t`Write your function (in typescript) below`}/>- <CodeEditorHeader leftNodes={[HeaderTabList]} rightNodes={[TestButton]} />+ <CodeEditorHeader startElement={HeaderTabList} endElement={TestButton} />{activeTabId && (<SettingsLogicFunctionCodeEditorfiles={files}diff --git a/packages/twenty-front/src/modules/settings/logic-functions/components/tabs/SettingsLogicFunctionTestTab.tsx b/packages/twenty-front/src/modules/settings/logic-functions/components/tabs/SettingsLogicFunctionTestTab.tsxindex e9a19a59ed8..a464256f35d 100644--- a/packages/twenty-front/src/modules/settings/logic-functions/components/tabs/SettingsLogicFunctionTestTab.tsx+++ b/packages/twenty-front/src/modules/settings/logic-functions/components/tabs/SettingsLogicFunctionTestTab.tsx@@ -154,7 +154,7 @@ export const SettingsLogicFunctionTestTab = ({<StyledCodeEditorContainer><CodeEditorHeadertitle={t`Input`}- rightNodes={[+ endElement={<Buttonsize="sm"startIcon={<IconPlayerPlay />}@@ -162,8 +162,8 @@ export const SettingsLogicFunctionTestTab = ({disabled={isTesting}variant="solid"color="accent"- >{t`Run Function`}</Button>,- ]}+ >{t`Run Function`}</Button>+ }/><CodeEditorvalue={JSON.stringify(logicFunctionTestData.input, null, 4)}diff --git a/packages/twenty-front/src/modules/settings/mcp-and-apis/components/SettingsMcpSetup.tsx b/packages/twenty-front/src/modules/settings/mcp-and-apis/components/SettingsMcpSetup.tsxindex 983b4cb415e..d05415a25f3 100644--- a/packages/twenty-front/src/modules/settings/mcp-and-apis/components/SettingsMcpSetup.tsx+++ b/packages/twenty-front/src/modules/settings/mcp-and-apis/components/SettingsMcpSetup.tsx@@ -76,18 +76,13 @@ export const SettingsMcpSetup = () => {description={t`Access your workspace data from your favorite MCP client like Claude, Codex or Cursor.`}/><CodeEditorHeader- leftNodes={[- <StyledMcpEditorHeaderTitle key="mcp-editor-header-title">+ startElement={+ <StyledMcpEditorHeaderTitle><StyledMcpIcon aria-hidden /><span>{t`MCP client configuration`}</span>- </StyledMcpEditorHeaderTitle>,- ]}- rightNodes={[- <LightCopyIconButton- key="mcp-config-copy-button"- copyText={mcpConfig}- />,- ]}+ </StyledMcpEditorHeaderTitle>+ }+ endElement={<LightCopyIconButton copyText={mcpConfig} />}/><CodeEditorvalue={mcpConfig}diff --git a/packages/twenty-front/src/modules/workflow/components/WorkflowStepExecutionResult.tsx b/packages/twenty-front/src/modules/workflow/components/WorkflowStepExecutionResult.tsxindex 4d0060b12f6..fc0366edd65 100644--- a/packages/twenty-front/src/modules/workflow/components/WorkflowStepExecutionResult.tsx+++ b/packages/twenty-front/src/modules/workflow/components/WorkflowStepExecutionResult.tsx@@ -127,8 +127,8 @@ export const WorkflowStepExecutionResult = ({return (<StyledContainer><CodeEditorHeader- leftNodes={[computeLeftNode()]}- rightNodes={[<LightCopyIconButton copyText={result} />]}+ startElement={computeLeftNode()}+ endElement={<LightCopyIconButton copyText={result} />}/><StyledCodeEditorWrapper><CodeEditordiff --git a/packages/twenty-ui/docs/codeEditorHeaderPropDescriptions.ts b/packages/twenty-ui/docs/codeEditorHeaderPropDescriptions.tsindex e0279eb2cdc..be820866abc 100644--- a/packages/twenty-ui/docs/codeEditorHeaderPropDescriptions.ts+++ b/packages/twenty-ui/docs/codeEditorHeaderPropDescriptions.ts@@ -1,7 +1,15 @@import { type CodeEditorHeaderProps } from '../src/components/code-editor/CodeEditorHeader/types/CodeEditorHeaderProps';export const CODE_EDITOR_HEADER_PROP_DESCRIPTIONS = {- title: 'Text shown at the start of the header, after `leftNodes`.',- leftNodes: 'Elements shown at the start of the header, such as tabs.',- rightNodes: 'Elements shown at the end of the header, such as actions.',+ title:+ 'Content shown after `startElement`. This is visible header content, not the native HTML title attribute.',+ startElement:+ 'Content shown at the start of the header, before the title, such as tabs. Use a fragment for multiple elements.',+ endElement:+ 'Content shown at the end of the header, such as actions. Use a fragment for multiple elements.',+ ref: 'Ref forwarded to the rendered root element, a div by default.',+ className: 'Additional CSS class applied to the root element.',+ style: 'Inline styles applied to the root element.',+ render:+ 'Replace the root div or compose it with another component. Native props and refs target the rendered root.',} satisfies Partial<Record<keyof CodeEditorHeaderProps, string>>;diff --git a/packages/twenty-ui/generated/components.docs.json b/packages/twenty-ui/generated/components.docs.jsonindex 127f0f7b723..852d3989bcc 100644--- a/packages/twenty-ui/generated/components.docs.json+++ b/packages/twenty-ui/generated/components.docs.json@@ -9229,25 +9229,53 @@"slug": "components/code-editor/code-editor-header","props": [{- "name": "leftNodes",- "type": "ReactNode[]",+ "name": "className",+ "type": "string","required": false,"defaultValue": null,- "description": "Elements shown at the start of the header, such as tabs."+ "description": "Additional CSS class applied to the root element."},{- "name": "rightNodes",- "type": "ReactNode[]",+ "name": "endElement",+ "type": "ReactNode",+ "required": false,+ "defaultValue": null,+ "description": "Content shown at the end of the header, such as actions. Use a fragment for multiple elements."+ },+ {+ "name": "ref",+ "type": "Ref<HTMLDivElement>",+ "required": false,+ "defaultValue": null,+ "description": "Ref forwarded to the rendered root element, a div by default."+ },+ {+ "name": "render",+ "type": "ReactElement<unknown, string | JSXElementConstructor<any>> | ComponentRenderFn<HTMLProps, {}>",+ "required": false,+ "defaultValue": null,+ "description": "Replace the root div or compose it with another component. Native props and refs target the rendered root."+ },+ {+ "name": "startElement",+ "type": "ReactNode","required": false,"defaultValue": null,- "description": "Elements shown at the end of the header, such as actions."+ "description": "Content shown at the start of the header, before the title, such as tabs. Use a fragment for multiple elements."+ },+ {+ "name": "style",+ "type": "CSSProperties",+ "required": false,+ "defaultValue": null,+ "description": "Inline styles applied to the root element."},{"name": "title",- "type": "string",+ "type": "ReactNode","required": false,"defaultValue": null,- "description": "Text shown at the start of the header, after `leftNodes`."+ "description": "Content shown after `startElement`. This is visible header content, not the native HTML title attribute."}]},diff --git a/packages/twenty-ui/src/components/code-editor/CodeEditor/__stories__/CodeEditor.stories.tsx b/packages/twenty-ui/src/components/code-editor/CodeEditor/__stories__/CodeEditor.stories.tsxindex 625433ae549..67e41effd88 100644--- a/packages/twenty-ui/src/components/code-editor/CodeEditor/__stories__/CodeEditor.stories.tsx+++ b/packages/twenty-ui/src/components/code-editor/CodeEditor/__stories__/CodeEditor.stories.tsx@@ -76,11 +76,11 @@ export const Documentation: Story = {<div style={{ width: '100%' }}><CodeEditorHeadertitle="workspace.json"- rightNodes={[- <Button key="format" size="sm" variant="outline">+ endElement={+ <Button size="sm" variant="outline">Format- </Button>,- ]}+ </Button>+ }/><CodeEditor {...args} /></div>diff --git a/packages/twenty-ui/src/components/code-editor/CodeEditorHeader/CodeEditorHeader.tsx b/packages/twenty-ui/src/components/code-editor/CodeEditorHeader/CodeEditorHeader.tsxindex 8f4d5612a66..58975b7b17b 100644--- a/packages/twenty-ui/src/components/code-editor/CodeEditorHeader/CodeEditorHeader.tsx+++ b/packages/twenty-ui/src/components/code-editor/CodeEditorHeader/CodeEditorHeader.tsx@@ -1,26 +1,34 @@+import { useRender } from '@base-ui/react/use-render';+import { clsx } from 'clsx';+import { type CodeEditorHeaderProps } from './types/CodeEditorHeaderProps';+import styles from './CodeEditorHeader.module.scss';export const CodeEditorHeader = ({title,- leftNodes,- rightNodes,+ startElement,+ endElement,+ className,+ render,+ ref,+ ...props}: CodeEditorHeaderProps) => {- return (- <div className={styles.editorHeader}>- <div className={styles.elementContainer}>- {leftNodes &&- leftNodes.map((leftButton, index) => {- return <div key={`left-${index}`}>{leftButton}</div>;- })}- {title}- </div>- <div className={styles.elementContainer}>- {rightNodes &&- rightNodes.map((rightButton, index) => {- return <div key={`right-${index}`}>{rightButton}</div>;- })}- </div>- </div>- );+ return useRender({+ render,+ ref,+ props: {+ ...props,+ className: clsx(styles.editorHeader, className),+ children: (+ <>+ <div className={styles.elementContainer}>+ {startElement}+ {title}+ </div>+ <div className={styles.elementContainer}>{endElement}</div>+ </>+ ),+ },+ });};diff --git a/packages/twenty-ui/src/components/code-editor/CodeEditorHeader/__stories__/CodeEditorHeader.stories.tsx b/packages/twenty-ui/src/components/code-editor/CodeEditorHeader/__stories__/CodeEditorHeader.stories.tsxindex dbd353ac07a..0d4ee76f68d 100644--- a/packages/twenty-ui/src/components/code-editor/CodeEditorHeader/__stories__/CodeEditorHeader.stories.tsx+++ b/packages/twenty-ui/src/components/code-editor/CodeEditorHeader/__stories__/CodeEditorHeader.stories.tsx@@ -1,9 +1,10 @@import { type Meta, type StoryObj } from '@storybook/react-vite';-import { expect, within } from 'storybook/test';+import { expect, fn, userEvent, within } from 'storybook/test';-import { LightIconButton } from '@ui/components/input/LightIconButton/LightIconButton';+import { IconButton } from '@ui/components/input/IconButton/IconButton';import { IconCopy } from '@ui/icon/components/TablerIcons';import { Button } from '@ui/primitives/input/Button/Button';+import { Text } from '@ui/primitives/typography/Text/Text';import { A11Y_DEFER_COLOR_CONTRAST, ComponentDecorator } from '@ui/testing';import { CodeEditorHeader } from '../CodeEditorHeader';@@ -28,6 +29,8 @@ export default meta;type Story = StoryObj<typeof CodeEditorHeader>;+const handleRun = fn();+export const Default: Story = {decorators: [ComponentDecorator],play: async ({ canvasElement }) => {@@ -40,24 +43,44 @@ export const Default: Story = {export const WithActions: Story = {...Default,args: {- leftNodes: [- <LightIconButton key="copy" aria-label="Copy code">+ title: <Text>workspace.json</Text>,+ startElement: (+ <IconButton size="sm" variant="ghost" aria-label="Copy code"><IconCopy />- </LightIconButton>,- ],- rightNodes: [- <Button key="run" size="sm" variant="solid" color="accent">- Run- </Button>,- ],+ </IconButton>+ ),+ endElement: (+ <>+ <Button size="sm" variant="outline">+ Format+ </Button>+ <Button size="sm" variant="solid" color="accent" onClick={handleRun}>+ Run+ </Button>+ </>+ ),},play: async ({ canvasElement }) => {const canvas = within(canvasElement);+ handleRun.mockClear();+await expect(canvas.getByText('workspace.json')).toBeVisible();await expect(canvas.getByRole('button', { name: 'Copy code' }),).toBeVisible();await expect(canvas.getByRole('button', { name: 'Run' })).toBeVisible();+ await expect(canvas.getByRole('button', { name: 'Format' })).toBeVisible();++ canvas.getByRole('button', { name: 'Copy code' }).focus();+ await expect(+ canvas.getByRole('button', { name: 'Copy code' }),+ ).toHaveFocus();+ await userEvent.tab();+ await expect(canvas.getByRole('button', { name: 'Format' })).toHaveFocus();+ await userEvent.tab();+ await expect(canvas.getByRole('button', { name: 'Run' })).toHaveFocus();+ await userEvent.keyboard('{Enter}');+ await expect(handleRun).toHaveBeenCalledTimes(1);},};diff --git a/packages/twenty-ui/src/components/code-editor/CodeEditorHeader/__tests__/CodeEditorHeader.test.tsx b/packages/twenty-ui/src/components/code-editor/CodeEditorHeader/__tests__/CodeEditorHeader.test.tsxnew file mode 100644index 00000000000..3ef174b9f65--- /dev/null+++ b/packages/twenty-ui/src/components/code-editor/CodeEditorHeader/__tests__/CodeEditorHeader.test.tsx@@ -0,0 +1,13 @@+import { runComponentConformance } from '@test-utilities/conformance/runComponentConformance';++import { CodeEditorHeader } from '../CodeEditorHeader';++import styles from '../CodeEditorHeader.module.scss';++runComponentConformance({+ name: 'CodeEditorHeader',+ element: <CodeEditorHeader title="workspace.json" />,+ ownClassName: styles.editorHeader,+ refInstanceOf: HTMLDivElement,+ renderPropTagName: 'header',+});diff --git a/packages/twenty-ui/src/components/code-editor/CodeEditorHeader/types/CodeEditorHeaderProps.ts b/packages/twenty-ui/src/components/code-editor/CodeEditorHeader/types/CodeEditorHeaderProps.tsindex 601e18a1804..4f877ebfbb0 100644--- a/packages/twenty-ui/src/components/code-editor/CodeEditorHeader/types/CodeEditorHeaderProps.ts+++ b/packages/twenty-ui/src/components/code-editor/CodeEditorHeader/types/CodeEditorHeaderProps.ts@@ -1,5 +1,11 @@-export type CodeEditorHeaderProps = {- title?: string;- leftNodes?: React.ReactNode[];- rightNodes?: React.ReactNode[];+import { type useRender } from '@base-ui/react/use-render';+import { type ReactNode } from 'react';++export type CodeEditorHeaderProps = Omit<+ useRender.ComponentProps<'div'>,+ 'title' | 'children'+> & {+ title?: ReactNode;+ startElement?: ReactNode;+ endElement?: ReactNode;};