@hanzo/docs-base-ui 16.5.3 → 16.7.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (371) hide show
  1. package/css/generated/docs.css +68 -33
  2. package/css/generated/flux.css +44 -34
  3. package/css/generated/home.css +88 -4
  4. package/css/generated/notebook.css +65 -31
  5. package/css/generated/shared.css +199 -59
  6. package/css/lib/base.css +1 -4
  7. package/css/lib/shiki.css +49 -41
  8. package/css/preset.css +3 -0
  9. package/dist/_virtual/_rolldown/runtime.js +6 -11
  10. package/dist/components/accordion.d.ts +1 -2
  11. package/dist/components/accordion.js +3 -7
  12. package/dist/components/banner.d.ts +1 -2
  13. package/dist/components/banner.js +1 -5
  14. package/dist/components/callout.d.ts +1 -2
  15. package/dist/components/callout.js +0 -3
  16. package/dist/components/card.d.ts +1 -2
  17. package/dist/components/card.js +0 -3
  18. package/dist/components/codeblock.d.ts +1 -2
  19. package/dist/components/codeblock.js +2 -6
  20. package/dist/components/codeblock.rsc.d.ts +21 -0
  21. package/dist/components/codeblock.rsc.js +22 -0
  22. package/dist/components/dialog/search-algolia.d.ts +1 -3
  23. package/dist/components/dialog/search-algolia.js +1 -5
  24. package/dist/components/dialog/search-default.d.ts +1 -3
  25. package/dist/components/dialog/search-default.js +1 -5
  26. package/dist/components/dialog/search-orama.d.ts +1 -3
  27. package/dist/components/dialog/search-orama.js +1 -5
  28. package/dist/components/dialog/search.d.ts +5 -5
  29. package/dist/components/dialog/search.js +124 -47
  30. package/dist/components/dynamic-codeblock.core.d.ts +7 -5
  31. package/dist/components/dynamic-codeblock.core.js +17 -32
  32. package/dist/components/dynamic-codeblock.d.ts +5 -3
  33. package/dist/components/dynamic-codeblock.js +8 -13
  34. package/dist/components/files.d.ts +1 -2
  35. package/dist/components/files.js +4 -8
  36. package/dist/components/github-info.d.ts +22 -9
  37. package/dist/components/github-info.js +33 -28
  38. package/dist/components/heading.d.ts +1 -2
  39. package/dist/components/heading.js +2 -5
  40. package/dist/components/image-zoom.d.ts +1 -2
  41. package/dist/components/image-zoom.js +2 -5
  42. package/dist/components/inline-toc.d.ts +1 -2
  43. package/dist/components/inline-toc.js +1 -5
  44. package/dist/components/sidebar/base.d.ts +7 -3
  45. package/dist/components/sidebar/base.js +6 -16
  46. package/dist/components/sidebar/link-item.d.ts +2 -3
  47. package/dist/components/sidebar/link-item.js +6 -3
  48. package/dist/components/sidebar/page-tree.d.ts +1 -2
  49. package/dist/components/sidebar/page-tree.js +54 -43
  50. package/dist/components/sidebar/tabs/dropdown.d.ts +4 -7
  51. package/dist/components/sidebar/tabs/dropdown.js +4 -11
  52. package/dist/components/sidebar/tabs/index.d.ts +3 -17
  53. package/dist/components/sidebar/tabs/index.js +0 -3
  54. package/dist/components/steps.d.ts +1 -2
  55. package/dist/components/steps.js +0 -3
  56. package/dist/components/tabs.d.ts +11 -7
  57. package/dist/components/tabs.js +13 -18
  58. package/dist/components/toc/clerk.d.ts +9 -2
  59. package/dist/components/toc/clerk.js +117 -62
  60. package/dist/components/toc/default.d.ts +9 -2
  61. package/dist/components/toc/default.js +28 -21
  62. package/dist/components/toc/index.d.ts +8 -5
  63. package/dist/components/toc/index.js +50 -25
  64. package/dist/components/type-table.d.ts +10 -5
  65. package/dist/components/type-table.js +22 -17
  66. package/dist/components/ui/accordion.d.ts +1 -2
  67. package/dist/components/ui/accordion.js +1 -5
  68. package/dist/components/ui/button.d.ts +2 -3
  69. package/dist/components/ui/button.js +0 -3
  70. package/dist/components/ui/collapsible.d.ts +1 -2
  71. package/dist/components/ui/collapsible.js +2 -6
  72. package/dist/components/ui/navigation-menu.d.ts +26 -12
  73. package/dist/components/ui/navigation-menu.js +52 -30
  74. package/dist/components/ui/popover.d.ts +10 -5
  75. package/dist/components/ui/popover.js +14 -18
  76. package/dist/components/ui/scroll-area.d.ts +17 -7
  77. package/dist/components/ui/scroll-area.js +26 -30
  78. package/dist/components/ui/tabs.d.ts +1 -2
  79. package/dist/components/ui/tabs.js +1 -5
  80. package/dist/contexts/i18n.d.ts +7 -5
  81. package/dist/contexts/i18n.js +3 -8
  82. package/dist/contexts/search.d.ts +2 -2
  83. package/dist/contexts/search.js +4 -6
  84. package/dist/contexts/tree.d.ts +1 -2
  85. package/dist/contexts/tree.js +1 -5
  86. package/dist/i18n.d.ts +16 -9
  87. package/dist/i18n.js +14 -14
  88. package/dist/layouts/docs/client.d.ts +30 -29
  89. package/dist/layouts/docs/client.js +72 -48
  90. package/dist/layouts/docs/index.d.ts +19 -33
  91. package/dist/layouts/docs/index.js +16 -172
  92. package/dist/layouts/docs/page/index.d.ts +67 -55
  93. package/dist/layouts/docs/page/index.js +74 -54
  94. package/dist/layouts/docs/page/slots/breadcrumb.d.ts +14 -0
  95. package/dist/layouts/docs/page/slots/breadcrumb.js +44 -0
  96. package/dist/layouts/docs/page/slots/container.d.ts +7 -0
  97. package/dist/layouts/docs/page/slots/container.js +17 -0
  98. package/dist/layouts/docs/page/slots/footer.d.ts +23 -0
  99. package/dist/layouts/docs/page/slots/footer.js +56 -0
  100. package/dist/layouts/docs/page/slots/toc.d.ts +55 -0
  101. package/dist/layouts/docs/page/slots/toc.js +166 -0
  102. package/dist/layouts/docs/slots/container.d.ts +7 -0
  103. package/dist/layouts/docs/slots/container.js +29 -0
  104. package/dist/layouts/docs/slots/header.d.ts +8 -0
  105. package/dist/layouts/docs/slots/header.js +38 -0
  106. package/dist/layouts/docs/slots/sidebar.d.ts +30 -0
  107. package/dist/layouts/docs/slots/sidebar.js +319 -0
  108. package/dist/layouts/flux/index.d.ts +34 -39
  109. package/dist/layouts/flux/index.js +77 -99
  110. package/dist/layouts/flux/page/index.d.ts +56 -49
  111. package/dist/layouts/flux/page/index.js +63 -35
  112. package/dist/layouts/flux/page/slots/breadcrumb.d.ts +14 -0
  113. package/dist/layouts/flux/page/slots/breadcrumb.js +44 -0
  114. package/dist/layouts/flux/page/slots/container.d.ts +7 -0
  115. package/dist/layouts/flux/page/slots/container.js +17 -0
  116. package/dist/layouts/flux/page/slots/footer.d.ts +23 -0
  117. package/dist/layouts/flux/page/slots/footer.js +56 -0
  118. package/dist/layouts/flux/page/slots/toc.d.ts +34 -0
  119. package/dist/layouts/flux/page/slots/toc.js +172 -0
  120. package/dist/layouts/flux/slots/container.d.ts +7 -0
  121. package/dist/layouts/flux/slots/container.js +13 -0
  122. package/dist/layouts/flux/slots/sidebar.d.ts +23 -0
  123. package/dist/layouts/flux/{sidebar.js → slots/sidebar.js} +74 -34
  124. package/dist/layouts/flux/slots/tab-dropdown.d.ts +17 -0
  125. package/dist/layouts/flux/{tab-dropdown.js → slots/tab-dropdown.js} +13 -24
  126. package/dist/layouts/home/index.d.ts +24 -7
  127. package/dist/layouts/home/index.js +39 -19
  128. package/dist/layouts/home/navbar.d.ts +5 -14
  129. package/dist/layouts/home/navbar.js +10 -12
  130. package/dist/layouts/home/not-found.d.ts +9 -0
  131. package/dist/layouts/home/not-found.js +38 -0
  132. package/dist/layouts/home/slots/container.d.ts +7 -0
  133. package/dist/layouts/home/slots/container.js +13 -0
  134. package/dist/layouts/home/slots/header.d.ts +11 -0
  135. package/dist/layouts/home/slots/header.js +242 -0
  136. package/dist/layouts/notebook/client.d.ts +32 -44
  137. package/dist/layouts/notebook/client.js +57 -147
  138. package/dist/layouts/notebook/index.d.ts +25 -24
  139. package/dist/layouts/notebook/index.js +16 -212
  140. package/dist/layouts/notebook/page/index.d.ts +67 -55
  141. package/dist/layouts/notebook/page/index.js +74 -54
  142. package/dist/layouts/notebook/page/slots/breadcrumb.d.ts +14 -0
  143. package/dist/layouts/notebook/page/slots/breadcrumb.js +44 -0
  144. package/dist/layouts/notebook/page/slots/container.d.ts +7 -0
  145. package/dist/layouts/notebook/page/slots/container.js +17 -0
  146. package/dist/layouts/notebook/page/slots/footer.d.ts +23 -0
  147. package/dist/layouts/notebook/page/slots/footer.js +56 -0
  148. package/dist/layouts/notebook/page/slots/toc.d.ts +55 -0
  149. package/dist/layouts/notebook/page/slots/toc.js +165 -0
  150. package/dist/layouts/notebook/slots/container.d.ts +7 -0
  151. package/dist/layouts/notebook/slots/container.js +31 -0
  152. package/dist/layouts/notebook/slots/header.d.ts +8 -0
  153. package/dist/layouts/notebook/slots/header.js +194 -0
  154. package/dist/layouts/notebook/slots/sidebar.d.ts +40 -0
  155. package/dist/layouts/notebook/slots/sidebar.js +297 -0
  156. package/dist/layouts/shared/client.d.ts +45 -0
  157. package/dist/layouts/shared/client.js +84 -0
  158. package/dist/layouts/shared/index.d.ts +136 -34
  159. package/dist/layouts/shared/index.js +49 -17
  160. package/dist/layouts/shared/page-actions.d.ts +36 -0
  161. package/dist/layouts/shared/page-actions.js +190 -0
  162. package/dist/layouts/shared/slots/language-select.d.ts +10 -0
  163. package/dist/layouts/shared/{language-toggle.js → slots/language-select.js} +11 -15
  164. package/dist/layouts/shared/slots/search-trigger.d.ts +23 -0
  165. package/dist/layouts/shared/{search-toggle.js → slots/search-trigger.js} +9 -13
  166. package/dist/layouts/shared/slots/theme-switch.d.ts +14 -0
  167. package/dist/layouts/shared/{theme-toggle.js → slots/theme-switch.js} +5 -9
  168. package/dist/mdx.d.ts +13 -3
  169. package/dist/mdx.js +0 -4
  170. package/dist/mdx.server.d.ts +1 -2
  171. package/dist/mdx.server.js +0 -3
  172. package/dist/og/takumi.d.ts +21 -0
  173. package/dist/og/takumi.js +70 -0
  174. package/dist/og.d.ts +1 -2
  175. package/dist/og.js +6 -6
  176. package/dist/page.d.ts +3 -4
  177. package/dist/page.js +6 -11
  178. package/dist/provider/base.d.ts +1 -2
  179. package/dist/provider/base.js +2 -6
  180. package/dist/provider/next.d.ts +1 -2
  181. package/dist/provider/next.js +1 -5
  182. package/dist/provider/react-router.d.ts +1 -2
  183. package/dist/provider/react-router.js +1 -5
  184. package/dist/provider/tanstack.d.ts +1 -2
  185. package/dist/provider/tanstack.js +1 -5
  186. package/dist/provider/waku.d.ts +1 -2
  187. package/dist/provider/waku.js +1 -5
  188. package/dist/style.css +433 -166
  189. package/dist/tailwind/typography.d.ts +2 -0
  190. package/dist/tailwind/typography.js +2 -0
  191. package/dist/utils/cn.js +1 -2
  192. package/dist/utils/merge-refs.js +0 -2
  193. package/dist/utils/urls.js +1 -3
  194. package/dist/utils/use-copy-button.d.ts +1 -2
  195. package/dist/utils/use-copy-button.js +1 -5
  196. package/dist/utils/use-footer-items.d.ts +1 -2
  197. package/dist/utils/use-footer-items.js +4 -8
  198. package/dist/utils/use-is-scroll-top.d.ts +1 -2
  199. package/dist/utils/use-is-scroll-top.js +1 -5
  200. package/package.json +139 -103
  201. package/LICENSE +0 -21
  202. package/dist/components/accordion.d.ts.map +0 -1
  203. package/dist/components/accordion.js.map +0 -1
  204. package/dist/components/banner.d.ts.map +0 -1
  205. package/dist/components/banner.js.map +0 -1
  206. package/dist/components/callout.d.ts.map +0 -1
  207. package/dist/components/callout.js.map +0 -1
  208. package/dist/components/card.d.ts.map +0 -1
  209. package/dist/components/card.js.map +0 -1
  210. package/dist/components/codeblock.d.ts.map +0 -1
  211. package/dist/components/codeblock.js.map +0 -1
  212. package/dist/components/dialog/search-algolia.d.ts.map +0 -1
  213. package/dist/components/dialog/search-algolia.js.map +0 -1
  214. package/dist/components/dialog/search-default.d.ts.map +0 -1
  215. package/dist/components/dialog/search-default.js.map +0 -1
  216. package/dist/components/dialog/search-orama.d.ts.map +0 -1
  217. package/dist/components/dialog/search-orama.js.map +0 -1
  218. package/dist/components/dialog/search.d.ts.map +0 -1
  219. package/dist/components/dialog/search.js.map +0 -1
  220. package/dist/components/dynamic-codeblock.core.d.ts.map +0 -1
  221. package/dist/components/dynamic-codeblock.core.js.map +0 -1
  222. package/dist/components/dynamic-codeblock.d.ts.map +0 -1
  223. package/dist/components/dynamic-codeblock.js.map +0 -1
  224. package/dist/components/files.d.ts.map +0 -1
  225. package/dist/components/files.js.map +0 -1
  226. package/dist/components/github-info.d.ts.map +0 -1
  227. package/dist/components/github-info.js.map +0 -1
  228. package/dist/components/heading.d.ts.map +0 -1
  229. package/dist/components/heading.js.map +0 -1
  230. package/dist/components/image-zoom-DGvp66QF.css +0 -80
  231. package/dist/components/image-zoom-DGvp66QF.css.map +0 -1
  232. package/dist/components/image-zoom.d.ts.map +0 -1
  233. package/dist/components/image-zoom.js.map +0 -1
  234. package/dist/components/image-zoom2.js +0 -1
  235. package/dist/components/inline-toc.d.ts.map +0 -1
  236. package/dist/components/inline-toc.js.map +0 -1
  237. package/dist/components/sidebar/base.d.ts.map +0 -1
  238. package/dist/components/sidebar/base.js.map +0 -1
  239. package/dist/components/sidebar/link-item.d.ts.map +0 -1
  240. package/dist/components/sidebar/link-item.js.map +0 -1
  241. package/dist/components/sidebar/page-tree.d.ts.map +0 -1
  242. package/dist/components/sidebar/page-tree.js.map +0 -1
  243. package/dist/components/sidebar/tabs/dropdown.d.ts.map +0 -1
  244. package/dist/components/sidebar/tabs/dropdown.js.map +0 -1
  245. package/dist/components/sidebar/tabs/index.d.ts.map +0 -1
  246. package/dist/components/sidebar/tabs/index.js.map +0 -1
  247. package/dist/components/steps.d.ts.map +0 -1
  248. package/dist/components/steps.js.map +0 -1
  249. package/dist/components/tabs.d.ts.map +0 -1
  250. package/dist/components/tabs.js.map +0 -1
  251. package/dist/components/toc/clerk.d.ts.map +0 -1
  252. package/dist/components/toc/clerk.js.map +0 -1
  253. package/dist/components/toc/default.d.ts.map +0 -1
  254. package/dist/components/toc/default.js.map +0 -1
  255. package/dist/components/toc/index.d.ts.map +0 -1
  256. package/dist/components/toc/index.js.map +0 -1
  257. package/dist/components/type-table.d.ts.map +0 -1
  258. package/dist/components/type-table.js.map +0 -1
  259. package/dist/components/ui/accordion.d.ts.map +0 -1
  260. package/dist/components/ui/accordion.js.map +0 -1
  261. package/dist/components/ui/button.d.ts.map +0 -1
  262. package/dist/components/ui/button.js.map +0 -1
  263. package/dist/components/ui/collapsible.d.ts.map +0 -1
  264. package/dist/components/ui/collapsible.js.map +0 -1
  265. package/dist/components/ui/navigation-menu.d.ts.map +0 -1
  266. package/dist/components/ui/navigation-menu.js.map +0 -1
  267. package/dist/components/ui/popover.d.ts.map +0 -1
  268. package/dist/components/ui/popover.js.map +0 -1
  269. package/dist/components/ui/scroll-area.d.ts.map +0 -1
  270. package/dist/components/ui/scroll-area.js.map +0 -1
  271. package/dist/components/ui/tabs.d.ts.map +0 -1
  272. package/dist/components/ui/tabs.js.map +0 -1
  273. package/dist/contexts/i18n.d.ts.map +0 -1
  274. package/dist/contexts/i18n.js.map +0 -1
  275. package/dist/contexts/search.d.ts.map +0 -1
  276. package/dist/contexts/search.js.map +0 -1
  277. package/dist/contexts/tree.d.ts.map +0 -1
  278. package/dist/contexts/tree.js.map +0 -1
  279. package/dist/i18n.d.ts.map +0 -1
  280. package/dist/i18n.js.map +0 -1
  281. package/dist/layouts/docs/client.d.ts.map +0 -1
  282. package/dist/layouts/docs/client.js.map +0 -1
  283. package/dist/layouts/docs/index.d.ts.map +0 -1
  284. package/dist/layouts/docs/index.js.map +0 -1
  285. package/dist/layouts/docs/page/client.d.ts +0 -48
  286. package/dist/layouts/docs/page/client.d.ts.map +0 -1
  287. package/dist/layouts/docs/page/client.js +0 -227
  288. package/dist/layouts/docs/page/client.js.map +0 -1
  289. package/dist/layouts/docs/page/index.d.ts.map +0 -1
  290. package/dist/layouts/docs/page/index.js.map +0 -1
  291. package/dist/layouts/docs/sidebar.d.ts +0 -64
  292. package/dist/layouts/docs/sidebar.d.ts.map +0 -1
  293. package/dist/layouts/docs/sidebar.js +0 -162
  294. package/dist/layouts/docs/sidebar.js.map +0 -1
  295. package/dist/layouts/flux/index.d.ts.map +0 -1
  296. package/dist/layouts/flux/index.js.map +0 -1
  297. package/dist/layouts/flux/page/client.d.ts +0 -45
  298. package/dist/layouts/flux/page/client.d.ts.map +0 -1
  299. package/dist/layouts/flux/page/client.js +0 -255
  300. package/dist/layouts/flux/page/client.js.map +0 -1
  301. package/dist/layouts/flux/page/index.d.ts.map +0 -1
  302. package/dist/layouts/flux/page/index.js.map +0 -1
  303. package/dist/layouts/flux/sidebar.d.ts +0 -59
  304. package/dist/layouts/flux/sidebar.d.ts.map +0 -1
  305. package/dist/layouts/flux/sidebar.js.map +0 -1
  306. package/dist/layouts/flux/tab-dropdown.d.ts +0 -21
  307. package/dist/layouts/flux/tab-dropdown.d.ts.map +0 -1
  308. package/dist/layouts/flux/tab-dropdown.js.map +0 -1
  309. package/dist/layouts/home/client.d.ts +0 -19
  310. package/dist/layouts/home/client.d.ts.map +0 -1
  311. package/dist/layouts/home/client.js +0 -267
  312. package/dist/layouts/home/client.js.map +0 -1
  313. package/dist/layouts/home/index.d.ts.map +0 -1
  314. package/dist/layouts/home/index.js.map +0 -1
  315. package/dist/layouts/home/navbar.d.ts.map +0 -1
  316. package/dist/layouts/home/navbar.js.map +0 -1
  317. package/dist/layouts/notebook/client.d.ts.map +0 -1
  318. package/dist/layouts/notebook/client.js.map +0 -1
  319. package/dist/layouts/notebook/index.d.ts.map +0 -1
  320. package/dist/layouts/notebook/index.js.map +0 -1
  321. package/dist/layouts/notebook/page/client.d.ts +0 -48
  322. package/dist/layouts/notebook/page/client.d.ts.map +0 -1
  323. package/dist/layouts/notebook/page/client.js +0 -227
  324. package/dist/layouts/notebook/page/client.js.map +0 -1
  325. package/dist/layouts/notebook/page/index.d.ts.map +0 -1
  326. package/dist/layouts/notebook/page/index.js.map +0 -1
  327. package/dist/layouts/notebook/sidebar.d.ts +0 -60
  328. package/dist/layouts/notebook/sidebar.d.ts.map +0 -1
  329. package/dist/layouts/notebook/sidebar.js +0 -133
  330. package/dist/layouts/notebook/sidebar.js.map +0 -1
  331. package/dist/layouts/shared/index.d.ts.map +0 -1
  332. package/dist/layouts/shared/index.js.map +0 -1
  333. package/dist/layouts/shared/language-toggle.d.ts +0 -10
  334. package/dist/layouts/shared/language-toggle.d.ts.map +0 -1
  335. package/dist/layouts/shared/language-toggle.js.map +0 -1
  336. package/dist/layouts/shared/search-toggle.d.ts +0 -23
  337. package/dist/layouts/shared/search-toggle.d.ts.map +0 -1
  338. package/dist/layouts/shared/search-toggle.js.map +0 -1
  339. package/dist/layouts/shared/theme-toggle.d.ts +0 -14
  340. package/dist/layouts/shared/theme-toggle.d.ts.map +0 -1
  341. package/dist/layouts/shared/theme-toggle.js.map +0 -1
  342. package/dist/mdx.d.ts.map +0 -1
  343. package/dist/mdx.js.map +0 -1
  344. package/dist/mdx.server.d.ts.map +0 -1
  345. package/dist/mdx.server.js.map +0 -1
  346. package/dist/og.d.ts.map +0 -1
  347. package/dist/og.js.map +0 -1
  348. package/dist/page.d.ts.map +0 -1
  349. package/dist/page.js.map +0 -1
  350. package/dist/provider/base.d.ts.map +0 -1
  351. package/dist/provider/base.js.map +0 -1
  352. package/dist/provider/next.d.ts.map +0 -1
  353. package/dist/provider/next.js.map +0 -1
  354. package/dist/provider/react-router.d.ts.map +0 -1
  355. package/dist/provider/react-router.js.map +0 -1
  356. package/dist/provider/tanstack.d.ts.map +0 -1
  357. package/dist/provider/tanstack.js.map +0 -1
  358. package/dist/provider/waku.d.ts.map +0 -1
  359. package/dist/provider/waku.js.map +0 -1
  360. package/dist/utils/link-item.d.ts +0 -86
  361. package/dist/utils/link-item.d.ts.map +0 -1
  362. package/dist/utils/link-item.js +0 -25
  363. package/dist/utils/link-item.js.map +0 -1
  364. package/dist/utils/merge-refs.js.map +0 -1
  365. package/dist/utils/urls.js.map +0 -1
  366. package/dist/utils/use-copy-button.d.ts.map +0 -1
  367. package/dist/utils/use-copy-button.js.map +0 -1
  368. package/dist/utils/use-footer-items.d.ts.map +0 -1
  369. package/dist/utils/use-footer-items.js.map +0 -1
  370. package/dist/utils/use-is-scroll-top.d.ts.map +0 -1
  371. package/dist/utils/use-is-scroll-top.js.map +0 -1
