Skip to content

The open alternative to Salesforce, designed for AI.

4.7 KB
Raw Blame
---
title: Overview
description: Place your app inside Twenty's UI — sidebar entries, saved views, record page tabs, and sandboxed React components.
---

import { PageBanner } from "/snippets/page-banner.mdx"
import { CardTitle } from "/snippets/card-title.mdx"

## What the layout layer covers

A Twenty app's **layout layer** is everything the user sees: where the app surfaces in the sidebar, which list views it ships, how its record detail pages are arranged, and which custom React components render inside those pages.

```text
   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    └─────────────────────┘
```

## In this section

<CardGroup cols={2} className="documentation-card-group">
  <Card href="/developers/extend/apps/layout/views" img="/images/documentation/section-overview-icons-v1/views-pipelines.svg">
    <CardTitle>Views</CardTitle>
    `defineView` — saved list configurations: visible columns, filters, groups.
  </Card>
  <Card href="/developers/extend/apps/layout/navigation-menu-items" img="/images/user-guide/halftone/card-page-navigation.svg">
    <CardTitle>Navigation Menu Items</CardTitle>
    `defineNavigationMenuItem` — sidebar entries pointing at views or external URLs.
  </Card>
  <Card href="/developers/extend/apps/layout/page-layouts" img="/images/user-guide/halftone/card-page-page-layouts.svg">
    <CardTitle>Page Layouts</CardTitle>
    `definePageLayout`, `definePageLayoutTab` and `definePageLayoutWidget` — tabs and widgets on a record's detail page.
  </Card>
  <Card href="/developers/extend/apps/layout/front-components" img="/images/user-guide/halftone/card-page-front-components.svg">
    <CardTitle>Front Components</CardTitle>
    `defineFrontComponent` — sandboxed React components that render inside Twenty.
  </Card>
  <Card href="/developers/extend/apps/layout/command-menu-items" img="/images/user-guide/halftone/card-page-command-menu.svg">
    <CardTitle>Command Menu Items</CardTitle>
    `defineCommandMenuItem` — register front components as Cmd+K entries and quick actions.
  </Card>
</CardGroup>

## Where the app surfaces

| Surface | What it controls | Entity |
|---------|------------------|--------|
| **Sidebar** | A custom entry linking to a saved view or external URL | `defineNavigationMenuItem` |
| **Record list** | A saved configuration for an object — visible columns, order, filters, groups | `defineView` |
| **Record detail page** | The tabs and widgets on a record page (your own object's, or a standard one) | `definePageLayout`, `definePageLayoutTab`, `definePageLayoutWidget` |
| **Inside any of the above** | A custom React widget — buttons, forms, dashboards, integrations | `defineFrontComponent` |
| **App settings** | An entry in the app's settings menu; declare as many as you need | `defineSettingsMenuItem` |
| **Command menu (Cmd+K)** | A pinned quick action or hidden command | `defineCommandMenuItem` |

Front components run inside an isolated Web Worker using Remote DOM — they render *natively* in the page (not inside an iframe), but cannot reach the host page or DOM directly. Communication with Twenty happens through a message-passing host API.

They are still under active development: the sandbox implements a partial DOM, so advanced usages can fail. See [Current limitations](/developers/extend/apps/layout/front-components#current-limitations).

<PageBanner illustration="section-apps-layout" />