Salt la conținutul principal
Un element de meniu de navigare este o intrare în bara laterală din stânga. Folosiți defineNavigationMenuItem() pentru a livra linkuri personalizate în bara laterală — de obicei unul pentru fiecare vizualizare pe care o livrați — sau pentru a indica către URL-uri externe.
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,
});

Puncte cheie

  • type determină la ce face legătura elementul de meniu. Fiecare tip este asociat cu un câmp identificator specific:
    TipCe faceCâmp obligatoriu
    NavigationMenuItemType.VIEWDeschide o vizualizare salvatăviewUniversalIdentifier
    NavigationMenuItemType.LINKDeschide un URL externlink
    NavigationMenuItemType.FOLDERGrupează elementele îmbricate sub o etichetăname (iar elementele copil fac referire la dosar prin folderUniversalIdentifier)
    NavigationMenuItemType.OBJECTDeschide pagina implicită de index a unui obiecttargetObjectUniversalIdentifier
    NavigationMenuItemType.PAGE_LAYOUTDeschide un aranjament de pagină independentpageLayoutUniversalIdentifier
  • position controlează ordonarea în bara laterală.
  • icon și color sunt opționale și personalizează aspectul intrării.
  • folderUniversalIdentifier este de asemenea disponibil pe orice element pentru a-l îmbrica într-un părinte de tip FOLDER.
Capcană frecventă: crearea unui obiect fără o vizualizare asociată + element de meniu de navigare face ca acel obiect să fie invizibil pentru utilizatori. Dacă nu este un obiect tehnic/intern, fiecare obiect personalizat ar trebui să aibă o vizualizare implicită și o intrare în bara laterală care să indice către aceasta.