Skip to content

The open alternative to Salesforce, designed for AI.

Add useColorScheme hook to twenty-sdk (#21595)

martmull5207493cda15
diff --git a/packages/twenty-docs/developers/extend/apps/layout/front-components.mdx b/packages/twenty-docs/developers/extend/apps/layout/front-components.mdx
index 54c94745699..0ded7880380 100644
--- a/packages/twenty-docs/developers/extend/apps/layout/front-components.mdx
+++ b/packages/twenty-docs/developers/extend/apps/layout/front-components.mdx
@@ -344,6 +344,7 @@ Available hooks:
| `useSelectedRecordIds()` | `string[]` | All selected record IDs (empty array if none selected) |
| `useRecordId()` | `string` or `null` | **Deprecated.** Use `useSelectedRecordIds()` instead |
| `useFrontComponentId()` | `string` | This component instance's ID |
+| `useColorScheme()` | `'light'` or `'dark'` | The host UI's active color scheme (`System` is already resolved) |
| `useFrontComponentExecutionContext(selector)` | varies | Access the full execution context with a selector function |
## Application variables
diff --git a/packages/twenty-front-component-renderer/src/__stories__/FrontComponentRenderer.stories.tsx b/packages/twenty-front-component-renderer/src/__stories__/FrontComponentRenderer.stories.tsx
index 2a6e0a0fa99..3df4351ae39 100644
--- a/packages/twenty-front-component-renderer/src/__stories__/FrontComponentRenderer.stories.tsx
+++ b/packages/twenty-front-component-renderer/src/__stories__/FrontComponentRenderer.stories.tsx
@@ -20,6 +20,7 @@ const meta: Meta<typeof FrontComponentRenderer> = {
userId: null,
recordId: null,
selectedRecordIds: [],
+ colorScheme: 'light',
},
},
beforeEach: () => {
@@ -123,6 +124,7 @@ export const SdkContext: Story = {
userId: 'test-user-abc-123',
recordId: null,
selectedRecordIds: [],
+ colorScheme: 'light',
},
},
play: async ({ canvasElement }) => {
diff --git a/packages/twenty-front-component-renderer/src/__stories__/UILibraries.stories.tsx b/packages/twenty-front-component-renderer/src/__stories__/UILibraries.stories.tsx
index 9829d956608..f49aa4b858f 100644
--- a/packages/twenty-front-component-renderer/src/__stories__/UILibraries.stories.tsx
+++ b/packages/twenty-front-component-renderer/src/__stories__/UILibraries.stories.tsx
@@ -20,6 +20,7 @@ const meta: Meta<typeof FrontComponentRenderer> = {
userId: null,
recordId: null,
selectedRecordIds: [],
+ colorScheme: 'light',
},
},
beforeEach: () => {
diff --git a/packages/twenty-front-component-renderer/src/__stories__/shared/test-utils/createFrontComponentStoryMeta.ts b/packages/twenty-front-component-renderer/src/__stories__/shared/test-utils/createFrontComponentStoryMeta.ts
index 2c3def8305e..90db4eab3a6 100644
--- a/packages/twenty-front-component-renderer/src/__stories__/shared/test-utils/createFrontComponentStoryMeta.ts
+++ b/packages/twenty-front-component-renderer/src/__stories__/shared/test-utils/createFrontComponentStoryMeta.ts
@@ -27,6 +27,7 @@ export const FRONT_COMPONENT_STORY_DEFAULT_ARGS: NonNullable<
userId: null,
recordId: null,
selectedRecordIds: [],
+ colorScheme: 'light',
},
colorScheme: 'light',
frontComponentHostCommunicationApi: hostApiMocks,
diff --git a/packages/twenty-front-component-renderer/src/__stories__/shared/test-utils/runFrontComponentStory.ts b/packages/twenty-front-component-renderer/src/__stories__/shared/test-utils/runFrontComponentStory.ts
index be2dfbca362..cb1447db624 100644
--- a/packages/twenty-front-component-renderer/src/__stories__/shared/test-utils/runFrontComponentStory.ts
+++ b/packages/twenty-front-component-renderer/src/__stories__/shared/test-utils/runFrontComponentStory.ts
@@ -23,6 +23,7 @@ export const runFrontComponentStory = ({
userId: null,
recordId: null,
selectedRecordIds: [],
+ colorScheme: 'light',
},
},
play,
diff --git a/packages/twenty-front-component-renderer/src/types/FrontComponentExecutionContext.ts b/packages/twenty-front-component-renderer/src/types/FrontComponentExecutionContext.ts
index dea0e745db8..ab6282a834d 100644
--- a/packages/twenty-front-component-renderer/src/types/FrontComponentExecutionContext.ts
+++ b/packages/twenty-front-component-renderer/src/types/FrontComponentExecutionContext.ts
@@ -7,4 +7,6 @@ export type FrontComponentExecutionContext = {
recordId: string | null;
/** All selected record IDs */
selectedRecordIds: string[];
+ /** Resolved color scheme of the host UI ('System' is already resolved) */
+ colorScheme: 'light' | 'dark';
};
diff --git a/packages/twenty-front/src/modules/front-components/components/FrontComponentRenderer.tsx b/packages/twenty-front/src/modules/front-components/components/FrontComponentRenderer.tsx
index 9b9d173c065..0eebb915736 100644
--- a/packages/twenty-front/src/modules/front-components/components/FrontComponentRenderer.tsx
+++ b/packages/twenty-front/src/modules/front-components/components/FrontComponentRenderer.tsx
@@ -39,6 +39,7 @@ export const FrontComponentRenderer = ({
frontComponentId,
commandMenuItemId,
selectedRecordIds,
+ colorScheme,
});
const handleError = useCallback(
diff --git a/packages/twenty-front/src/modules/front-components/hooks/__tests__/useFrontComponentExecutionContext.test.tsx b/packages/twenty-front/src/modules/front-components/hooks/__tests__/useFrontComponentExecutionContext.test.tsx
index 38ae9056fea..2ac67f0e6c3 100644
--- a/packages/twenty-front/src/modules/front-components/hooks/__tests__/useFrontComponentExecutionContext.test.tsx
+++ b/packages/twenty-front/src/modules/front-components/hooks/__tests__/useFrontComponentExecutionContext.test.tsx
@@ -93,11 +93,18 @@ jest.mock('~/hooks/useCopyToClipboard', () => ({
}));
const renderUseFrontComponentExecutionContext = (
- params: Parameters<typeof useFrontComponentExecutionContext>[0],
+ params: Omit<
+ Parameters<typeof useFrontComponentExecutionContext>[0],
+ 'colorScheme'
+ > & { colorScheme?: 'light' | 'dark' },
) =>
- renderHook(() => useFrontComponentExecutionContext(params), {
- wrapper: ({ children }) => I18nProvider({ i18n, children }),
- });
+ renderHook(
+ () =>
+ useFrontComponentExecutionContext({ colorScheme: 'light', ...params }),
+ {
+ wrapper: ({ children }) => I18nProvider({ i18n, children }),
+ },
+ );
const FRONT_COMPONENT_ID = 'fc-test-id';
const COMMAND_MENU_ITEM_ID = 'cmd-item-1';
@@ -120,6 +127,7 @@ describe('useFrontComponentExecutionContext', () => {
userId: 'user-123',
recordId: 'record-456',
selectedRecordIds: ['record-456'],
+ colorScheme: 'light',
});
});
@@ -134,6 +142,7 @@ describe('useFrontComponentExecutionContext', () => {
userId: 'user-123',
recordId: null,
selectedRecordIds: ['record-1', 'record-2', 'record-3'],
+ colorScheme: 'light',
});
});
@@ -165,6 +174,15 @@ describe('useFrontComponentExecutionContext', () => {
expect(result.current.executionContext.recordId).toBeNull();
expect(result.current.executionContext.selectedRecordIds).toEqual([]);
});
+
+ it('should expose the provided colorScheme', () => {
+ const { result } = renderUseFrontComponentExecutionContext({
+ frontComponentId: FRONT_COMPONENT_ID,
+ colorScheme: 'dark',
+ });
+
+ expect(result.current.executionContext.colorScheme).toBe('dark');
+ });
});
describe('navigate', () => {
diff --git a/packages/twenty-front/src/modules/front-components/hooks/useFrontComponentExecutionContext.ts b/packages/twenty-front/src/modules/front-components/hooks/useFrontComponentExecutionContext.ts
index 58a2a04c11a..26b5f663714 100644
--- a/packages/twenty-front/src/modules/front-components/hooks/useFrontComponentExecutionContext.ts
+++ b/packages/twenty-front/src/modules/front-components/hooks/useFrontComponentExecutionContext.ts
@@ -32,10 +32,12 @@ export const useFrontComponentExecutionContext = ({
frontComponentId,
commandMenuItemId,
selectedRecordIds,
+ colorScheme,
}: {
frontComponentId: string;
commandMenuItemId?: string;
selectedRecordIds?: string[];
+ colorScheme: 'light' | 'dark';
}): {
executionContext: FrontComponentExecutionContext;
frontComponentHostCommunicationApi: FrontComponentHostCommunicationApi;
@@ -141,6 +143,7 @@ export const useFrontComponentExecutionContext = ({
userId: currentUser?.id ?? null,
recordId: selectedRecordIds?.length === 1 ? selectedRecordIds[0] : null,
selectedRecordIds: selectedRecordIds ?? [],
+ colorScheme,
};
const unmountFrontComponent: FrontComponentHostCommunicationApi['unmountFrontComponent'] =
diff --git a/packages/twenty-sdk/src/sdk/front-component/hooks/useColorScheme.ts b/packages/twenty-sdk/src/sdk/front-component/hooks/useColorScheme.ts
new file mode 100644
index 00000000000..4b7555d728d
--- /dev/null
+++ b/packages/twenty-sdk/src/sdk/front-component/hooks/useColorScheme.ts
@@ -0,0 +1,10 @@
+import { type FrontComponentExecutionContext } from '../types/FrontComponentExecutionContext';
+import { useFrontComponentExecutionContext } from './useFrontComponentExecutionContext';
+
+const selectColorScheme = (
+ context: FrontComponentExecutionContext,
+): 'light' | 'dark' => context.colorScheme;
+
+export const useColorScheme = (): 'light' | 'dark' => {
+ return useFrontComponentExecutionContext(selectColorScheme);
+};
diff --git a/packages/twenty-sdk/src/sdk/front-component/index.ts b/packages/twenty-sdk/src/sdk/front-component/index.ts
index 750cfeea1e7..c03ac6da7b8 100644
--- a/packages/twenty-sdk/src/sdk/front-component/index.ts
+++ b/packages/twenty-sdk/src/sdk/front-component/index.ts
@@ -7,6 +7,7 @@ export { openCommandConfirmationModal } from './functions/openCommandConfirmatio
export { openSidePanelPage } from './functions/openSidePanelPage';
export { unmountFrontComponent } from './functions/unmountFrontComponent';
export { updateProgress } from './functions/updateProgress';
+export { useColorScheme } from './hooks/useColorScheme';
export { useFrontComponentExecutionContext } from './hooks/useFrontComponentExecutionContext';
export { useFrontComponentId } from './hooks/useFrontComponentId';
export { useRecordId } from './hooks/useRecordId';
diff --git a/packages/twenty-sdk/src/sdk/front-component/types/FrontComponentExecutionContext.ts b/packages/twenty-sdk/src/sdk/front-component/types/FrontComponentExecutionContext.ts
index dea0e745db8..ab6282a834d 100644
--- a/packages/twenty-sdk/src/sdk/front-component/types/FrontComponentExecutionContext.ts
+++ b/packages/twenty-sdk/src/sdk/front-component/types/FrontComponentExecutionContext.ts
@@ -7,4 +7,6 @@ export type FrontComponentExecutionContext = {
recordId: string | null;
/** All selected record IDs */
selectedRecordIds: string[];
+ /** Resolved color scheme of the host UI ('System' is already resolved) */
+ colorScheme: 'light' | 'dark';
};