From be53fc5b015a3ada3dc1bcbf887942db85963c23 Mon Sep 17 00:00:00 2001 From: vvtimofeev <108340247+vvtimofeev@users.noreply.github.com> Date: Tue, 24 Dec 2024 15:20:07 +0300 Subject: [PATCH] docs: add ru readme (#341) --- README-ru.md | 38 ++++++++++++++++++++++++++++++++++++++ 1 file changed, 38 insertions(+) create mode 100644 README-ru.md diff --git a/README-ru.md b/README-ru.md new file mode 100644 index 0000000..1bec2ee --- /dev/null +++ b/README-ru.md @@ -0,0 +1,38 @@ +# @gravity-ui/navigation · [![npm package](https://img.shields.io/npm/v/@gravity-ui/navigation)](https://www.npmjs.com/package/@gravity-ui/navigation) [![CI](https://img.shields.io/github/actions/workflow/status/gravity-ui/navigation/.github/workflows/ci.yml?branch=main&label=CI&logo=github)](https://github.com/gravity-ui/navigation/actions/workflows/ci.yml?query=branch:main) [![storybook](https://img.shields.io/badge/Storybook-deployed-ff4685)](https://preview.yandexcloud.dev/navigation/) + +### Навигация в `Aside Header` · [Превью →](https://preview.yandexcloud.dev/navigation/) + +![](docs/images/showcase.png) + +## Установка + +```bash +npm install @gravity-ui/navigation +``` + +Убедитесь, что в проекте установлены peer-зависимости. + +```bash +npm install --dev @gravity-ui/uikit@^6.15.0 @gravity-ui/icons@2.2.0 @gravity-ui/components@3.0.0 @bem-react/classname@1.6.0 react@^18.0.0 react-dom@18.0.0 +``` + +## Компоненты + +- [AsideHeader](/src/components/AsideHeader/README.md) +- MobileHeader +- FooterItem +- MobileHeaderFooterItem +- [Drawer](/src/components/Drawer/README.md) +- DrawerItem +- PageLayout +- PageLayoutAside +- AsideFallback +- [Logo](/src/components/Logo/Readme.md) +- MobileLogo +- Footer +- MobileFooter +- [HotkeysPanel](/src/components/HotkeysPanel/README.md) + +## CSS-переменные + +Используются для тематизации компонентов навигации.