Saltar al contenido principal
Un elemento del menú de navegación es una entrada en la barra lateral izquierda. Usa defineNavigationMenuItem() para distribuir enlaces personalizados en la barra lateral — normalmente uno por cada vista que publiques — o para apuntar a URL externas.
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,
});

Puntos clave

  • type determina a qué enlaza el elemento del menú. Cada tipo se asocia con un campo identificador específico:
    TipoQué haceCampo obligatorio
    NavigationMenuItemType.VIEWAbre una vista guardadaviewUniversalIdentifier
    NavigationMenuItemType.LINKAbre una URL externalink
    NavigationMenuItemType.FOLDERAgrupa elementos anidados bajo una etiquetaname (y los elementos secundarios hacen referencia a la carpeta mediante folderUniversalIdentifier)
    NavigationMenuItemType.OBJECTAbre la página de índice predeterminada de un objetotargetObjectUniversalIdentifier
    NavigationMenuItemType.PAGE_LAYOUTAbre un diseño de página independientepageLayoutUniversalIdentifier
  • position controla el orden en la barra lateral.
  • icon y color son opcionales y personalizan el aspecto de la entrada.
  • folderUniversalIdentifier también está disponible en cualquier elemento para anidarlo dentro de un elemento padre de tipo FOLDER.
Error común: crear un objeto sin una vista asociada y un elemento del menú de navegación hace que ese objeto sea invisible para los usuarios. A menos que sea un objeto técnico/interno, cada objeto personalizado debería tener una vista predeterminada y una entrada en la barra lateral que apunte a ella.