Макет

Concept	What it controls	Сущность
View	A saved list configuration for an object — visible fields, order, filters, groups	`defineView`
Navigation Menu Item	An entry in the left sidebar that links to a view or an external URL	`defineNavigationMenuItem`
Page Layout	The tabs and widgets that make up a record’s detail page	`definePageLayout`

defineView

Определяйте сохранённые представления для объектов

Представления — это сохранённые конфигурации отображения записей объекта: какие поля видны, их порядок, а также применённые фильтры и группы. Используйте defineView() для поставки преднастроенных представлений вместе с вашим приложением:

src/views/example-view.ts

import { defineView, ViewKey } from 'twenty-sdk/define';
import { EXAMPLE_OBJECT_UNIVERSAL_IDENTIFIER } from '../objects/example-object';
import { NAME_FIELD_UNIVERSAL_IDENTIFIER } from '../objects/example-object';

export default defineView({
  universalIdentifier: 'a1b2c3d4-e5f6-7890-abcd-ef1234567890',
  name: 'All example items',
  objectUniversalIdentifier: EXAMPLE_OBJECT_UNIVERSAL_IDENTIFIER,
  icon: 'IconList',
  key: ViewKey.INDEX,
  position: 0,
  fields: [
    {
      universalIdentifier: 'f926bdb7-6af7-4683-9a09-adbca56c29f0',
      fieldMetadataUniversalIdentifier: NAME_FIELD_UNIVERSAL_IDENTIFIER,
      position: 0,
      isVisible: true,
      size: 200,
    },
  ],
});

Основные моменты:

objectUniversalIdentifier указывает, к какому объекту применяется это представление.
key определяет тип представления (например, ViewKey.INDEX для основного списка).
fields управляет тем, какие столбцы отображаются и в каком порядке. Каждое поле ссылается на fieldMetadataUniversalIdentifier.
Также вы можете определить filters, filterGroups, groups и fieldGroups для более продвинутых конфигураций.
position управляет порядком, когда для одного и того же объекта существует несколько представлений.

defineNavigationMenuItem

Определяйте ссылки боковой панели навигации

Пункты навигационного меню добавляют пользовательские элементы в боковую панель рабочего пространства. Используйте defineNavigationMenuItem() для ссылок на представления, внешние URL или объекты:

src/navigation-menu-items/example-navigation-menu-item.ts

import { defineNavigationMenuItem, NavigationMenuItemType } from 'twenty-sdk/define';
import { EXAMPLE_VIEW_UNIVERSAL_IDENTIFIER } from '../views/example-view';

export default defineNavigationMenuItem({
  universalIdentifier: '9327db91-afa1-41b6-bd9d-2b51a26efb4c',
  name: 'example-navigation-menu-item',
  icon: 'IconList',
  color: 'blue',
  position: 0,
  type: NavigationMenuItemType.VIEW,
  viewUniversalIdentifier: EXAMPLE_VIEW_UNIVERSAL_IDENTIFIER,
});

Основные моменты:

type определяет, на что ссылается пункт меню: NavigationMenuItemType.VIEW для сохранённого представления или NavigationMenuItemType.LINK для внешнего URL.
Для ссылок на представления укажите viewUniversalIdentifier. Для внешних ссылок укажите link.
position управляет порядком в боковой панели.
icon и color (необязательно) настраивают внешний вид.

definePageLayout

Определяйте пользовательские макеты страниц для представлений записей

Макеты страниц позволяют настраивать вид страницы с деталями записи: какие вкладки отображаются, какие виджеты внутри каждой вкладки и как они расположены. Используйте definePageLayout() для поставки пользовательских макетов вместе с вашим приложением:

src/page-layouts/example-record-page-layout.ts

import { definePageLayout, PageLayoutTabLayoutMode } from 'twenty-sdk/define';
import { EXAMPLE_OBJECT_UNIVERSAL_IDENTIFIER } from '../objects/example-object';
import { HELLO_WORLD_FRONT_COMPONENT_UNIVERSAL_IDENTIFIER } from '../front-components/hello-world';

export default definePageLayout({
  universalIdentifier: '203aeb94-6701-46d6-9af1-be2bbcc9e134',
  name: 'Example Record Page',
  type: 'RECORD_PAGE',
  objectUniversalIdentifier: EXAMPLE_OBJECT_UNIVERSAL_IDENTIFIER,
  tabs: [
    {
      universalIdentifier: '6ed26b60-a51d-4ad7-86dd-1c04c7f3cac5',
      title: 'Hello World',
      position: 50,
      icon: 'IconWorld',
      layoutMode: PageLayoutTabLayoutMode.CANVAS,
      widgets: [
        {
          universalIdentifier: 'aa4234e0-2e5f-4c02-a96a-573449e2351d',
          title: 'Hello World',
          type: 'FRONT_COMPONENT',
          configuration: {
            configurationType: 'FRONT_COMPONENT',
            frontComponentUniversalIdentifier:
              HELLO_WORLD_FRONT_COMPONENT_UNIVERSAL_IDENTIFIER,
          },
        },
      ],
    },
  ],
});

Основные моменты:

type обычно равен 'RECORD_PAGE' для настройки детального представления конкретного объекта.
objectUniversalIdentifier указывает, к какому объекту применяется этот макет.
Каждая tab определяет раздел страницы с title, position и layoutMode (CANVAS для свободного макета).
Каждый widget внутри вкладки может отображать компонент фронтенда, список связей или другие встроенные типы виджетов.
position у вкладок управляет их порядком. Используйте большие значения (например, 50), чтобы разместить пользовательские вкладки после встроенных.

Обзор

Приложения

API

Самостоятельный хостинг

Внести вклад

Layout concepts

​Layout concepts

Layout concepts