asyavee/medusa-store
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity

docs: DX and performance improvements in API reference (#9430)

Browse Source 
- Improve scroll behavior between active sections
- Improve lag when clicking on a sidebar item
- Refactor internal working of the `SidebarProvider` to find active items faster.
- Use Next.js's `useRouter` hook for changing the hash (since they added the option to disable scroll)
- Change `isBrowser` from a hook to a provider since it's widely used across applications.
- Other general improvements and fixes.

Closes DOCS-952
This commit is contained in:
Shahed Nasser
2024-10-02 18:51:02 +03:00
committed by GitHub
parent 5fb9c1f82e
commit 0f6f56e764
38 changed files with 294 additions and 218 deletions
Download Patch File Download Diff File Expand all files Collapse all files

23
www/apps/ui/src/providers/index.tsx
View File

@@ -1,9 +1,6 @@
"use client"
import {
ColorModeProvider,
MobileProvider,
ModalProvider,
AnalyticsProvider,
ScrollControllerProvider,
SiteConfigProvider,
@@ -21,19 +18,13 @@ const Providers = ({ children }: ProvidersProps) => {
return (
<AnalyticsProvider writeKey={process.env.NEXT_PUBLIC_SEGMENT_API_KEY}>
<SiteConfigProvider config={siteConfig}>
<MobileProvider>
<ColorModeProvider>
<ModalProvider>
<ScrollControllerProvider scrollableSelector="#main">
<SidebarProvider>
<MainNavProvider>
<SearchProvider>{children}</SearchProvider>
</MainNavProvider>
</SidebarProvider>
</ScrollControllerProvider>
</ModalProvider>
</ColorModeProvider>
</MobileProvider>
<ScrollControllerProvider scrollableSelector="#main">
<SidebarProvider>
<MainNavProvider>
<SearchProvider>{children}</SearchProvider>
</MainNavProvider>
</SidebarProvider>
</ScrollControllerProvider>
</SiteConfigProvider>
</AnalyticsProvider>
)

2
www/apps/ui/src/providers/main-nav.tsx
View File

@@ -15,7 +15,7 @@ type MainNavProviderProps = {
}
export const MainNavProvider = ({ children }: MainNavProviderProps) => {
const isBrowser = useIsBrowser()
const { isBrowser } = useIsBrowser()
const navigationDropdownItems = useMemo(
() =>
getNavDropdownItems({