github-actions[bot]
95bc8aea28
Created by Github action Co-authored-by: github-actions <github-actions@twenty.com>
45 lines
4.1 KiB
Plaintext
45 lines
4.1 KiB
Plaintext
---
|
|
title: Элементы навигационного меню
|
|
description: Добавляйте на боковую панель рабочего пространства пользовательские элементы — ссылки на сохраненные представления или внешние URL-адреса.
|
|
icon: меню
|
|
---
|
|
|
|
**Элемент навигационного меню** — это запись в левой боковой панели. Используйте `defineNavigationMenuItem()` для добавления пользовательских ссылок на боковую панель — обычно по одной на каждое [представление](/l/ru/developers/extend/apps/layout/views), которое вы поставляете, — или для указания на внешние URL-адреса.
|
|
|
|
```ts 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`.
|
|
|
|
<Note>
|
|
**Распространенная ошибка:** создание объекта без связанного представления и элемента навигационного меню делает этот объект невидимым для пользователей. Если только это не технический/внутренний объект, у каждого настраиваемого объекта должно быть представление по умолчанию *и* элемент боковой панели, указывающий на него.
|
|
</Note>
|