Skip to content

Commit 7301c59

Browse files
committed
DOCSTOOLS-2159 add navigation footer info
1 parent a7e12cf commit 7301c59

1 file changed

Lines changed: 31 additions & 3 deletions

File tree

ru/project/navigation.md

Lines changed: 31 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,11 @@
11
# Расширенная навигация
22

3-
Платформа поддерживает гибкую настройку верхней навигации («шапки») на странице.
3+
Платформа поддерживает гибкую настройку верхней и нижней навигации («шапки» и «подвала») на странице.
44
Для этого используется пакет [page-constructor](https://gravity-ui.com/libraries/page-constructor). В [StoryBook](https://preview.gravity-ui.com/page-constructor/?path=/docs/navigation-navigation--docs) можно ознакомиться с примерами конфигурации навигации.
55

6-
Блок конфигурации добавляется в `toc.yaml` следующим образом:
6+
## Верхнее меню {#header}
7+
8+
Конфигурация верхнего меню добавляется в `toc.yaml` следующим образом:
79

810
```yaml
911
navigation:
@@ -33,7 +35,7 @@ navigation:
3335
3436
Для элементов списков `leftItems` и `rightItems` *первого уровня* можно использовать условия вывода `when` и подстановки переменных по аналогии с [разделами оглавления](toc.md#when).
3537

36-
## Поддерживаемые элементы верхнего меню {#item-types}
38+
### Поддерживаемые элементы {#item-types}
3739

3840
Тип элемента указывается в свойстве `type`.
3941
На первом уровне доступны:
@@ -197,3 +199,29 @@ navigation:
197199
На первом уровне, в выпадающих списках, группах элементов и ссылок доступен элемент:
198200

199201
- `link` — ссылка, свойство `url` содержит текст ссылки; относительные ссылки всегда рассчитываются от корня проекта, на каком бы уровне ни находился ##toc.yaml##.
202+
203+
## Нижнее меню {#footer}
204+
205+
Конфигурация нижнего меню добавляется в `toc.yaml` следующим образом:
206+
207+
```yaml
208+
navigation:
209+
footer:
210+
copyright: 'Diplodoc'
211+
withDivider: true
212+
menuItems:
213+
- text: "GitHub"
214+
url: "https://github.com/diplodoc-platform"
215+
- text: "Для разработчиков"
216+
url: "https://diplodoc.com/docs/ru/dev/"
217+
target: '_self' # по умолчанию _blank
218+
```
219+
220+
Основные параметры:
221+
- `copyright` (строка) — текст копирайта для вывода,
222+
- `menuItems` — список ссылок, в котором каждая ссылка описывается следующими полями:
223+
- `text` — заголовок,
224+
- `url` — ссылка,
225+
- `target` (необязательный параметр) — для открытия ссылки в той-же вкладке браузера можно указать в этом поле значение `_self`.
226+
227+
Полный список поддерживаемых параметров можно найти на [странице компонента Footer на сайте Gravity UI](https://gravity-ui.com/ru/components/navigation/footer).

0 commit comments

Comments
 (0)