|
| 1 | +import type { ReactElement, ReactNode } from "react" |
| 2 | +import { useMounted } from "nextra/hooks" |
| 3 | +import { Heading } from "nextra" |
| 4 | +import { |
| 5 | + useConfig, |
| 6 | + useThemeConfig, |
| 7 | + SkipNavContent, |
| 8 | + Breadcrumb, |
| 9 | + NavLinks, |
| 10 | +} from "nextra-theme-docs" |
| 11 | +import { clsx } from "clsx" |
| 12 | + |
| 13 | +import { Sidebar } from "./sidebar" |
| 14 | +import { renderComponent } from "./utils" |
| 15 | +import { TableOfContents } from "./table-of-contents" |
| 16 | + |
| 17 | +const classes = { |
| 18 | + toc: clsx("nextra-toc order-last max-xl:hidden w-64 shrink-0 print:hidden"), |
| 19 | + main: clsx("w-full break-words"), |
| 20 | +} |
| 21 | + |
| 22 | +export interface NextraMdxWrapperProps { |
| 23 | + toc?: Heading[] |
| 24 | + children?: React.ReactNode |
| 25 | +} |
| 26 | + |
| 27 | +export function NextraMdxWrapper({ |
| 28 | + toc = [], |
| 29 | + children, |
| 30 | +}: NextraMdxWrapperProps) { |
| 31 | + const config = useConfig() |
| 32 | + const { |
| 33 | + activeType, |
| 34 | + activeThemeContext: themeContext, |
| 35 | + docsDirectories, |
| 36 | + directories, |
| 37 | + } = config.normalizePagesResult |
| 38 | + |
| 39 | + const tocEl = |
| 40 | + activeType === "page" || |
| 41 | + !themeContext.toc || |
| 42 | + themeContext.layout !== "default" ? ( |
| 43 | + themeContext.layout !== "full" && |
| 44 | + themeContext.layout !== "raw" && ( |
| 45 | + <nav className={classes.toc} aria-label="table of contents" /> |
| 46 | + ) |
| 47 | + ) : ( |
| 48 | + <nav className={classes.toc} aria-label="table of contents"> |
| 49 | + <TableOfContents toc={toc} filePath={config.filePath} /> |
| 50 | + </nav> |
| 51 | + ) |
| 52 | + return ( |
| 53 | + <div |
| 54 | + className={clsx( |
| 55 | + "mx-auto flex", |
| 56 | + themeContext.layout !== "raw" && "max-w-[90rem]", |
| 57 | + )} |
| 58 | + > |
| 59 | + <Sidebar |
| 60 | + docsDirectories={docsDirectories} |
| 61 | + fullDirectories={directories} |
| 62 | + toc={toc} |
| 63 | + asPopover={config.hideSidebar} |
| 64 | + includePlaceholder={themeContext.layout === "default"} |
| 65 | + /> |
| 66 | + {tocEl} |
| 67 | + <SkipNavContent /> |
| 68 | + <Body>{children}</Body> |
| 69 | + </div> |
| 70 | + ) |
| 71 | +} |
| 72 | + |
| 73 | +function Body({ children }: { children: ReactNode }): ReactElement { |
| 74 | + const config = useConfig() |
| 75 | + const themeConfig = useThemeConfig() |
| 76 | + const mounted = useMounted() |
| 77 | + const { |
| 78 | + activeThemeContext: themeContext, |
| 79 | + activeType, |
| 80 | + activeIndex, |
| 81 | + flatDocsDirectories, |
| 82 | + activePath, |
| 83 | + } = config.normalizePagesResult |
| 84 | + |
| 85 | + if (themeContext.layout === "raw") { |
| 86 | + return <div className={classes.main}>{children}</div> |
| 87 | + } |
| 88 | + |
| 89 | + const date = |
| 90 | + themeContext.timestamp && themeConfig.gitTimestamp && config.timestamp |
| 91 | + ? new Date(config.timestamp) |
| 92 | + : null |
| 93 | + |
| 94 | + const gitTimestampEl = |
| 95 | + // Because a user's time zone may be different from the server page |
| 96 | + mounted && date ? ( |
| 97 | + <div className="mb-8 mt-12 block text-xs text-neu-500 ltr:text-right rtl:text-left"> |
| 98 | + {renderComponent(themeConfig.gitTimestamp, { timestamp: date })} |
| 99 | + </div> |
| 100 | + ) : ( |
| 101 | + <div className="mt-16" /> |
| 102 | + ) |
| 103 | + |
| 104 | + const content = ( |
| 105 | + <> |
| 106 | + {renderComponent(themeContext.topContent)} |
| 107 | + {children} |
| 108 | + {gitTimestampEl} |
| 109 | + {renderComponent(themeContext.bottomContent)} |
| 110 | + {activeType !== "page" && themeContext.pagination && ( |
| 111 | + <NavLinks |
| 112 | + flatDocsDirectories={flatDocsDirectories} |
| 113 | + currentIndex={activeIndex} |
| 114 | + /> |
| 115 | + )} |
| 116 | + </> |
| 117 | + ) |
| 118 | + |
| 119 | + const body = themeConfig.main ? ( |
| 120 | + <themeConfig.main>{content}</themeConfig.main> |
| 121 | + ) : ( |
| 122 | + content |
| 123 | + ) |
| 124 | + |
| 125 | + if (themeContext.layout === "full") { |
| 126 | + return ( |
| 127 | + <article |
| 128 | + className={clsx( |
| 129 | + classes.main, |
| 130 | + "nextra-content min-h-[calc(100vh-var(--nextra-navbar-height))] pl-[max(env(safe-area-inset-left),1.5rem)] pr-[max(env(safe-area-inset-right),1.5rem)]", |
| 131 | + )} |
| 132 | + > |
| 133 | + {body} |
| 134 | + </article> |
| 135 | + ) |
| 136 | + } |
| 137 | + |
| 138 | + return ( |
| 139 | + <article |
| 140 | + className={clsx( |
| 141 | + classes.main, |
| 142 | + "nextra-content flex min-h-[calc(100vh-var(--nextra-navbar-height))] min-w-0 justify-center pb-8 pr-[calc(env(safe-area-inset-right)-1.5rem)]", |
| 143 | + themeContext.typesetting === "article" && |
| 144 | + "nextra-body-typesetting-article", |
| 145 | + )} |
| 146 | + > |
| 147 | + <main className="w-full min-w-0 max-w-6xl px-6 pt-4 md:px-12"> |
| 148 | + {activeType !== "page" && themeContext.breadcrumb && ( |
| 149 | + <Breadcrumb activePath={activePath} /> |
| 150 | + )} |
| 151 | + {body} |
| 152 | + </main> |
| 153 | + </article> |
| 154 | + ) |
| 155 | +} |
0 commit comments