@@ -1,68 +1,92 @@
1
- 'use client';
2
-
1
+ "use client";
3
2
  import { cn } from "../../utils/cn.js";
4
- import { useSidebar } from "../../components/sidebar/base.js";
5
- import { isTabActive } from "../../components/sidebar/tabs/dropdown.js";
3
+ import { TreeContextProvider } from "../../contexts/tree.js";
4
+ import { baseSlots } from "../shared/client.js";
5
+ import { isLayoutTabActive, useLinkItems } from "../shared/index.js";
6
6
  import { useIsScrollTop } from "../../utils/use-is-scroll-top.js";
7
+ import { Sidebar, SidebarProvider, SidebarTrigger, useSidebar } from "./slots/sidebar.js";
8
+ import { Header } from "./slots/header.js";
9
+ import { Container } from "./slots/container.js";
7
10
  import { createContext, use, useMemo } from "react";
8
11
  import { usePathname } from "@hanzo/docs-core/framework";
9
- import { jsx } from "react/jsx-runtime";
12
+ import { jsx, jsxs } from "react/jsx-runtime";
10
13
  import Link from "@hanzo/docs-core/link";
11
-
12
14
  //#region src/layouts/docs/client.tsx
15
+ const { useProvider } = baseSlots({ useProps() {
16
+ return useDocsLayout().props;
17
+ } });
13
18
  const LayoutContext = createContext(null);
