Skip to content

Commit f78e7f3

Browse files
committed
jsdocs
1 parent 20c76ef commit f78e7f3

1 file changed

Lines changed: 16 additions & 0 deletions

File tree

packages/next/src/layouts/Root/index.tsx

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,22 @@ export const metadata = {
3535
type RootLayoutProps = {
3636
readonly children: React.ReactNode
3737
readonly config: Promise<SanitizedConfig>
38+
/**
39+
* Custom content to render inside the admin panel's `<head>` element.
40+
*
41+
* Use this to inject scripts, meta tags, or links — for example, analytics
42+
* snippets via `next/script`, custom favicons, or preconnect hints.
43+
*
44+
* @example
45+
* ```tsx
46+
* import Script from 'next/script'
47+
*
48+
* <RootLayout
49+
* head={<Script src="https://example.com/analytics.js" strategy="afterInteractive" />}
50+
* {...rest}
51+
* />
52+
* ```
53+
*/
3854
readonly head?: React.ReactNode
3955
readonly htmlProps?: React.HtmlHTMLAttributes<HTMLHtmlElement>
4056
readonly importMap: ImportMap

0 commit comments

Comments
 (0)