Перейти к основному содержанию
Элемент навигационного меню — это запись в левой боковой панели. Используйте 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Открывает сохраненное представлениеviewUniversalIdentifier
    NavigationMenuItemType.LINKОткрывает внешний URL-адресlink
    NavigationMenuItemType.FOLDERГруппирует вложенные элементы под меткойname (а дочерние элементы ссылаются на папку через folderUniversalIdentifier)
    NavigationMenuItemType.OBJECTОткрывает страницу индекса по умолчанию объектаtargetObjectUniversalIdentifier
    NavigationMenuItemType.PAGE_LAYOUTОткрывает отдельный макет страницыpageLayoutUniversalIdentifier
  • position управляет порядком в боковой панели.
  • icon и color являются необязательными и настраивают внешний вид элемента.
  • folderUniversalIdentifier также доступен для любого элемента, чтобы поместить его внутрь родительского элемента типа FOLDER.
Распространенная ошибка: создание объекта без связанного представления и элемента навигационного меню делает этот объект невидимым для пользователей. Если только это не технический/внутренний объект, у каждого настраиваемого объекта должно быть представление по умолчанию и элемент боковой панели, указывающий на него.