From b9205413f7ffe2ea163eca69e462e37b8ec6a6c3 Mon Sep 17 00:00:00 2001 From: Angelina Gadzhieva Date: Tue, 9 Jul 2024 19:39:21 +0300 Subject: [PATCH] docs: add readme for Logo, clean up main readme (#268) * docs: add readme for Logo, clean up main readme * chore: fix typo --- README.md | 73 +------------------------- src/components/AsideHeader/README.md | 78 +++++++++++++++++++++++++--- src/components/Logo/Readme.md | 22 ++++++++ 3 files changed, 94 insertions(+), 79 deletions(-) create mode 100644 src/components/Logo/Readme.md diff --git a/README.md b/README.md index 22893f5..b28960b 100644 --- a/README.md +++ b/README.md @@ -13,12 +13,12 @@ npm install @gravity-ui/navigation Ensure that peer dependencies are installed in your project ```bash -npm install --dev @gravity-ui/uikit@^3.0.2 @bem-react/classname@1.6.0 react@^16.0.0 +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 ``` ## Components -- AsideHeader +- [AsideHeader](/src/components/AsideHeader/README.md) - MobileHeader - FooterItem - MobileHeaderFooterItem @@ -32,75 +32,6 @@ npm install --dev @gravity-ui/uikit@^3.0.2 @bem-react/classname@1.6.0 react@^16. - Footer - MobileFooter -## Optimization - -If your app content needs to be rendered faster than by passing it throw `AsideHeader` props, -you may need to switch usage of `AsideHeader` to advanced style with `PageLayout` like this: - -```diff ---- Main.tsx -+++ Main.tsx --import {AsideHeader} from './AsideHeader' -+import {PageLayout, AsideFallback} from '@gravity-ui/navigation'; -+const Aside = React.lazy(() => -+ import('./Aside').then(({Aside}) => ({ default: Aside })) -+); - -- -+ -+ }> -+