The open alternative to Salesforce, designed for AI.
TypeScript crmcrm-systemcustomergood-first-issuegraphqlhacktoberfestjavascriptmarketingmonoreponestjsopen-sourcepostgresqlreactreactjssalestypescriptweb
Fix solo field widget header actions (#25102)
Félix Malfaitbd353e9721fd
diff --git a/packages/twenty-front/src/modules/page-layout/widgets/components/__stories__/WidgetRenderer.stories.tsx b/packages/twenty-front/src/modules/page-layout/widgets/components/__stories__/WidgetRenderer.stories.tsxindex 6c20fd838ff..a61763e4c07 100644--- a/packages/twenty-front/src/modules/page-layout/widgets/components/__stories__/WidgetRenderer.stories.tsx+++ b/packages/twenty-front/src/modules/page-layout/widgets/components/__stories__/WidgetRenderer.stories.tsx@@ -1191,7 +1191,7 @@ export const OneToManyRelationFieldWidgetWithSeeAllButton: Story = {docs: {description: {story:- 'A ONE_TO_MANY relation field widget with visible "See all" button and a well-formed link.',+ 'A solo ONE_TO_MANY relation field widget with visible header actions and a well-formed "See all" link.',},},},@@ -1288,7 +1288,7 @@ export const OneToManyRelationFieldWidgetWithSeeAllButton: Story = {<PageLayoutContentProvidervalue={{layoutMode: PageLayoutTabLayoutMode.VERTICAL_LIST,- presentation: 'stack',+ presentation: 'solo',tabId: TAB_ID_OVERVIEW,}}>@@ -1310,6 +1310,21 @@ export const OneToManyRelationFieldWidgetWithSeeAllButton: Story = {play: async ({ canvasElement }) => {const canvas = within(canvasElement);+ const header = canvasElement.querySelector('.widget-card-header');++ expect(header).not.toBeNull();++ if (!(header instanceof HTMLElement)) {+ throw new Error('Widget header not found');+ }++ const headerCanvas = within(header);++ expect(headerCanvas.getByText('People')).toBeVisible();+ expect(+ headerCanvas.getByRole('button', { name: 'Edit relation' }),+ ).toBeVisible();+const seeAllLink = await canvas.findByRole('link', {name: /See all .* linked to this record/,});diff --git a/packages/twenty-front/src/modules/page-layout/widgets/constants/WidgetTypesWithAlwaysVisibleSoloHeader.ts b/packages/twenty-front/src/modules/page-layout/widgets/constants/WidgetTypesWithAlwaysVisibleSoloHeader.tsdeleted file mode 100644index 823e0acf43f..00000000000--- a/packages/twenty-front/src/modules/page-layout/widgets/constants/WidgetTypesWithAlwaysVisibleSoloHeader.ts+++ /dev/null@@ -1,12 +0,0 @@-import { WidgetType } from '~/generated-metadata/graphql';--export const WIDGET_TYPES_WITH_ALWAYS_VISIBLE_SOLO_HEADER: WidgetType[] = [- WidgetType.CALENDAR,- WidgetType.EMAILS,- WidgetType.TASKS,- WidgetType.NOTES,- WidgetType.FILES,- WidgetType.TIMELINE,- WidgetType.CALL_RECORDING_SUMMARY,- WidgetType.CALL_RECORDING_TRANSCRIPT,-];diff --git a/packages/twenty-front/src/modules/page-layout/widgets/hooks/useWidgetRendererState.ts b/packages/twenty-front/src/modules/page-layout/widgets/hooks/useWidgetRendererState.tsindex de0d4c28212..40e92a25111 100644--- a/packages/twenty-front/src/modules/page-layout/widgets/hooks/useWidgetRendererState.ts+++ b/packages/twenty-front/src/modules/page-layout/widgets/hooks/useWidgetRendererState.ts@@ -7,14 +7,15 @@ import { pageLayoutDraggingWidgetIdComponentState } from '@/page-layout/states/pimport { pageLayoutEditingWidgetIdComponentState } from '@/page-layout/states/pageLayoutEditingWidgetIdComponentState';import { pageLayoutResizingWidgetIdComponentState } from '@/page-layout/states/pageLayoutResizingWidgetIdComponentState';import { type PageLayoutWidget } from '@/page-layout/types/PageLayoutWidget';-import { WIDGET_TYPES_WITH_ALWAYS_VISIBLE_SOLO_HEADER } from '@/page-layout/widgets/constants/WidgetTypesWithAlwaysVisibleSoloHeader';import { useWidgetPermissions } from '@/page-layout/widgets/hooks/useWidgetPermissions';import { widgetCardHoveredComponentFamilyState } from '@/page-layout/widgets/states/widgetCardHoveredComponentFamilyState';import { getWidgetCardVariant } from '@/page-layout/widgets/utils/getWidgetCardVariant';+import { getWidgetHeaderActionDefinition } from '@/page-layout/widgets/utils/getWidgetHeaderActionDefinition';import { useOpenWidgetSettingsInSidePanel } from '@/side-panel/hooks/useOpenWidgetSettingsInSidePanel';import { useAtomComponentStateValue } from '@/ui/utilities/state/jotai/hooks/useAtomComponentStateValue';import { useSetAtomComponentFamilyState } from '@/ui/utilities/state/jotai/hooks/useSetAtomComponentFamilyState';import { type MouseEvent } from 'react';+import { isDefined } from 'twenty-shared/utils';import { WidgetType } from '~/generated-metadata/graphql';export const useWidgetRendererState = (widget: PageLayoutWidget) => {@@ -58,10 +59,10 @@ export const useWidgetRendererState = (widget: PageLayoutWidget) => {const hideHeaderInViewMode =isHeaderHiddenInViewMode && !isPageLayoutInEditMode;+ const hasHeaderAction = isDefined(getWidgetHeaderActionDefinition(widget));+const showHeader =- presentation === 'solo'- ? WIDGET_TYPES_WITH_ALWAYS_VISIBLE_SOLO_HEADER.includes(widget.type)- : !hideHeaderInViewMode;+ presentation === 'solo' ? hasHeaderAction : !hideHeaderInViewMode;const handleClick = () => {openWidgetSettingsInSidePanel({diff --git a/packages/twenty-front/src/modules/page-layout/widgets/utils/__tests__/getWidgetHeaderActionDefinition.test.ts b/packages/twenty-front/src/modules/page-layout/widgets/utils/__tests__/getWidgetHeaderActionDefinition.test.tsnew file mode 100644index 00000000000..0f58edbb73c--- /dev/null+++ b/packages/twenty-front/src/modules/page-layout/widgets/utils/__tests__/getWidgetHeaderActionDefinition.test.ts@@ -0,0 +1,69 @@+import { getWidgetHeaderActionDefinition } from '@/page-layout/widgets/utils/getWidgetHeaderActionDefinition';+import {+ FieldDisplayMode,+ WidgetConfigurationType,+ WidgetType,+} from '~/generated-metadata/graphql';++describe('getWidgetHeaderActionDefinition', () => {+ it('returns the registered action component for a built-in widget', () => {+ const definition = getWidgetHeaderActionDefinition({+ type: WidgetType.FIELD,+ configuration: {+ __typename: 'FieldConfiguration',+ configurationType: WidgetConfigurationType.FIELD,+ fieldMetadataId: 'field-metadata-id',+ fieldDisplayMode: FieldDisplayMode.FIELD,+ },+ });++ expect(definition?.kind).toBe('component');+ });++ it('returns configured command menu items for a front component widget', () => {+ const definition = getWidgetHeaderActionDefinition({+ type: WidgetType.FRONT_COMPONENT,+ configuration: {+ __typename: 'FrontComponentConfiguration',+ configurationType: WidgetConfigurationType.FRONT_COMPONENT,+ frontComponentId: 'front-component-id',+ headerCommandMenuItemUniversalIdentifiers: [+ 'command-menu-item-universal-identifier',+ ],+ },+ });++ expect(definition).toEqual({+ kind: 'command-menu-items',+ commandMenuItemUniversalIdentifiers: [+ 'command-menu-item-universal-identifier',+ ],+ });+ });++ it('returns no action for a front component without command menu items', () => {+ const definition = getWidgetHeaderActionDefinition({+ type: WidgetType.FRONT_COMPONENT,+ configuration: {+ __typename: 'FrontComponentConfiguration',+ configurationType: WidgetConfigurationType.FRONT_COMPONENT,+ frontComponentId: 'front-component-id',+ headerCommandMenuItemUniversalIdentifiers: [],+ },+ });++ expect(definition).toBeUndefined();+ });++ it('returns no action for an actionless widget', () => {+ const definition = getWidgetHeaderActionDefinition({+ type: WidgetType.CALL_RECORDING_SUMMARY,+ configuration: {+ __typename: 'CallRecordingSummaryConfiguration',+ configurationType: WidgetConfigurationType.CALL_RECORDING_SUMMARY,+ },+ });++ expect(definition).toBeUndefined();+ });+});diff --git a/packages/twenty-front/src/modules/page-layout/widgets/constants/WidgetHeaderActionComponentByWidgetType.ts b/packages/twenty-front/src/modules/page-layout/widgets/utils/getWidgetHeaderActionDefinition.tssimilarity index 56%rename from packages/twenty-front/src/modules/page-layout/widgets/constants/WidgetHeaderActionComponentByWidgetType.tsrename to packages/twenty-front/src/modules/page-layout/widgets/utils/getWidgetHeaderActionDefinition.tsindex ce9163ce3f8..66ac0f327f2 100644--- a/packages/twenty-front/src/modules/page-layout/widgets/constants/WidgetHeaderActionComponentByWidgetType.ts+++ b/packages/twenty-front/src/modules/page-layout/widgets/utils/getWidgetHeaderActionDefinition.ts@@ -7,14 +7,26 @@ import { WidgetActionFileAttach } from '@/page-layout/widgets/files/components/Wimport { WidgetActionNoteCreate } from '@/page-layout/widgets/notes/components/WidgetActionNoteCreate';import { WidgetActionTaskCreate } from '@/page-layout/widgets/tasks/components/WidgetActionTaskCreate';import { WidgetActionTimeline } from '@/page-layout/widgets/timeline/components/WidgetActionTimeline';+import { isWidgetConfigurationOfType } from '@/side-panel/pages/page-layout/utils/isWidgetConfigurationOfType';import { type ComponentType } from 'react';+import { isDefined, isNonEmptyArray } from 'twenty-shared/utils';import { WidgetType } from '~/generated-metadata/graphql';-export type WidgetHeaderActionComponentProps = {+type WidgetHeaderActionComponentProps = {widget: PageLayoutWidget;};-export const WIDGET_HEADER_ACTION_COMPONENT_BY_WIDGET_TYPE: Partial<+type WidgetHeaderActionDefinition =+ | {+ kind: 'component';+ Component: ComponentType<WidgetHeaderActionComponentProps>;+ }+ | {+ kind: 'command-menu-items';+ commandMenuItemUniversalIdentifiers: string[];+ };++const widgetHeaderActionComponentByWidgetType: Partial<Record<WidgetType, ComponentType<WidgetHeaderActionComponentProps>>> = {[WidgetType.FIELD]: WidgetFieldActions,@@ -26,3 +38,32 @@ export const WIDGET_HEADER_ACTION_COMPONENT_BY_WIDGET_TYPE: Partial<[WidgetType.TIMELINE]: WidgetActionTimeline,[WidgetType.CALL_RECORDING_TRANSCRIPT]: WidgetActionCallRecordingTranscript,};++export const getWidgetHeaderActionDefinition = (+ widget: Pick<PageLayoutWidget, 'configuration' | 'type'>,+): WidgetHeaderActionDefinition | undefined => {+ if (+ isWidgetConfigurationOfType(+ widget.configuration,+ 'FrontComponentConfiguration',+ ) &&+ isNonEmptyArray(+ widget.configuration.headerCommandMenuItemUniversalIdentifiers,+ )+ ) {+ return {+ kind: 'command-menu-items',+ commandMenuItemUniversalIdentifiers:+ widget.configuration.headerCommandMenuItemUniversalIdentifiers,+ };+ }++ const Component = widgetHeaderActionComponentByWidgetType[widget.type];++ return isDefined(Component)+ ? {+ kind: 'component',+ Component,+ }+ : undefined;+};diff --git a/packages/twenty-front/src/modules/page-layout/widgets/widget-card/components/WidgetCardHeaderActionsRenderer.tsx b/packages/twenty-front/src/modules/page-layout/widgets/widget-card/components/WidgetCardHeaderActionsRenderer.tsxindex 20fcdfffe8e..c228a0958d2 100644--- a/packages/twenty-front/src/modules/page-layout/widgets/widget-card/components/WidgetCardHeaderActionsRenderer.tsx+++ b/packages/twenty-front/src/modules/page-layout/widgets/widget-card/components/WidgetCardHeaderActionsRenderer.tsx@@ -1,11 +1,10 @@import { useIsPageLayoutInEditMode } from '@/page-layout/hooks/useIsPageLayoutInEditMode';-import { WIDGET_HEADER_ACTION_COMPONENT_BY_WIDGET_TYPE } from '@/page-layout/widgets/constants/WidgetHeaderActionComponentByWidgetType';import { useCurrentWidgetOrNull } from '@/page-layout/widgets/hooks/useCurrentWidgetOrNull';+import { getWidgetHeaderActionDefinition } from '@/page-layout/widgets/utils/getWidgetHeaderActionDefinition';import { WidgetHeaderCommandMenuItems } from '@/page-layout/widgets/widget-card/components/WidgetHeaderCommandMenuItems';-import { isWidgetConfigurationOfType } from '@/side-panel/pages/page-layout/utils/isWidgetConfigurationOfType';import { useLayoutRenderingContext } from '@/ui/layout/contexts/LayoutRenderingContext';import { styled } from '@linaria/react';-import { isDefined, isNonEmptyArray } from 'twenty-shared/utils';+import { isDefined } from 'twenty-shared/utils';import { themeCssVariables } from 'twenty-ui/theme-constants';import { WidgetType } from '~/generated-metadata/graphql';@@ -31,33 +30,26 @@ export const WidgetCardHeaderActionsRenderer = () => {return null;}- if (- isWidgetConfigurationOfType(- widget.configuration,- 'FrontComponentConfiguration',- ) &&- isNonEmptyArray(- widget.configuration.headerCommandMenuItemUniversalIdentifiers,- )- ) {+ const headerActionDefinition = getWidgetHeaderActionDefinition(widget);++ if (!isDefined(headerActionDefinition)) {+ return null;+ }++ if (headerActionDefinition.kind === 'command-menu-items') {return (<StyledActionsContainer><WidgetHeaderCommandMenuItemsapplicationId={widget.applicationId}commandMenuItemUniversalIdentifiers={- widget.configuration.headerCommandMenuItemUniversalIdentifiers+ headerActionDefinition.commandMenuItemUniversalIdentifiers}/></StyledActionsContainer>);}- const HeaderActionComponent =- WIDGET_HEADER_ACTION_COMPONENT_BY_WIDGET_TYPE[widget.type];-- if (!isDefined(HeaderActionComponent)) {- return null;- }+ const HeaderActionComponent = headerActionDefinition.Component;return (<StyledActionsContainer>