Skip to content

feat(AsideHeader): add collapseButtonWrapper prop #448

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jul 24, 2025
Merged

feat(AsideHeader): add collapseButtonWrapper prop #448

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
55 changes: 28 additions & 27 deletions src/components/AsideHeader/README-ru.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -118,33 +118,34 @@ export const Aside: FC = () => {

## Свойства

| Имя | Описание | Тип | Значение по умолчанию |
| :------------------------ | :--------------------------------------------------------------------------------------------------------------- | :-------------------------------------------------------------------------: | :-----------------------: |
| className | HTML-атрибут `class` для логотипа. | `string` | |
| collapseTitle | Заголовок `CollapseButton` для сворачивания элемента навигации. | `string` | `"Свернуть"` `"Collapse"` |
| compact | Визуальное состояние элемента навигации. | `boolean` | `false` |
| customBackground | Фон `AsideHeader`. | `React.ReactNode` | |
| customBackgroundClassName | Переопределяет стили контейнера фона по умолчанию. | `string` | |
| expandTitle | Заголовок `CollapseButton` для разворачивания элемента навигации. | `string` | `"Развернуть"` `"Expand"` |
| headerDecoration | Цвет фона верхнего блока с элементами логотипа и подзаголовка. | `boolean` | `false` |
| hideCollapseButton | Скрывает `CollapseButton`. Для установки дефолтного состояния элемента навигации используйте свойство `compact`. | `boolean` | `false` |
| logo | Контейнер логотипа, включающий иконку с заголовком и обрабатывающий клики. | [`Logo`](./../Logo/Readme.md#logo) | |
| menuItems | Элементы в среднем блоке навигации. | `Array<MenuItem>` | `[]` |
| menuMoreTitle | Дополнительный заголовок для `menuItems`, если элементы не помещаются. | `string` | `"Ещё"` `"More"` |
| multipleTooltip | Отображает несколько тултипов при наведении на элементы меню (`menuItems`) в свернутом состоянии. | `boolean` | `false` |
| onChangeCompact | Обратный вызов, срабатывающий при изменении визуального состояния элемента навигации. | `(compact: boolean) => void;` | |
| onClosePanel | Обратный вызов, срабатывающий при закрытии панели. Панели можно добавлять через свойство `PanelItems`. | `() => void;` | |
| onMenuItemsChanged | Обратный вызов, срабатывающий при изменении списка `menuItems` в `AllPagesPanel`. | `(items: Array<MenuItem>) => void` | |
| onMenuMoreClick | Обратный вызов, срабатывающий при нажатии кнопки **More** («Еще»), если часть элементов скрыта. | `() => void;` | |
| onAllPagesClick | Обратный вызов, срабатывающий при нажатии кнопки **All pages** («Все станицы»). | `() => void;` | |
| openModalSubscriber | Функция для уведомления `AsideHeader` об изменении состояния видимости модальных окон. | `( (open: boolean) => void) => void` | |
| panelItems | Элементы компонента `Drawer`. Используется для отображения дополнительной информации поверх основного контента. | [`Array<DrawerItem>`](./../Drawer/README.md#draweritem-props) | `[]` |
| renderContent | Функция рендеринга основного контента справа от `AsideHeader`. | `(data: {size: number}) => React.ReactNode` | |
| renderFooter | Функция рендеринга нижнего блока навигации. | `(data: {size: number}) => React.ReactNode` | |
| ref | Ссылка на якорь целевого всплывающего окна. | `React.ForwardedRef<HTMLDivElement, AsideHeaderProps>` | |
| subheaderItems | Элементы, расположенные под логотипом в верхнем блоке навигации. | ` Array<{item: MenuItem; enableTooltip?: boolean; bringForward?: boolean}>` | `[]` |
| topAlert | Контейнер над элементом навигации на основе компонента `Alert` из фреймворка UIKit. | `TopAlert` | |
| qa | Значение, которое будет передано в атрибут `data-qa` контейнера `AsideHeader`. | `string` | |
| Имя | Описание | Тип | Значение по умолчанию |
| :------------------------ | :--------------------------------------------------------------------------------------------------------------- | :---------------------------------------------------------------------------------------------------------------------------: | :-----------------------: |
| className | HTML-атрибут `class` для логотипа. | `string` | |
| collapseButtonWrapper | Обертка для `CollapseButton`, позволяющая кастомизировать вид дефолтной кнопки. | `(defaultButton: React.ReactNode, data: {compact: boolean; onChangeCompact?: (compact: boolean) => void}) => React.ReactNode` | |
| collapseTitle | Заголовок `CollapseButton` для сворачивания элемента навигации. | `string` | `"Свернуть"` `"Collapse"` |
| compact | Визуальное состояние элемента навигации. | `boolean` | `false` |
| customBackground | Фон `AsideHeader`. | `React.ReactNode` | |
| customBackgroundClassName | Переопределяет стили контейнера фона по умолчанию. | `string` | |
| expandTitle | Заголовок `CollapseButton` для разворачивания элемента навигации. | `string` | `"Развернуть"` `"Expand"` |
| headerDecoration | Цвет фона верхнего блока с элементами логотипа и подзаголовка. | `boolean` | `false` |
| hideCollapseButton | Скрывает `CollapseButton`. Для установки дефолтного состояния элемента навигации используйте свойство `compact`. | `boolean` | `false` |
| logo | Контейнер логотипа, включающий иконку с заголовком и обрабатывающий клики. | [`Logo`](./../Logo/Readme.md#logo) | |
| menuItems | Элементы в среднем блоке навигации. | `Array<MenuItem>` | `[]` |
| menuMoreTitle | Дополнительный заголовок для `menuItems`, если элементы не помещаются. | `string` | `"Ещё"` `"More"` |
| multipleTooltip | Отображает несколько тултипов при наведении на элементы меню (`menuItems`) в свернутом состоянии. | `boolean` | `false` |
| onChangeCompact | Обратный вызов, срабатывающий при изменении визуального состояния элемента навигации. | `(compact: boolean) => void;` | |
| onClosePanel | Обратный вызов, срабатывающий при закрытии панели. Панели можно добавлять через свойство `PanelItems`. | `() => void;` | |
| onMenuItemsChanged | Обратный вызов, срабатывающий при изменении списка `menuItems` в `AllPagesPanel`. | `(items: Array<MenuItem>) => void` | |
| onMenuMoreClick | Обратный вызов, срабатывающий при нажатии кнопки **More** («Еще»), если часть элементов скрыта. | `() => void;` | |
| onAllPagesClick | Обратный вызов, срабатывающий при нажатии кнопки **All pages** («Все станицы»). | `() => void;` | |
| openModalSubscriber | Функция для уведомления `AsideHeader` об изменении состояния видимости модальных окон. | `( (open: boolean) => void) => void` | |
| panelItems | Элементы компонента `Drawer`. Используется для отображения дополнительной информации поверх основного контента. | [`Array<DrawerItem>`](./../Drawer/README.md#draweritem-props) | `[]` |
| renderContent | Функция рендеринга основного контента справа от `AsideHeader`. | `(data: {size: number}) => React.ReactNode` | |
| renderFooter | Функция рендеринга нижнего блока навигации. | `(data: {size: number}) => React.ReactNode` | |
| ref | Ссылка на якорь целевого всплывающего окна. | `React.ForwardedRef<HTMLDivElement, AsideHeaderProps>` | |
| subheaderItems | Элементы, расположенные под логотипом в верхнем блоке навигации. | ` Array<{item: MenuItem; enableTooltip?: boolean; bringForward?: boolean}>` | `[]` |
| topAlert | Контейнер над элементом навигации на основе компонента `Alert` из фреймворка UIKit. | `TopAlert` | |
| qa | Значение, которое будет передано в атрибут `data-qa` контейнера `AsideHeader`. | `string` | |

### `MenuItem`

Expand Down
Loading
Loading