The open alternative to Salesforce, designed for AI.
TypeScript crmcrm-systemcustomergood-first-issuegraphqlhacktoberfestjavascriptmarketingmonoreponestjsopen-sourcepostgresqlreactreactjssalestypescriptweb
docs(apps): fix nonexistent SDK import paths and unsupported config in layout pages (#22689)
martmull2781a06025b1
diff --git a/packages/twenty-docs/developers/extend/apps/layout/command-menu-items.mdx b/packages/twenty-docs/developers/extend/apps/layout/command-menu-items.mdxindex 7df707f70cc..4f7af8fae36 100644--- a/packages/twenty-docs/developers/extend/apps/layout/command-menu-items.mdx+++ b/packages/twenty-docs/developers/extend/apps/layout/command-menu-items.mdx@@ -13,7 +13,6 @@ export default defineCommandMenuItem({universalIdentifier: 'a1b2c3d4-e5f6-7890-abcd-ef1234567890',label: 'Open Dashboard',shortLabel: 'Dashboard',- icon: 'IconLayoutDashboard',isPinned: true,availabilityType: 'GLOBAL',frontComponentUniversalIdentifier: '74c526eb-cb68-4cf7-b05c-0dd8c288d948',@@ -28,9 +27,9 @@ export default defineCommandMenuItem({| `label` | Yes | Full label shown in the command menu (Cmd+K) || `frontComponentUniversalIdentifier` | Yes | The `universalIdentifier` of the front component this command opens || `shortLabel` | No | Shorter label displayed on the pinned quick-action button |-| `icon` | No | Icon name displayed next to the label (e.g. `'IconBolt'`, `'IconSend'`) |+| `icon` | No | **Deprecated** — ignored in favor of the application icon; the build emits a warning if set || `isPinned` | No | When `true`, shows the command as a quick-action button in the top-right corner of the page |-| `availabilityType` | No | Controls where the command appears: `'GLOBAL'` (always available), `'RECORD_SELECTION'` (only when records are selected), or `'FALLBACK'` (shown when no other commands match) |+| `availabilityType` | No | Controls where the command appears: `'GLOBAL'` (always available), `'GLOBAL_OBJECT_CONTEXT'` (only on pages with an object context — index and record pages), `'RECORD_SELECTION'` (only when records are selected), or `'FALLBACK'` (shown when no other commands match) || `availabilityObjectUniversalIdentifier` | No | Restrict the command to pages of a specific object type (e.g. only on Company records) || `conditionalAvailabilityExpression` | No | A boolean expression that dynamically controls visibility (see below) |@@ -38,35 +37,7 @@ export default defineCommandMenuItem({A command menu item paired with a [headless front component](/developers/extend/apps/layout/front-components#headless-vs-non-headless) is the idiomatic way to ship a one-click action — run code, navigate, or confirm and execute. The Front Components page covers the [SDK Command components](/developers/extend/apps/layout/front-components#sdk-command-components) (`Command`, `CommandLink`, `CommandModal`, `CommandOpenSidePanelPage`) that handle the action-and-unmount pattern.-A typical flow:--```tsx src/front-components/run-action.tsx-import { defineFrontComponent } from 'twenty-sdk/define';-import { Command } from 'twenty-sdk/command';-import { CoreApiClient } from 'twenty-sdk/clients';--const RunAction = () => {- const execute = async () => {- const client = new CoreApiClient();- await client.mutation({- createTask: {- __args: { data: { title: 'Created by my app' } },- id: true,- },- });- };-- return <Command execute={execute} />;-};--export default defineFrontComponent({- universalIdentifier: 'e5f6a7b8-c9d0-1234-efab-345678901234',- name: 'run-action',- description: 'Creates a task from the command menu',- component: RunAction,- isHeadless: true,-});-```+A typical flow: a headless component renders `<Command execute={...} />` (see the [full example](/developers/extend/apps/layout/front-components#sdk-command-components)), and the command menu item points at it:```ts src/command-menu-items/run-action.command-menu-item.tsimport { defineCommandMenuItem } from 'twenty-sdk/define';@@ -74,7 +45,6 @@ import { defineCommandMenuItem } from 'twenty-sdk/define';export default defineCommandMenuItem({universalIdentifier: 'f6a7b8c9-d0e1-2345-fabc-456789012345',label: 'Run my action',- icon: 'IconPlayerPlay',frontComponentUniversalIdentifier: 'e5f6a7b8-c9d0-1234-efab-345678901234',});```diff --git a/packages/twenty-docs/developers/extend/apps/layout/front-components.mdx b/packages/twenty-docs/developers/extend/apps/layout/front-components.mdxindex 8e86a30582a..967f85405ba 100644--- a/packages/twenty-docs/developers/extend/apps/layout/front-components.mdx+++ b/packages/twenty-docs/developers/extend/apps/layout/front-components.mdx@@ -49,14 +49,13 @@ export default defineCommandMenuItem({universalIdentifier: 'd4e5f6a7-b8c9-0123-defa-456789012345',shortLabel: 'Hello',label: 'Hello World',- icon: 'IconBolt',isPinned: true,availabilityType: 'GLOBAL',frontComponentUniversalIdentifier: '74c526eb-cb68-4cf7-b05c-0dd8c288d948',});```-After syncing with `yarn twenty dev` (or running a one-shot `yarn twenty dev --once`), the quick action appears in the top-right corner of the page:+After syncing with `yarn twenty dev` (or running a one-shot `yarn twenty apply`), the quick action appears in the top-right corner of the page:<div style={{textAlign: 'center'}}><img src="/images/docs/developers/extends/apps/quick-action.png" alt="Quick action button in the top-right corner" />@@ -88,11 +87,11 @@ Front components come in two rendering modes controlled by the `isHeadless` opti```tsx src/front-components/sync-tracker.tsximport { defineFrontComponent } from 'twenty-sdk/define';-import { useRecordId, enqueueSnackbar } from 'twenty-sdk/front-component';+import { useSelectedRecordIds, enqueueSnackbar } from 'twenty-sdk/front-component';import { useEffect } from 'react';const SyncTracker = () => {- const recordId = useRecordId();+ const [recordId] = useSelectedRecordIds();useEffect(() => {enqueueSnackbar({ message: `Tracking record ${recordId}`, variant: 'info' });@@ -116,7 +115,7 @@ Because the component returns `null`, Twenty skips rendering a container for itThe `twenty-sdk` package provides four Command helper components designed for headless front components. Each component executes an action on mount, handles errors by showing a snackbar notification, and automatically unmounts the front component when done.-Import them from `twenty-sdk/command`:+Import them from `twenty-sdk/front-component`:- **`Command`** — Runs an async callback via the `execute` prop.- **`CommandLink`** — Navigates to an app path. Props: `to`, `params`, `queryParams`, `options`.@@ -127,8 +126,8 @@ Here is a full example of a headless front component using `Command` to run an a```tsx src/front-components/run-action.tsximport { defineFrontComponent } from 'twenty-sdk/define';-import { Command } from 'twenty-sdk/command';-import { CoreApiClient } from 'twenty-sdk/clients';+import { Command } from 'twenty-sdk/front-component';+import { CoreApiClient } from 'twenty-client-sdk/core';const RunAction = () => {const execute = async () => {@@ -160,7 +159,6 @@ import { defineCommandMenuItem } from 'twenty-sdk/define';export default defineCommandMenuItem({universalIdentifier: 'f6a7b8c9-d0e1-2345-fabc-456789012345',label: 'Run my action',- icon: 'IconPlayerPlay',frontComponentUniversalIdentifier: 'e5f6a7b8-c9d0-1234-efab-345678901234',});```@@ -169,7 +167,7 @@ And an example using `CommandModal` to ask for confirmation before executing:```tsx src/front-components/delete-draft.tsximport { defineFrontComponent } from 'twenty-sdk/define';-import { CommandModal } from 'twenty-sdk/command';+import { CommandModal } from 'twenty-sdk/front-component';const DeleteDraft = () => {const execute = async () => {@@ -212,7 +210,7 @@ A headless front component can run the call on mount via the `Command` component```tsx src/front-components/sync-prs.tsximport { defineFrontComponent } from 'twenty-sdk/define';-import { Command } from 'twenty-sdk/command';+import { Command } from 'twenty-sdk/front-component';const SyncPrs = () => {const execute = async () => {@@ -316,13 +314,13 @@ Inside your component, use SDK hooks to access the current user, record, and comimport { defineFrontComponent } from 'twenty-sdk/define';import {useUserId,- useRecordId,+ useSelectedRecordIds,useFrontComponentId,} from 'twenty-sdk/front-component';const RecordInfo = () => {const userId = useUserId();- const recordId = useRecordId();+ const [recordId] = useSelectedRecordIds();const componentId = useFrontComponentId();return (@@ -405,12 +403,11 @@ Here is an example that uses the host API to show a snackbar and close the side```tsx src/front-components/archive-record.tsximport { defineFrontComponent } from 'twenty-sdk/define';-import { useRecordId } from 'twenty-sdk/front-component';-import { enqueueSnackbar, closeSidePanel } from 'twenty-sdk/front-component';-import { CoreApiClient } from 'twenty-sdk/clients';+import { enqueueSnackbar, closeSidePanel, useSelectedRecordIds } from 'twenty-sdk/front-component';+import { CoreApiClient } from 'twenty-client-sdk/core';const ArchiveRecord = () => {- const recordId = useRecordId();+ const [recordId] = useSelectedRecordIds();const handleArchive = async () => {const client = new CoreApiClient();@@ -451,10 +448,10 @@ export default defineFrontComponent({Use `useSelectedRecordIds()` to handle multiple selected records. This is useful for bulk operations:```tsx src/front-components/bulk-export.tsx-import { defineFrontComponent, numberOfSelectedRecords } from 'twenty-sdk/define';+import { defineFrontComponent } from 'twenty-sdk/define';import { useSelectedRecordIds } from 'twenty-sdk/front-component';import { enqueueSnackbar, closeSidePanel } from 'twenty-sdk/front-component';-import { CoreApiClient } from 'twenty-sdk/clients';+import { CoreApiClient } from 'twenty-client-sdk/core';const BulkExport = () => {const selectedRecordIds = useSelectedRecordIds();@@ -492,12 +489,19 @@ export default defineFrontComponent({name: 'bulk-export',description: 'Export selected records',component: BulkExport,- command: {- universalIdentifier: 'd0e1f2a3-b4c5-6789-defa-012345678902',- label: 'Bulk Export',- availabilityType: 'RECORD_SELECTION',- conditionalAvailabilityExpression: numberOfSelectedRecords > 0,- },+});+```++Surface it with a [command menu item](/developers/extend/apps/layout/command-menu-items) restricted to record selections:++```ts src/command-menu-items/bulk-export.command-menu-item.ts+import { defineCommandMenuItem } from 'twenty-sdk/define';++export default defineCommandMenuItem({+ universalIdentifier: 'd0e1f2a3-b4c5-6789-defa-012345678902',+ label: 'Bulk Export',+ availabilityType: 'RECORD_SELECTION',+ frontComponentUniversalIdentifier: 'd0e1f2a3-b4c5-6789-defa-012345678901',});```