[v3] add a generic for themeConfig to improve type inference (#3140)

shuding · Aug 24, 2024 · 7bb18e3 · 7bb18e3
1 parent 6945f38
commit 7bb18e3
Show file tree

Hide file tree

Showing 3 changed files with 15 additions and 5 deletions.
diff --git a/.changeset/poor-rings-shop.md b/.changeset/poor-rings-shop.md
@@ -0,0 +1,7 @@
+---
+'nextra-theme-blog': patch
+'nextra-theme-docs': patch
+'nextra': patch
+---
+
+Add a generic for `themeConfig` in `NextraThemeLayoutProps` to improve type inference.
diff --git a/packages/nextra-theme-blog/src/index.tsx b/packages/nextra-theme-blog/src/index.tsx
@@ -9,7 +9,7 @@ import { components, HeadingContext } from './mdx-theme'
 import Meta from './meta'
 import Nav from './nav'
 import { PostsLayout } from './posts-layout'
-import type { BlogFrontMatter } from './types'
+import type { BlogFrontMatter, NextraBlogTheme } from './types'
 import { isValidDate } from './utils/date'
 
 const layoutSet = new Set(['post', 'page', 'posts', 'tag'])
@@ -18,7 +18,7 @@ export default function NextraLayout({
   children,
   pageOpts,
   themeConfig
-}: NextraThemeLayoutProps<BlogFrontMatter>) {
+}: NextraThemeLayoutProps<BlogFrontMatter, NextraBlogTheme>) {
   const config = { ...DEFAULT_THEME, ...themeConfig }
 
   const ref = useRef<HTMLHeadingElement>(null)

diff --git a/packages/nextra/src/types.ts b/packages/nextra/src/types.ts
@@ -93,10 +93,13 @@ export type Nextra = (
 
 export type ThemeConfig = any | null
 
-export type NextraThemeLayoutProps<F = FrontMatter> = {
-  pageOpts: PageOpts<F>
+export type NextraThemeLayoutProps<
+  TFrontMatter = FrontMatter,
+  TThemeConfig = ThemeConfig
+> = {
+  pageOpts: PageOpts<TFrontMatter>
   pageProps: any
-  themeConfig: ThemeConfig
+  themeConfig: TThemeConfig
   children: ReactNode
 }