概览

将你的应用嵌入 Twenty 的 UI 中——侧边栏条目、已保存视图、记录页面选项卡以及沙箱化的 React 组件。

Twenty 应用的布局层是用户看到的一切：应用在侧边栏中的呈现位置、它随附的列表视图、记录详情页的排布方式，以及在这些页面中渲染的自定义 React 组件。

   Sidebar               Record list            Record detail page
   ───────               ───────────            ──────────────────
   [📋 My View]    ────▶ ┌──────────┐          ┌─────────────────────┐
   [📋 Drafts ]          │ Companies│          │ Tabs: [Overview ]   │
   [📋 Inbox  ]          │ ──────── │          │       [Notes    ]   │
        ▲                │  Apple   │          │       [Hello    ]◀──── definePageLayoutTab
        │                │  Acme    │          │                     │   adds a tab...
        └ defineNavi-    │  …       │          │  ┌────────────────┐ │
          gationMenu-    └────▲─────┘          │  │                │ │
          Item points         │                │  │   React UI     │◀── …with a
          to a defineView     │                │  │  (sandboxed in │ │   defineFrontComponent
                              └ defineView     │  │   a Worker)    │ │   widget inside
                                picks columns  │  └────────────────┘ │
                                and filters    └─────────────────────┘

​

本节内容

视图

defineView — 已保存的列表配置：可见列、筛选器、分组。

导航菜单项

defineNavigationMenuItem — 指向视图或外部 URL 的侧边栏条目。

页面布局

definePageLayout 和 definePageLayoutTab — 记录详情页上的选项卡和小部件。

前端组件

defineFrontComponent — 在 Twenty 内部渲染的沙箱化 React 组件。

命令菜单项

defineCommandMenuItem — 将前端组件注册为 Cmd+K 条目和快速操作。

​

应用的呈现位置

呈现位置	控制内容	实体
侧边栏	链接到已保存视图或外部 URL 的自定义条目	defineNavigationMenuItem
记录列表	对象的已保存配置——可见列、顺序、筛选器、分组	defineView
记录详情页	记录页面上的选项卡和小部件（你自己的对象或标准对象）	definePageLayout, definePageLayoutTab
以上任意位置内部	自定义 React 小部件——按钮、表单、仪表盘、集成	defineFrontComponent
应用设置	位于应用“设置”选项卡中的自定义配置部分，用于替代默认的变量界面	defineSettingsFrontComponent
命令菜单（Cmd+K）	固定的快速操作或隐藏命令	defineCommandMenuItem

前端组件在使用 Remote DOM 的隔离 Web Worker 内运行——它们在页面中原生渲染（而不是在 iframe 中），但无法直接访问宿主页面或 DOM。 与 Twenty 的通信通过消息传递的宿主 API 完成。