14
- function LayoutContextProvider({ navTransparentMode = "none", children }) {
15
- const isTop = useIsScrollTop({ enabled: navTransparentMode === "top" }) ?? true;
16
- const isNavTransparent = navTransparentMode === "top" ? isTop : navTransparentMode === "always";
17
- return /* @__PURE__ */ jsx(LayoutContext, {
18
- value: useMemo(() => ({ isNavTransparent }), [isNavTransparent]),
19
- children
20
- });
19
+ function useIsDocsLayout() {
20
+ return use(LayoutContext) !== null;
21
21
  }
22
- function LayoutHeader(props) {
23
- const { isNavTransparent } = use(LayoutContext);
24
- return /* @__PURE__ */ jsx("header", {
25
- "data-transparent": isNavTransparent,
26
- ...props,
27
- children: props.children
28
- });
22
+ function useDocsLayout() {
23
+ const context = use(LayoutContext);
24
+ if (!context) throw new Error("Please use <DocsPage /> (`@hanzo/docs-ui/layouts/docs/page`) under <DocsLayout /> (`@hanzo/docs-ui/layouts/docs`).");
25
+ return context;
29
26
  }
30
- function LayoutBody({ className, style, children, ...props }) {
31
- const { collapsed } = useSidebar();
32
- return /* @__PURE__ */ jsx("div", {
33
- id: "nd-docs-layout",
34
- className: cn("grid transition-[grid-template-columns] overflow-x-clip min-h-(--fd-docs-height) auto-cols-auto auto-rows-auto [--fd-docs-height:100dvh] [--fd-header-height:0px] [--fd-toc-popover-height:0px] [--fd-sidebar-width:0px] [--fd-toc-width:0px]", className),
35
- "data-sidebar-collapsed": collapsed,
36
- style: {
37
- gridTemplate: `"sidebar header toc"
38
- "sidebar toc-popover toc"
39
- "sidebar main toc" 1fr / minmax(var(--fd-sidebar-col), 1fr) minmax(0, calc(var(--fd-layout-width,97rem) - var(--fd-sidebar-width) - var(--fd-toc-width))) minmax(min-content, 1fr)`,
40
- "--fd-docs-row-1": "var(--fd-banner-height, 0px)",
41
- "--fd-docs-row-2": "calc(var(--fd-docs-row-1) + var(--fd-header-height))",
42
- "--fd-docs-row-3": "calc(var(--fd-docs-row-2) + var(--fd-toc-popover-height))",
43
- "--fd-sidebar-col": collapsed ? "0px" : "var(--fd-sidebar-width)",
44
- ...style
45
- },
46
- ...props,
47
- children
27
+ function LayoutBody(props) {
28
+ const { nav: { enabled: navEnabled = true, transparentMode: navTransparentMode = "none" } = {}, sidebar: { enabled: sidebarEnabled = true, defaultOpenLevel, prefetch, ...sidebarProps } = {}, slots: defaultSlots, tabs, tabMode = "auto", tree, containerProps, children } = props;
29
+ const isTop = useIsScrollTop({ enabled: navTransparentMode === "top" }) ?? true;
30
+ const isNavTransparent = navTransparentMode === "top" ? isTop : navTransparentMode === "always";
31
+ const { baseSlots, baseProps } = useProvider(props);
32
+ const linkItems = useLinkItems(props);
33
+ const slots = {
34
+ ...baseSlots,
35
+ header: defaultSlots?.header ?? Header,
36
+ container: defaultSlots?.container ?? Container,
37
+ sidebar: defaultSlots?.sidebar ?? {
38
+ provider: SidebarProvider,
39
+ root: Sidebar,
40
+ trigger: SidebarTrigger,
41
+ useSidebar
42
+ }
43
+ };
44
+ return /* @__PURE__ */ jsx(TreeContextProvider, {
45
+ tree,
46
+ children: /* @__PURE__ */ jsx(LayoutContext, {
47
+ value: {
48
+ props: {
49
+ tabMode,
50
+ tabs,
51
+ ...baseProps
52
+ },
53
+ isNavTransparent,
54
+ slots,
55
+ ...linkItems
56
+ },
57
+ children: /* @__PURE__ */ jsx(slots.sidebar.provider, {
58
+ defaultOpenLevel,
59
+ prefetch,
60
+ children: /* @__PURE__ */ jsxs(slots.container, {
61
+ ...containerProps,
62
+ children: [
63
+ navEnabled && /* @__PURE__ */ jsx(slots.header, {}),
64
+ sidebarEnabled && /* @__PURE__ */ jsx(slots.sidebar.root, { ...sidebarProps }),
65
+ tabMode === "top" && tabs.length > 0 && /* @__PURE__ */ jsx(LayoutTabs, {
66
+ tabs,
67
+ className: "z-10 bg-fd-background border-b px-6 pt-3 xl:px-8 max-md:hidden"
68
+ }),
69
+ children
70
+ ]
71
+ })
72
+ })
73
+ })
48
74
  });
49
75
  }
50
- function LayoutTabs({ options, ...props }) {
76
+ function LayoutTabs({ tabs, ...props }) {
51
77
  const pathname = usePathname();
52
78
  const selected = useMemo(() => {
53
- return options.findLast((option) => isTabActive(option, pathname));
54
- }, [options, pathname]);
79
+ return tabs.findLast((option) => isLayoutTabActive(option, pathname));
80
+ }, [tabs, pathname]);
55
81
  return /* @__PURE__ */ jsx("div", {
56
82
  ...props,
57
83
  className: cn("flex flex-row items-end gap-6 overflow-auto [grid-area:main]", props.className),
58
- children: options.map((option, i) => /* @__PURE__ */ jsx(Link, {
59
- href: option.url,
60
- className: cn("inline-flex border-b-2 border-transparent transition-colors items-center pb-1.5 font-medium gap-2 text-fd-muted-foreground text-sm text-nowrap hover:text-fd-accent-foreground", option.unlisted && selected !== option && "hidden", selected === option && "border-fd-primary text-fd-primary"),
61
- children: option.title
84
+ children: tabs.map((tab, i) => /* @__PURE__ */ jsx(Link, {
85
+ href: tab.url,
86
+ className: cn("inline-flex border-b-2 border-transparent transition-colors items-center pb-1.5 font-medium gap-2 text-fd-muted-foreground text-sm text-nowrap hover:text-fd-accent-foreground", tab.unlisted && selected !== tab && "hidden", selected === tab && "border-fd-primary text-fd-primary"),
87
+ children: tab.title
62
88
  }, i))
63
89
  });
64
90
  }
65
-
66
91
  //#endregion
67
- export { LayoutBody, LayoutContext, LayoutContextProvider, LayoutHeader, LayoutTabs };
68
- //# sourceMappingURL=client.js.map
92
+ export { LayoutBody, useDocsLayout, useIsDocsLayout };
@@ -1,9 +1,7 @@
1
- import { SidebarPageTreeComponents } from "../../components/sidebar/page-tree.js";
2
- import { GetSidebarTabsOptions } from "../../components/sidebar/tabs/index.js";
3
- import { SidebarTabWithProps } from "../../components/sidebar/tabs/dropdown.js";
4
- import { BaseLayoutProps } from "../shared/index.js";
5
- import { Sidebar } from "./sidebar.js";
6
- import { ComponentProps, HTMLAttributes, ReactNode } from "react";
1
+ import { BaseLayoutProps, GetLayoutTabsOptions, LayoutTab } from "../shared/index.js";
2
+ import { SidebarProps, SidebarProviderProps } from "./slots/sidebar.js";
3
+ import { DocsSlots, useDocsLayout } from "./client.js";
4
+ import { HTMLAttributes, ReactNode } from "react";
7
5
  import * as react_jsx_runtime0 from "react/jsx-runtime";
8
6
  import * as PageTree from "@hanzo/docs-core/page-tree";
9
7
 
@@ -12,48 +10,36 @@ interface DocsLayoutProps extends BaseLayoutProps {
12
10
  tree: PageTree.Root;
13
11
  sidebar?: SidebarOptions;
14
12
  tabMode?: 'top' | 'auto';
15
- /**
16
- * Props for the `div` container
17
- */
13
+ tabs?: LayoutTab[] | GetLayoutTabsOptions | false;
18
14
  containerProps?: HTMLAttributes<HTMLDivElement>;
15
+ slots?: Partial<DocsSlots>;
19
16
  }
20
- interface SidebarOptions extends ComponentProps<'aside'>, Pick<ComponentProps<typeof Sidebar>, 'defaultOpenLevel' | 'prefetch'> {
17
+ interface SidebarOptions extends SidebarProps, SidebarProviderProps {
21
18
  enabled?: boolean;
19
+ /**
20
+ * @deprecated use `slots.sidebar` instead.
21
+ */
22
22
  component?: ReactNode;
23
- components?: Partial<SidebarPageTreeComponents>;
24
23
  /**
25
- * Root Toggle options
24
+ * @deprecated use layout-level `tabMode` option instead.
26
25
  */
27
- tabs?: SidebarTabWithProps[] | GetSidebarTabsOptions | false;
28
- banner?: ReactNode;
29
- footer?: ReactNode;
26
+ tabMode?: 'auto' | 'top';
30
27
  /**
31
- * Support collapsing the sidebar on desktop mode
32
- *
33
- * @defaultValue true
28
+ * @deprecated use layout-level `tabs` option instead.
34
29
  */
35
- collapsible?: boolean;
30
+ tabs?: LayoutTab[] | GetLayoutTabsOptions | false;
36
31
  }
37
32
  declare function DocsLayout({
38
- nav: {
39
- transparentMode,
40
- ...nav
41
- },
33
+ tree,
42
34
  sidebar: {
43
- tabs: sidebarTabs,
44
- enabled: sidebarEnabled,
45
- defaultOpenLevel,
46
- prefetch,
35
+ tabs: _tabs,
36
+ tabMode: _tabMode,
47
37
  ...sidebarProps
48
38
  },
49
- searchToggle,
50
- themeSwitch,
39
+ tabs: layoutTabs,
51
40
  tabMode,
52
- i18n,
53
41
  children,
54
- tree,
55
42
  ...props
56
43
  }: DocsLayoutProps): react_jsx_runtime0.JSX.Element;
57
44
  //#endregion
58
- export { DocsLayout, DocsLayoutProps };
59
- //# sourceMappingURL=index.d.ts.map
45
+ export { DocsLayout, DocsLayoutProps, type DocsSlots, useDocsLayout };
@@ -1,178 +1,22 @@
1
- import { cn } from "../../utils/cn.js";
2
- import { buttonVariants } from "../../components/ui/button.js";
3
- import { TreeContextProvider } from "../../contexts/tree.js";
4
- import { SidebarTabsDropdown } from "../../components/sidebar/tabs/dropdown.js";
5
- import { LayoutBody, LayoutContextProvider, LayoutHeader, LayoutTabs } from "./client.js";
6
- import { LinkItem } from "../../utils/link-item.js";
7
- import { LargeSearchToggle, SearchToggle } from "../shared/search-toggle.js";
8
- import { Sidebar as Sidebar$1, SidebarCollapseTrigger, SidebarContent, SidebarDrawer, SidebarLinkItem, SidebarPageTree, SidebarTrigger, SidebarViewport } from "./sidebar.js";
9
- import { renderTitleNav, useLinkItems } from "../shared/index.js";
10
- import { LanguageToggle, LanguageToggleText } from "../shared/language-toggle.js";
11
- import { ThemeToggle } from "../shared/theme-toggle.js";
12
- import { getSidebarTabs } from "../../components/sidebar/tabs/index.js";
1
+ import { getLayoutTabs } from "../shared/index.js";
2
+ import { LayoutBody, useDocsLayout } from "./client.js";
13
3
  import { useMemo } from "react";
14
- import { Fragment as Fragment$1, jsx, jsxs } from "react/jsx-runtime";
15
- import { Languages, Sidebar } from "lucide-react";
16
-
4
+ import { jsx } from "react/jsx-runtime";
17
5
  //#region src/layouts/docs/index.tsx
18
- function DocsLayout({ nav: { transparentMode, ...nav } = {}, sidebar: { tabs: sidebarTabs, enabled: sidebarEnabled = true, defaultOpenLevel, prefetch, ...sidebarProps } = {}, searchToggle = {}, themeSwitch = {}, tabMode = "auto", i18n = false, children, tree, ...props }) {
19
- const tabs = useMemo(() => {
20
- if (Array.isArray(sidebarTabs)) return sidebarTabs;
21
- if (typeof sidebarTabs === "object") return getSidebarTabs(tree, sidebarTabs);
22
- if (sidebarTabs !== false) return getSidebarTabs(tree);
23
- return [];
24
- }, [tree, sidebarTabs]);
25
- const { menuItems } = useLinkItems(props);
26
- function sidebar() {
27
- const { footer, banner, collapsible = true, component, components, ...rest } = sidebarProps;
28
- if (component) return component;
29
- const iconLinks = menuItems.filter((item) => item.type === "icon");
30
- const viewport = /* @__PURE__ */ jsxs(SidebarViewport, { children: [menuItems.filter((v) => v.type !== "icon").map((item, i, list) => /* @__PURE__ */ jsx(SidebarLinkItem, {
31
- item,
32
- className: cn(i === list.length - 1 && "mb-4")
33
- }, i)), /* @__PURE__ */ jsx(SidebarPageTree, { ...components })] });
34
- return /* @__PURE__ */ jsxs(Fragment$1, { children: [/* @__PURE__ */ jsxs(SidebarContent, {
35
- ...rest,
36
- children: [
37
- /* @__PURE__ */ jsxs("div", {
38
- className: "flex flex-col gap-3 p-4 pb-2",
39
- children: [
40
- /* @__PURE__ */ jsxs("div", {
41
- className: "flex",
42
- children: [
43
- renderTitleNav(nav, { className: "inline-flex text-[0.9375rem] items-center gap-2.5 font-medium me-auto" }),
44
- nav.children,
45
- collapsible && /* @__PURE__ */ jsx(SidebarCollapseTrigger, {
46
- className: cn(buttonVariants({
47
- color: "ghost",
48
- size: "icon-sm",
49
- className: "mb-auto text-fd-muted-foreground"
50
- })),
51
- children: /* @__PURE__ */ jsx(Sidebar, {})
52
- })
53
- ]
54
- }),
55
- searchToggle.enabled !== false && (searchToggle.components?.lg ?? /* @__PURE__ */ jsx(LargeSearchToggle, { hideIfDisabled: true })),
56
- tabs.length > 0 && tabMode === "auto" && /* @__PURE__ */ jsx(SidebarTabsDropdown, { options: tabs }),
57
- banner
58
- ]
59
- }),
60
- viewport,
61
- (i18n || iconLinks.length > 0 || themeSwitch?.enabled !== false || footer) && /* @__PURE__ */ jsxs("div", {
62
- className: "flex flex-col border-t p-4 pt-2 empty:hidden",
63
- children: [/* @__PURE__ */ jsxs("div", {
64
- className: "flex text-fd-muted-foreground items-center empty:hidden",
65
- children: [
66
- i18n && /* @__PURE__ */ jsx(LanguageToggle, { children: /* @__PURE__ */ jsx(Languages, { className: "size-4.5" }) }),
67
- iconLinks.map((item, i) => /* @__PURE__ */ jsx(LinkItem, {
68
- item,
69
- className: cn(buttonVariants({
70
- size: "icon-sm",
71
- color: "ghost"
72
- })),
73
- "aria-label": item.label,
74
- children: item.icon
75
- }, i)),
76
- themeSwitch.enabled !== false && (themeSwitch.component ?? /* @__PURE__ */ jsx(ThemeToggle, {
77
- className: "ms-auto p-0",
78
- mode: themeSwitch.mode
79
- }))
80
- ]
81
- }), footer]
82
- })
83
- ]
84
- }), /* @__PURE__ */ jsxs(SidebarDrawer, { children: [
85
- /* @__PURE__ */ jsxs("div", {
86
- className: "flex flex-col gap-3 p-4 pb-2",
87
- children: [
88
- /* @__PURE__ */ jsxs("div", {
89
- className: "flex text-fd-muted-foreground items-center gap-1.5",
90
- children: [
91
- /* @__PURE__ */ jsx("div", {
92
- className: "flex flex-1",
93
- children: iconLinks.map((item, i) => /* @__PURE__ */ jsx(LinkItem, {
94
- item,
95
- className: cn(buttonVariants({
96
- size: "icon-sm",
97
- color: "ghost",
98
- className: "p-2"
99
- })),
100
- "aria-label": item.label,
101
- children: item.icon
102
- }, i))
103
- }),
104
- i18n && /* @__PURE__ */ jsxs(LanguageToggle, { children: [/* @__PURE__ */ jsx(Languages, { className: "size-4.5" }), /* @__PURE__ */ jsx(LanguageToggleText, {})] }),
105
- themeSwitch.enabled !== false && (themeSwitch.component ?? /* @__PURE__ */ jsx(ThemeToggle, {
106
- className: "p-0",
107
- mode: themeSwitch.mode
108
- })),
109
- /* @__PURE__ */ jsx(SidebarTrigger, {
110
- className: cn(buttonVariants({
111
- color: "ghost",
112
- size: "icon-sm",
113
- className: "p-2"
114
- })),
115
- children: /* @__PURE__ */ jsx(Sidebar, {})
116
- })
117
- ]
118
- }),
119
- tabs.length > 0 && /* @__PURE__ */ jsx(SidebarTabsDropdown, { options: tabs }),
120
- banner
121
- ]
122
- }),
123
- viewport,
124
- /* @__PURE__ */ jsx("div", {
125
- className: "flex flex-col border-t p-4 pt-2 empty:hidden",
126
- children: footer
127
- })
128
- ] })] });
129
- }
130
- return /* @__PURE__ */ jsx(TreeContextProvider, {
6
+ function DocsLayout({ tree, sidebar: { tabs: _tabs, tabMode: _tabMode, ...sidebarProps } = {}, tabs: layoutTabs = _tabs, tabMode = _tabMode, children, ...props }) {
7
+ return /* @__PURE__ */ jsx(LayoutBody, {
131
8
  tree,
132
- children: /* @__PURE__ */ jsx(LayoutContextProvider, {
133
- navTransparentMode: transparentMode,
134
- children: /* @__PURE__ */ jsx(Sidebar$1, {
135
- defaultOpenLevel,
136
- prefetch,
137
- children: /* @__PURE__ */ jsxs(LayoutBody, {
138
- ...props.containerProps,
139
- children: [
140
- nav.enabled !== false && (nav.component ?? /* @__PURE__ */ jsxs(LayoutHeader, {
141
- id: "nd-subnav",
142
- className: "[grid-area:header] sticky top-(--fd-docs-row-1) z-30 flex items-center ps-4 pe-2.5 border-b transition-colors backdrop-blur-sm h-(--fd-header-height) md:hidden max-md:layout:[--fd-header-height:--spacing(14)] data-[transparent=false]:bg-fd-background/80",
143
- children: [
144
- renderTitleNav(nav, { className: "inline-flex items-center gap-2.5 font-semibold" }),
145
- /* @__PURE__ */ jsx("div", {
146
- className: "flex-1",
147
- children: nav.children
148
- }),
149
- searchToggle.enabled !== false && (searchToggle.components?.sm ?? /* @__PURE__ */ jsx(SearchToggle, {
150
- className: "p-2",
151
- hideIfDisabled: true
152
- })),
153
- sidebarEnabled && /* @__PURE__ */ jsx(SidebarTrigger, {
154
- className: cn(buttonVariants({
155
- color: "ghost",
156
- size: "icon-sm",
157
- className: "p-2"
158
- })),
159
- children: /* @__PURE__ */ jsx(Sidebar, {})
160
- })
161
- ]
162
- })),
163
- sidebarEnabled && sidebar(),
164
- tabMode === "top" && tabs.length > 0 && /* @__PURE__ */ jsx(LayoutTabs, {
165
- options: tabs,
166
- className: "z-10 bg-fd-background border-b px-6 pt-3 xl:px-8 max-md:hidden"
167
- }),
168
- children
169
- ]
170
- })
171
- })
172
- })
9
+ tabs: useMemo(() => {
10
+ if (Array.isArray(layoutTabs)) return layoutTabs;
11
+ if (typeof layoutTabs === "object") return getLayoutTabs(tree, layoutTabs);
12
+ if (layoutTabs !== false) return getLayoutTabs(tree);
13
+ return [];
14
+ }, [tree, layoutTabs]),
15
+ tabMode,
16
+ sidebar: sidebarProps,
17
+ ...props,
18
+ children
173
19
  });
174
20
  }
175
-
176
21
  //#endregion
177
- export { DocsLayout };
178
- //# sourceMappingURL=index.js.map
22
+ export { DocsLayout, useDocsLayout };
@@ -1,86 +1,93 @@
1
- import { BreadcrumbProps, FooterProps, PageBreadcrumb, PageLastUpdate } from "./client.js";
2
- import { ComponentProps, ReactNode } from "react";
1
+ import { TOCPopoverProps, TOCProps, TOCProviderProps } from "./slots/toc.js";
2
+ import { Footer, FooterProps } from "./slots/footer.js";
3
+ import { Breadcrumb, BreadcrumbProps } from "./slots/breadcrumb.js";
4
+ import { MarkdownCopyButton, ViewOptionsPopover } from "../../shared/page-actions.js";
5
+ import { ComponentProps, FC, ReactNode } from "react";
3
6
  import * as react_jsx_runtime0 from "react/jsx-runtime";
4
- import { AnchorProviderProps, TOCItemType } from "@hanzo/docs-core/toc";
7
+ import { TOCItemType } from "@hanzo/docs-core/toc";
5
8
 
6
9
  //#region src/layouts/docs/page/index.d.ts
7
- interface BreadcrumbOptions extends BreadcrumbProps {
8
- enabled: boolean;
9
- component: ReactNode;
10
- }
11
- interface FooterOptions extends FooterProps {
12
- enabled: boolean;
13
- component: ReactNode;
14
- }
15
- interface DocsPageProps {
10
+ interface DocsPageProps extends ComponentProps<'article'> {
16
11
  toc?: TOCItemType[];
17
- tableOfContent?: Partial<TableOfContentOptions>;
18
- tableOfContentPopover?: Partial<TableOfContentPopoverOptions>;
19
12
  /**
20
13
  * Extend the page to fill all available space
21
14
  *
22
15
  * @defaultValue false
23
16
  */
24
17
  full?: boolean;
18
+ slots?: Partial<DocsPageSlots>;
19
+ footer?: FooterOptions;
20
+ breadcrumb?: BreadcrumbOptions;
21
+ tableOfContent?: TableOfContentOptions;
22
+ tableOfContentPopover?: TableOfContentPopoverOptions;
23
+ }
24
+ interface BreadcrumbOptions extends BreadcrumbProps {
25
+ enabled?: boolean;
25
26
  /**
26
- * Replace or disable breadcrumb
27
- */
28
- breadcrumb?: Partial<BreadcrumbOptions>;
29
- /**
30
- * Footer navigation, located under the page body.
31
- *
32
- * You can specify `footer.children` to add extra components under the footer.
33
- */
34
- footer?: Partial<FooterOptions>;
35
- children?: ReactNode;
36
- /**
37
- * Apply class names to the `#nd-page` container.
27
+ * @deprecated use `slots.breadcrumb` instead.
38
28
  */
39
- className?: string;
29
+ component?: ReactNode;
40
30
  }
41
- type TableOfContentOptions = Pick<AnchorProviderProps, 'single'> & {
31
+ interface FooterOptions extends FooterProps {
32
+ enabled?: boolean;
42
33
  /**
43
- * Custom content in TOC container, before the main TOC
34
+ * @deprecated use `slots.footer` instead.
44
35
  */
45
- header?: ReactNode;
36
+ component?: ReactNode;
37
+ }
38
+ interface TableOfContentOptions extends Pick<TOCProviderProps, 'single'>, TOCProps {
39
+ enabled?: boolean;
46
40
  /**
47
- * Custom content in TOC container, after the main TOC
41
+ * @deprecated use `slots.toc` instead.
48
42
  */
49
- footer?: ReactNode;
50
- enabled: boolean;
51
- component: ReactNode;
43
+ component?: ReactNode;
44
+ }
45
+ interface TableOfContentPopoverOptions extends TOCPopoverProps {
46
+ enabled?: boolean;
52
47
  /**
53
- * @defaultValue 'normal'
48
+ * @deprecated use `slots.tocPopover` instead.
54
49
  */
55
- style?: 'normal' | 'clerk';
50
+ component?: ReactNode;
51
+ }
52
+ interface DocsPageSlots {
53
+ toc: {
54
+ provider: FC<TOCProviderProps>;
55
+ main: FC<TOCProps>;
56
+ popover: FC<TOCPopoverProps>;
57
+ };
58
+ container: FC<ComponentProps<'article'>>;
59
+ footer: FC<FooterProps>;
60
+ breadcrumb: FC<BreadcrumbProps>;
61
+ }
62
+ type PageSlotsProps = Pick<DocsPageProps, 'full'>;
63
+ declare function useDocsPage(): {
64
+ props: PageSlotsProps;
65
+ slots: DocsPageSlots;
56
66
  };
57
- type TableOfContentPopoverOptions = Omit<TableOfContentOptions, 'single'>;
58
67
  declare function DocsPage({
68
+ tableOfContent: {
69
+ enabled: tocEnabled,
70
+ single,
71
+ ...tocProps
72
+ },
73
+ tableOfContentPopover: {
74
+ enabled: tocPopoverEnabled,
75
+ ...tocPopoverProps
76
+ },
59
77
  breadcrumb: {
60
78
  enabled: breadcrumbEnabled,
61
- component: breadcrumb,
62
- ...breadcrumbProps
79
+ ...breadcrumb
63
80
  },
64
81
  footer: {
65
82
  enabled: footerEnabled,
66
- component: footerReplace,
67
- ...footerProps
83
+ ...footer
68
84
  },
69
85
  full,
70
- tableOfContentPopover: {
71
- enabled: tocPopoverEnabled,
72
- component: tocPopover,
73
- ...tocPopoverOptions
74
- },
75
- tableOfContent: {
76
- enabled: tocEnabled,
77
- component: tocReplace,
78
- ...tocOptions
79
- },
80
86
  toc,
87
+ slots: defaultSlots,
81
88
  children,
82
- className
83
- }: DocsPageProps): ReactNode;
89
+ ...containerProps
90
+ }: DocsPageProps): react_jsx_runtime0.JSX.Element;
84
91
  declare function EditOnGitHub(props: ComponentProps<'a'>): react_jsx_runtime0.JSX.Element;
85
92
  /**
86
93
  * Add typography styles
@@ -100,6 +107,11 @@ declare function DocsTitle({
100
107
  className,
101
108
  ...props
102
109
  }: ComponentProps<'h1'>): react_jsx_runtime0.JSX.Element;
110
+ declare function PageLastUpdate({
111
+ date: value,
112
+ ...props
113
+ }: Omit<ComponentProps<'p'>, 'children'> & {
114
+ date: Date;
115
+ }): react_jsx_runtime0.JSX.Element;
103
116
  //#endregion
104
- export { DocsBody, DocsDescription, DocsPage, DocsPageProps, DocsTitle, EditOnGitHub, PageBreadcrumb, PageLastUpdate };
105
- //# sourceMappingURL=index.d.ts.map
117
+ export { type BreadcrumbProps, DocsBody, DocsDescription, DocsPage, DocsPageProps, DocsTitle, EditOnGitHub, type FooterProps, MarkdownCopyButton, Breadcrumb as PageBreadcrumb, Footer as PageFooter, PageLastUpdate, ViewOptionsPopover, useDocsPage };