@docusaurus/theme-classic 2.0.0-beta.15d451942 → 2.0.0-beta.18

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 (488) hide show
  1. package/README.md +2 -2
  2. package/lib/admonitions.css +35 -0
  3. package/lib/deps.d.ts +13 -0
  4. package/lib/getSwizzleConfig.js +236 -0
  5. package/lib/index.js +63 -52
  6. package/lib/prism-include-languages.js +9 -5
  7. package/lib/theme-classic.d.ts +997 -0
  8. package/lib/translations.js +52 -36
  9. package/lib/types.d.ts +0 -589
  10. package/lib/validateThemeConfig.js +242 -250
  11. package/lib-next/theme/Admonition/index.js +101 -0
  12. package/lib-next/theme/AnnouncementBar/index.js +10 -22
  13. package/lib-next/theme/AnnouncementBar/styles.module.css +26 -35
  14. package/lib-next/theme/BackToTopButton/index.js +129 -0
  15. package/lib-next/theme/BackToTopButton/styles.module.css +44 -0
  16. package/lib-next/theme/BlogArchivePage/index.js +84 -0
  17. package/lib-next/theme/BlogLayout/index.js +37 -0
  18. package/lib-next/theme/BlogListPage/index.js +45 -35
  19. package/lib-next/theme/BlogListPaginator/index.js +13 -16
  20. package/lib-next/theme/BlogPostAuthor/index.js +52 -0
  21. package/lib-next/theme/BlogPostAuthor/styles.module.css +12 -0
  22. package/lib-next/theme/BlogPostAuthors/index.js +44 -0
  23. package/lib-next/theme/BlogPostAuthors/styles.module.css +21 -0
  24. package/lib-next/theme/BlogPostItem/index.js +112 -97
  25. package/lib-next/theme/BlogPostItem/styles.module.css +5 -1
  26. package/lib-next/theme/BlogPostPage/index.js +84 -41
  27. package/lib-next/theme/BlogPostPaginator/index.js +13 -20
  28. package/lib-next/theme/BlogSidebar/index.js +23 -16
  29. package/lib-next/theme/BlogSidebar/styles.module.css +8 -8
  30. package/lib-next/theme/BlogTagsListPage/index.js +24 -70
  31. package/lib-next/theme/BlogTagsPostsPage/index.js +57 -62
  32. package/lib-next/theme/CodeBlock/CopyButton/index.js +60 -0
  33. package/lib-next/theme/CodeBlock/CopyButton/styles.module.css +66 -0
  34. package/lib-next/theme/CodeBlock/index.js +74 -195
  35. package/lib-next/theme/CodeBlock/styles.module.css +13 -28
  36. package/lib-next/theme/ColorModeToggle/index.js +62 -0
  37. package/lib-next/theme/ColorModeToggle/styles.module.css +35 -0
  38. package/lib-next/theme/Details/index.js +21 -0
  39. package/lib-next/theme/Details/styles.module.css +13 -0
  40. package/lib-next/theme/DocBreadcrumbs/index.js +93 -0
  41. package/{lib/theme/Heading → lib-next/theme/DocBreadcrumbs}/styles.module.css +3 -2
  42. package/lib-next/theme/DocCard/index.js +93 -0
  43. package/lib-next/theme/DocCard/styles.module.css +34 -0
  44. package/lib-next/theme/DocCardList/index.js +31 -0
  45. package/lib-next/theme/DocCategoryGeneratedIndexPage/index.js +75 -0
  46. package/lib-next/theme/DocCategoryGeneratedIndexPage/styles.module.css +18 -0
  47. package/lib-next/theme/DocItem/index.js +99 -86
  48. package/lib-next/theme/DocItem/styles.module.css +7 -13
  49. package/lib-next/theme/DocItemFooter/index.js +79 -0
  50. package/{lib/theme/Layout/styles.css → lib-next/theme/DocItemFooter/styles.module.css} +8 -11
  51. package/lib-next/theme/DocPage/index.js +124 -99
  52. package/lib-next/theme/DocPage/styles.module.css +14 -30
  53. package/lib-next/theme/DocPaginator/index.js +16 -25
  54. package/lib-next/theme/DocSidebar/Desktop/CollapseButton/index.js +34 -0
  55. package/lib-next/theme/DocSidebar/Desktop/CollapseButton/styles.module.css +44 -0
  56. package/lib-next/theme/DocSidebar/Desktop/Content/index.js +46 -0
  57. package/{lib/theme/Footer → lib-next/theme/DocSidebar/Desktop/Content}/styles.module.css +8 -6
  58. package/lib-next/theme/DocSidebar/Desktop/index.js +34 -0
  59. package/lib-next/theme/DocSidebar/Desktop/styles.module.css +50 -0
  60. package/lib-next/theme/DocSidebar/Mobile/index.js +49 -0
  61. package/lib-next/theme/DocSidebar/index.js +13 -333
  62. package/lib-next/theme/DocSidebarItem/index.js +265 -0
  63. package/lib-next/theme/DocSidebarItem/styles.module.css +17 -0
  64. package/lib-next/theme/DocSidebarItems/index.js +28 -0
  65. package/lib-next/theme/DocTagDocListPage/index.js +96 -0
  66. package/lib-next/theme/DocTagsListPage/index.js +40 -0
  67. package/lib-next/theme/DocVersionBadge/index.js +34 -0
  68. package/lib-next/theme/{DocVersionSuggestions → DocVersionBanner}/index.js +54 -36
  69. package/lib-next/theme/EditThisPage/index.js +6 -1
  70. package/lib-next/theme/ErrorPageContent.js +35 -0
  71. package/lib-next/theme/Footer/Copyright/index.js +18 -0
  72. package/lib-next/theme/Footer/Layout/index.js +26 -0
  73. package/lib-next/theme/Footer/LinkItem/index.js +33 -0
  74. package/lib-next/theme/Footer/Links/MultiColumn/index.js +47 -0
  75. package/lib-next/theme/Footer/Links/Simple/index.js +41 -0
  76. package/lib-next/theme/Footer/Links/index.js +17 -0
  77. package/lib-next/theme/Footer/Logo/index.js +38 -0
  78. package/{src/theme/Footer → lib-next/theme/Footer/Logo}/styles.module.css +2 -1
  79. package/lib-next/theme/Footer/index.js +12 -100
  80. package/lib-next/theme/Heading/index.js +42 -33
  81. package/lib-next/theme/Heading/styles.module.css +27 -2
  82. package/lib-next/theme/IconArrow/index.js +3 -6
  83. package/lib-next/theme/IconClose/index.js +23 -0
  84. package/lib-next/theme/IconDarkMode/index.js +17 -0
  85. package/lib-next/theme/IconEdit/index.js +5 -10
  86. package/lib-next/theme/IconExternalLink/index.js +23 -0
  87. package/lib-next/theme/{LastUpdated → IconExternalLink}/styles.module.css +2 -2
  88. package/lib-next/theme/IconLanguage/index.js +5 -8
  89. package/lib-next/theme/IconLightMode/index.js +17 -0
  90. package/lib-next/theme/IconMenu/index.js +8 -9
  91. package/lib-next/theme/LastUpdated/index.js +35 -39
  92. package/lib-next/theme/Layout/index.js +19 -16
  93. package/lib-next/theme/Layout/styles.css +6 -0
  94. package/lib-next/theme/LayoutProviders/index.js +22 -10
  95. package/lib-next/theme/Logo/index.js +21 -16
  96. package/lib-next/theme/{ThemeContext.js → MDXComponents/A.js} +4 -2
  97. package/lib-next/theme/MDXComponents/Code.js +28 -0
  98. package/lib-next/theme/MDXComponents/Details.js +20 -0
  99. package/lib-next/theme/MDXComponents/Head.js +26 -0
  100. package/lib-next/theme/{hooks/styles.css → MDXComponents/Heading.js} +4 -3
  101. package/lib-next/theme/MDXComponents/Img.js +24 -0
  102. package/{lib/theme/LastUpdated/styles.module.css → lib-next/theme/MDXComponents/Img.module.css} +2 -2
  103. package/lib-next/theme/MDXComponents/Pre.js +18 -0
  104. package/lib-next/theme/MDXComponents/Ul.js +23 -0
  105. package/lib-next/theme/MDXComponents/Ul.module.css +11 -0
  106. package/lib-next/theme/MDXComponents/index.js +22 -42
  107. package/lib-next/theme/MDXContent/index.js +12 -0
  108. package/lib-next/theme/MDXPage/index.js +38 -39
  109. package/{lib/theme/IconEdit → lib-next/theme/MDXPage}/styles.module.css +2 -3
  110. package/lib-next/theme/Navbar/ColorModeToggle/index.js +25 -0
  111. package/lib-next/theme/Navbar/Content/index.js +70 -0
  112. package/lib-next/theme/Navbar/Content/styles.module.css +15 -0
  113. package/lib-next/theme/Navbar/Layout/index.js +54 -0
  114. package/{src/theme/Navbar → lib-next/theme/Navbar/Layout}/styles.module.css +1 -7
  115. package/lib-next/theme/Navbar/Logo/index.js +17 -0
  116. package/lib-next/theme/Navbar/MobileSidebar/Header/index.js +33 -0
  117. package/lib-next/theme/Navbar/MobileSidebar/Layout/index.js +28 -0
  118. package/lib-next/theme/Navbar/MobileSidebar/PrimaryMenu/index.js +33 -0
  119. package/lib-next/theme/Navbar/MobileSidebar/SecondaryMenu/index.js +36 -0
  120. package/lib-next/theme/Navbar/MobileSidebar/Toggle/index.js +23 -0
  121. package/lib-next/theme/Navbar/MobileSidebar/index.js +31 -0
  122. package/lib-next/theme/Navbar/index.js +7 -137
  123. package/lib-next/theme/NavbarItem/DefaultNavbarItem.js +33 -186
  124. package/lib-next/theme/NavbarItem/DocNavbarItem.js +31 -14
  125. package/lib-next/theme/NavbarItem/DocSidebarNavbarItem.js +73 -0
  126. package/lib-next/theme/NavbarItem/DocsVersionDropdownNavbarItem.js +38 -24
  127. package/lib-next/theme/NavbarItem/DocsVersionNavbarItem.js +4 -1
  128. package/lib-next/theme/NavbarItem/DropdownNavbarItem.js +164 -0
  129. package/lib-next/theme/NavbarItem/{LocaleDropdownNavbarItem.js → LocaleDropdownNavbarItem/index.js} +12 -13
  130. package/lib-next/theme/NavbarItem/LocaleDropdownNavbarItem/styles.module.css +11 -0
  131. package/lib-next/theme/NavbarItem/NavbarNavLink.js +66 -0
  132. package/lib-next/theme/NavbarItem/index.js +27 -15
  133. package/lib-next/theme/{UserPreferencesContext.js → NavbarItem/utils.js} +3 -3
  134. package/lib-next/theme/NotFound.js +40 -34
  135. package/lib-next/theme/PaginatorNavLink/index.js +17 -0
  136. package/lib-next/theme/SearchBar.js +1 -1
  137. package/lib-next/theme/SearchMetadata/index.js +34 -0
  138. package/lib-next/theme/{LayoutHead → SiteMetadata}/index.js +25 -45
  139. package/lib-next/theme/SkipToContent/index.js +9 -8
  140. package/lib-next/theme/SkipToContent/styles.module.css +8 -3
  141. package/lib-next/theme/TOC/index.js +12 -39
  142. package/lib-next/theme/TOC/styles.module.css +2 -2
  143. package/lib-next/theme/TOCCollapsible/index.js +52 -0
  144. package/lib-next/theme/TOCCollapsible/styles.module.css +50 -0
  145. package/lib-next/theme/TOCInline/index.js +10 -31
  146. package/lib-next/theme/TOCItems/index.js +85 -0
  147. package/lib-next/theme/TabItem/index.js +1 -4
  148. package/lib-next/theme/Tabs/__tests__/index.test.js +146 -0
  149. package/lib-next/theme/Tabs/index.js +108 -50
  150. package/lib-next/theme/Tabs/styles.module.css +0 -13
  151. package/lib-next/theme/Tag/index.js +24 -0
  152. package/lib-next/theme/Tag/styles.module.css +70 -0
  153. package/lib-next/theme/TagsListByLetter/index.js +40 -0
  154. package/lib-next/theme/TagsListByLetter/styles.module.css +11 -0
  155. package/lib-next/theme/TagsListInline/index.js +31 -0
  156. package/{lib/theme/BlogPostItem → lib-next/theme/TagsListInline}/styles.module.css +5 -4
  157. package/lib-next/theme/ThemedImage/index.js +10 -14
  158. package/lib-next/theme/ThemedImage/styles.module.css +9 -2
  159. package/lib-next/theme/prism-include-languages.js +17 -15
  160. package/package.json +32 -31
  161. package/src/admonitions.css +35 -0
  162. package/src/deps.d.ts +13 -0
  163. package/src/getSwizzleConfig.ts +244 -0
  164. package/src/index.ts +72 -72
  165. package/{lib-next/prism-include-languages.js → src/prism-include-languages.ts} +0 -0
  166. package/src/theme/Admonition/index.tsx +106 -0
  167. package/src/theme/AnnouncementBar/index.tsx +11 -20
  168. package/src/theme/AnnouncementBar/styles.module.css +26 -35
  169. package/src/theme/BackToTopButton/index.tsx +141 -0
  170. package/src/theme/BackToTopButton/styles.module.css +44 -0
  171. package/src/theme/BlogArchivePage/index.tsx +92 -0
  172. package/src/theme/BlogLayout/index.tsx +42 -0
  173. package/src/theme/BlogListPage/index.tsx +45 -35
  174. package/src/theme/BlogListPaginator/index.tsx +13 -15
  175. package/src/theme/BlogPostAuthor/index.tsx +54 -0
  176. package/src/theme/BlogPostAuthor/styles.module.css +12 -0
  177. package/src/theme/BlogPostAuthors/index.tsx +49 -0
  178. package/src/theme/BlogPostAuthors/styles.module.css +21 -0
  179. package/src/theme/BlogPostItem/index.tsx +103 -93
  180. package/src/theme/BlogPostItem/styles.module.css +5 -1
  181. package/src/theme/BlogPostPage/index.tsx +84 -42
  182. package/src/theme/BlogPostPaginator/index.tsx +13 -19
  183. package/src/theme/BlogSidebar/index.tsx +23 -16
  184. package/src/theme/BlogSidebar/styles.module.css +8 -8
  185. package/src/theme/BlogTagsListPage/index.tsx +24 -70
  186. package/src/theme/BlogTagsPostsPage/index.tsx +54 -65
  187. package/src/theme/CodeBlock/CopyButton/index.tsx +66 -0
  188. package/src/theme/CodeBlock/CopyButton/styles.module.css +66 -0
  189. package/src/theme/CodeBlock/index.tsx +77 -196
  190. package/src/theme/CodeBlock/styles.module.css +13 -28
  191. package/src/theme/ColorModeToggle/index.tsx +67 -0
  192. package/src/theme/ColorModeToggle/styles.module.css +35 -0
  193. package/src/theme/Details/index.tsx +25 -0
  194. package/src/theme/Details/styles.module.css +13 -0
  195. package/src/theme/DocBreadcrumbs/index.tsx +110 -0
  196. package/src/theme/DocBreadcrumbs/styles.module.css +11 -0
  197. package/src/theme/DocCard/index.tsx +116 -0
  198. package/src/theme/DocCard/styles.module.css +34 -0
  199. package/src/theme/DocCardList/index.tsx +38 -0
  200. package/src/theme/DocCategoryGeneratedIndexPage/index.tsx +86 -0
  201. package/src/theme/DocCategoryGeneratedIndexPage/styles.module.css +18 -0
  202. package/src/theme/DocItem/index.tsx +93 -79
  203. package/src/theme/DocItem/styles.module.css +7 -13
  204. package/src/theme/DocItemFooter/index.tsx +91 -0
  205. package/src/theme/DocItemFooter/styles.module.css +18 -0
  206. package/src/theme/DocPage/index.tsx +124 -101
  207. package/src/theme/DocPage/styles.module.css +14 -30
  208. package/src/theme/DocPaginator/index.tsx +16 -24
  209. package/src/theme/DocSidebar/Desktop/CollapseButton/index.tsx +38 -0
  210. package/src/theme/DocSidebar/Desktop/CollapseButton/styles.module.css +44 -0
  211. package/src/theme/DocSidebar/Desktop/Content/index.tsx +55 -0
  212. package/src/theme/DocSidebar/Desktop/Content/styles.module.css +17 -0
  213. package/src/theme/DocSidebar/Desktop/index.tsx +38 -0
  214. package/src/theme/DocSidebar/Desktop/styles.module.css +50 -0
  215. package/src/theme/DocSidebar/Mobile/index.tsx +54 -0
  216. package/src/theme/DocSidebar/index.tsx +14 -343
  217. package/src/theme/DocSidebarItem/index.tsx +282 -0
  218. package/src/theme/DocSidebarItem/styles.module.css +17 -0
  219. package/src/theme/DocSidebarItems/index.tsx +32 -0
  220. package/src/theme/DocTagDocListPage/index.tsx +97 -0
  221. package/src/theme/DocTagsListPage/index.tsx +44 -0
  222. package/src/theme/DocVersionBadge/index.tsx +35 -0
  223. package/src/theme/{DocVersionSuggestions → DocVersionBanner}/index.tsx +76 -47
  224. package/src/theme/EditThisPage/index.tsx +6 -1
  225. package/src/theme/ErrorPageContent.tsx +41 -0
  226. package/src/theme/Footer/Copyright/index.tsx +20 -0
  227. package/src/theme/Footer/Layout/index.tsx +34 -0
  228. package/src/theme/Footer/LinkItem/index.tsx +36 -0
  229. package/src/theme/Footer/Links/MultiColumn/index.tsx +51 -0
  230. package/src/theme/Footer/Links/Simple/index.tsx +42 -0
  231. package/src/theme/Footer/Links/index.tsx +21 -0
  232. package/src/theme/Footer/Logo/index.tsx +41 -0
  233. package/{lib-next/theme/Footer → src/theme/Footer/Logo}/styles.module.css +2 -1
  234. package/src/theme/Footer/index.tsx +13 -113
  235. package/src/theme/Heading/index.tsx +43 -35
  236. package/src/theme/Heading/styles.module.css +27 -2
  237. package/src/theme/IconArrow/index.tsx +3 -5
  238. package/src/theme/IconClose/index.tsx +26 -0
  239. package/src/theme/IconDarkMode/index.tsx +20 -0
  240. package/src/theme/IconEdit/index.tsx +8 -9
  241. package/src/theme/IconExternalLink/index.tsx +30 -0
  242. package/src/theme/IconExternalLink/styles.module.css +10 -0
  243. package/src/theme/IconLanguage/index.tsx +6 -8
  244. package/src/theme/IconLightMode/index.tsx +20 -0
  245. package/src/theme/IconMenu/index.tsx +4 -9
  246. package/src/theme/LastUpdated/index.tsx +35 -39
  247. package/src/theme/Layout/index.tsx +19 -15
  248. package/src/theme/Layout/styles.css +6 -0
  249. package/src/theme/LayoutProviders/index.tsx +22 -10
  250. package/src/theme/Logo/index.tsx +21 -15
  251. package/src/theme/{ThemeContext.ts → MDXComponents/A.tsx} +5 -6
  252. package/src/theme/MDXComponents/Code.tsx +37 -0
  253. package/src/theme/MDXComponents/Details.tsx +26 -0
  254. package/src/theme/MDXComponents/Head.tsx +29 -0
  255. package/src/theme/MDXComponents/Heading.tsx +14 -0
  256. package/src/theme/{LastUpdated/styles.module.css → MDXComponents/Img.module.css} +2 -2
  257. package/src/theme/MDXComponents/Img.tsx +26 -0
  258. package/src/theme/MDXComponents/Pre.tsx +22 -0
  259. package/src/theme/MDXComponents/Ul.module.css +11 -0
  260. package/src/theme/MDXComponents/Ul.tsx +28 -0
  261. package/src/theme/MDXComponents/index.tsx +23 -42
  262. package/src/theme/MDXContent/index.tsx +15 -0
  263. package/src/theme/MDXPage/index.tsx +39 -39
  264. package/src/theme/MDXPage/styles.module.css +10 -0
  265. package/src/theme/Navbar/ColorModeToggle/index.tsx +30 -0
  266. package/src/theme/Navbar/Content/index.tsx +81 -0
  267. package/src/theme/Navbar/Content/styles.module.css +15 -0
  268. package/src/theme/Navbar/Layout/index.tsx +57 -0
  269. package/{lib/theme/Navbar → src/theme/Navbar/Layout}/styles.module.css +1 -7
  270. package/src/theme/Navbar/Logo/index.tsx +19 -0
  271. package/src/theme/Navbar/MobileSidebar/Header/index.tsx +34 -0
  272. package/src/theme/Navbar/MobileSidebar/Layout/index.tsx +31 -0
  273. package/src/theme/Navbar/MobileSidebar/PrimaryMenu/index.tsx +38 -0
  274. package/src/theme/Navbar/MobileSidebar/SecondaryMenu/index.tsx +38 -0
  275. package/src/theme/Navbar/MobileSidebar/Toggle/index.tsx +25 -0
  276. package/src/theme/Navbar/MobileSidebar/index.tsx +33 -0
  277. package/src/theme/Navbar/index.tsx +7 -147
  278. package/src/theme/NavbarItem/DefaultNavbarItem.tsx +37 -194
  279. package/src/theme/NavbarItem/DocNavbarItem.tsx +33 -15
  280. package/src/theme/NavbarItem/DocSidebarNavbarItem.tsx +84 -0
  281. package/src/theme/NavbarItem/DocsVersionDropdownNavbarItem.tsx +44 -28
  282. package/src/theme/NavbarItem/DocsVersionNavbarItem.tsx +7 -3
  283. package/src/theme/NavbarItem/DropdownNavbarItem.tsx +190 -0
  284. package/src/theme/NavbarItem/{LocaleDropdownNavbarItem.tsx → LocaleDropdownNavbarItem/index.tsx} +17 -11
  285. package/src/theme/NavbarItem/LocaleDropdownNavbarItem/styles.module.css +11 -0
  286. package/src/theme/NavbarItem/NavbarNavLink.tsx +64 -0
  287. package/src/theme/NavbarItem/index.tsx +41 -19
  288. package/src/theme/NavbarItem/utils.ts +10 -0
  289. package/src/theme/NotFound.tsx +40 -33
  290. package/src/theme/PaginatorNavLink/index.tsx +20 -0
  291. package/src/theme/SearchBar.tsx +2 -1
  292. package/src/theme/SearchMetadata/index.tsx +43 -0
  293. package/src/theme/{LayoutHead → SiteMetadata}/index.tsx +25 -38
  294. package/src/theme/SkipToContent/index.tsx +9 -8
  295. package/src/theme/SkipToContent/styles.module.css +8 -3
  296. package/src/theme/TOC/index.tsx +13 -44
  297. package/src/theme/TOC/styles.module.css +2 -2
  298. package/src/theme/TOCCollapsible/index.tsx +56 -0
  299. package/src/theme/TOCCollapsible/styles.module.css +50 -0
  300. package/src/theme/TOCInline/index.tsx +14 -35
  301. package/src/theme/TOCItems/index.tsx +100 -0
  302. package/src/theme/TabItem/index.tsx +5 -3
  303. package/src/theme/Tabs/index.tsx +117 -59
  304. package/src/theme/Tabs/styles.module.css +0 -13
  305. package/src/theme/Tag/index.tsx +29 -0
  306. package/src/theme/Tag/styles.module.css +70 -0
  307. package/src/theme/TagsListByLetter/index.tsx +43 -0
  308. package/src/theme/TagsListByLetter/styles.module.css +11 -0
  309. package/src/theme/TagsListInline/index.tsx +35 -0
  310. package/src/theme/TagsListInline/styles.module.css +15 -0
  311. package/src/theme/ThemedImage/index.tsx +12 -13
  312. package/src/theme/ThemedImage/styles.module.css +9 -2
  313. package/src/theme/prism-include-languages.ts +20 -15
  314. package/src/theme-classic.d.ts +997 -0
  315. package/src/translations.ts +84 -58
  316. package/src/types.d.ts +0 -589
  317. package/src/validateThemeConfig.ts +381 -0
  318. package/babel.config.js +0 -35
  319. package/codeTranslations/README.md +0 -20
  320. package/codeTranslations/ar.json +0 -55
  321. package/codeTranslations/base.json +0 -108
  322. package/codeTranslations/da.json +0 -55
  323. package/codeTranslations/de.json +0 -55
  324. package/codeTranslations/es.json +0 -55
  325. package/codeTranslations/fa.json +0 -55
  326. package/codeTranslations/fil.json +0 -55
  327. package/codeTranslations/fr.json +0 -55
  328. package/codeTranslations/he.json +0 -55
  329. package/codeTranslations/hi.json +0 -55
  330. package/codeTranslations/ja.json +0 -55
  331. package/codeTranslations/ko.json +0 -55
  332. package/codeTranslations/pl.json +0 -55
  333. package/codeTranslations/pt-BR.json +0 -55
  334. package/codeTranslations/pt-PT.json +0 -55
  335. package/codeTranslations/ru.json +0 -55
  336. package/codeTranslations/tr.json +0 -55
  337. package/codeTranslations/vi.json +0 -55
  338. package/codeTranslations/zh-Hans.json +0 -55
  339. package/codeTranslations/zh-Hant.json +0 -55
  340. package/lib/__tests__/__snapshots__/translations.test.ts.snap +0 -116
  341. package/lib/__tests__/translations.test.js +0 -112
  342. package/lib/__tests__/validateThemeConfig.test.js +0 -333
  343. package/lib/theme/AnnouncementBar/index.js +0 -74
  344. package/lib/theme/AnnouncementBar/styles.module.css +0 -72
  345. package/lib/theme/BlogListPage/index.js +0 -71
  346. package/lib/theme/BlogListPaginator/index.js +0 -63
  347. package/lib/theme/BlogPostItem/index.js +0 -152
  348. package/lib/theme/BlogPostPage/index.js +0 -75
  349. package/lib/theme/BlogPostPaginator/index.js +0 -64
  350. package/lib/theme/BlogSidebar/index.js +0 -43
  351. package/lib/theme/BlogSidebar/styles.module.css +0 -46
  352. package/lib/theme/BlogTagsListPage/index.js +0 -81
  353. package/lib/theme/BlogTagsPostsPage/index.js +0 -104
  354. package/lib/theme/CodeBlock/index.js +0 -253
  355. package/lib/theme/CodeBlock/styles.module.css +0 -71
  356. package/lib/theme/DocItem/index.js +0 -120
  357. package/lib/theme/DocItem/styles.module.css +0 -28
  358. package/lib/theme/DocPage/index.js +0 -141
  359. package/lib/theme/DocPage/styles.module.css +0 -98
  360. package/lib/theme/DocPaginator/index.js +0 -63
  361. package/lib/theme/DocSidebar/index.js +0 -307
  362. package/lib/theme/DocSidebar/styles.module.css +0 -138
  363. package/lib/theme/DocVersionSuggestions/index.js +0 -111
  364. package/lib/theme/EditThisPage/index.js +0 -31
  365. package/lib/theme/Footer/index.js +0 -108
  366. package/lib/theme/Heading/index.js +0 -60
  367. package/lib/theme/Heading/styles.css +0 -23
  368. package/lib/theme/IconArrow/index.js +0 -28
  369. package/lib/theme/IconEdit/index.js +0 -34
  370. package/lib/theme/IconLanguage/index.js +0 -29
  371. package/lib/theme/IconMenu/index.js +0 -31
  372. package/lib/theme/LastUpdated/index.js +0 -65
  373. package/lib/theme/Layout/index.js +0 -64
  374. package/lib/theme/LayoutHead/index.js +0 -144
  375. package/lib/theme/LayoutProviders/index.js +0 -34
  376. package/lib/theme/Logo/index.js +0 -59
  377. package/lib/theme/MDXComponents/index.js +0 -65
  378. package/lib/theme/MDXPage/index.js +0 -68
  379. package/lib/theme/Navbar/index.js +0 -147
  380. package/lib/theme/NavbarItem/DefaultNavbarItem.js +0 -195
  381. package/lib/theme/NavbarItem/DocNavbarItem.js +0 -55
  382. package/lib/theme/NavbarItem/DocsVersionDropdownNavbarItem.js +0 -75
  383. package/lib/theme/NavbarItem/DocsVersionNavbarItem.js +0 -43
  384. package/lib/theme/NavbarItem/LocaleDropdownNavbarItem.js +0 -72
  385. package/lib/theme/NavbarItem/SearchNavbarItem.js +0 -28
  386. package/lib/theme/NavbarItem/index.js +0 -54
  387. package/lib/theme/NotFound.js +0 -50
  388. package/lib/theme/SearchBar.js +0 -15
  389. package/lib/theme/SearchMetadatas/index.js +0 -33
  390. package/lib/theme/Seo/index.js +0 -49
  391. package/lib/theme/SkipToContent/index.js +0 -61
  392. package/lib/theme/SkipToContent/styles.module.css +0 -16
  393. package/lib/theme/TOC/index.js +0 -59
  394. package/lib/theme/TOC/styles.module.css +0 -23
  395. package/lib/theme/TOCInline/index.js +0 -53
  396. package/lib/theme/TOCInline/styles.module.css +0 -12
  397. package/lib/theme/TabItem/index.js +0 -32
  398. package/lib/theme/Tabs/index.js +0 -150
  399. package/lib/theme/Tabs/styles.module.css +0 -23
  400. package/lib/theme/ThemeContext.js +0 -21
  401. package/lib/theme/ThemeProvider/index.js +0 -38
  402. package/lib/theme/ThemedImage/index.js +0 -48
  403. package/lib/theme/ThemedImage/styles.module.css +0 -11
  404. package/lib/theme/Toggle/index.js +0 -106
  405. package/lib/theme/Toggle/styles.module.css +0 -114
  406. package/lib/theme/UserPreferencesContext.js +0 -18
  407. package/lib/theme/UserPreferencesProvider/index.js +0 -44
  408. package/lib/theme/hooks/styles.css +0 -10
  409. package/lib/theme/hooks/useAnnouncementBar.js +0 -63
  410. package/lib/theme/hooks/useContextualSearchFilters.js +0 -47
  411. package/lib/theme/hooks/useDocs.js +0 -18
  412. package/lib/theme/hooks/useHideableNavbar.js +0 -92
  413. package/lib/theme/hooks/useKeyboardNavigation.js +0 -45
  414. package/lib/theme/hooks/useLocationHash.js +0 -28
  415. package/lib/theme/hooks/useLockBodyScroll.js +0 -26
  416. package/lib/theme/hooks/usePrismTheme.js +0 -36
  417. package/lib/theme/hooks/useScrollPosition.js +0 -49
  418. package/lib/theme/hooks/useTOCHighlight.js +0 -87
  419. package/lib/theme/hooks/useTabGroupChoice.js +0 -53
  420. package/lib/theme/hooks/useTheme.js +0 -99
  421. package/lib/theme/hooks/useThemeContext.js +0 -31
  422. package/lib/theme/hooks/useUserPreferencesContext.js +0 -31
  423. package/lib/theme/hooks/useWindowSize.js +0 -55
  424. package/lib/theme/prism-include-languages.js +0 -39
  425. package/lib-next/__tests__/__snapshots__/translations.test.ts.snap +0 -116
  426. package/lib-next/__tests__/translations.test.js +0 -128
  427. package/lib-next/__tests__/validateThemeConfig.test.js +0 -333
  428. package/lib-next/index.js +0 -198
  429. package/lib-next/theme/DocSidebar/styles.module.css +0 -138
  430. package/lib-next/theme/Heading/styles.css +0 -23
  431. package/lib-next/theme/Navbar/styles.module.css +0 -20
  432. package/lib-next/theme/SearchMetadatas/index.js +0 -20
  433. package/lib-next/theme/Seo/index.js +0 -36
  434. package/lib-next/theme/ThemeProvider/index.js +0 -25
  435. package/lib-next/theme/Toggle/index.js +0 -95
  436. package/lib-next/theme/Toggle/styles.module.css +0 -114
  437. package/lib-next/theme/UserPreferencesProvider/index.js +0 -28
  438. package/lib-next/theme/hooks/useAnnouncementBar.js +0 -49
  439. package/lib-next/theme/hooks/useContextualSearchFilters.js +0 -41
  440. package/lib-next/theme/hooks/useDocs.js +0 -10
  441. package/lib-next/theme/hooks/useHideableNavbar.js +0 -79
  442. package/lib-next/theme/hooks/useKeyboardNavigation.js +0 -35
  443. package/lib-next/theme/hooks/useLocationHash.js +0 -20
  444. package/lib-next/theme/hooks/useLockBodyScroll.js +0 -18
  445. package/lib-next/theme/hooks/usePrismTheme.js +0 -20
  446. package/lib-next/theme/hooks/useScrollPosition.js +0 -38
  447. package/lib-next/theme/hooks/useTOCHighlight.js +0 -84
  448. package/lib-next/theme/hooks/useTabGroupChoice.js +0 -41
  449. package/lib-next/theme/hooks/useTheme.js +0 -82
  450. package/lib-next/theme/hooks/useThemeContext.js +0 -22
  451. package/lib-next/theme/hooks/useUserPreferencesContext.js +0 -22
  452. package/lib-next/theme/hooks/useWindowSize.js +0 -45
  453. package/lib-next/translations.js +0 -145
  454. package/lib-next/types.d.ts +0 -600
  455. package/lib-next/validateThemeConfig.js +0 -317
  456. package/src/__tests__/__snapshots__/translations.test.ts.snap +0 -116
  457. package/src/__tests__/translations.test.ts +0 -116
  458. package/src/__tests__/validateThemeConfig.test.js +0 -333
  459. package/src/prism-include-languages.js +0 -11
  460. package/src/theme/DocSidebar/styles.module.css +0 -138
  461. package/src/theme/Heading/styles.css +0 -23
  462. package/src/theme/SearchMetadatas/index.tsx +0 -28
  463. package/src/theme/Seo/index.tsx +0 -46
  464. package/src/theme/ThemeProvider/index.tsx +0 -24
  465. package/src/theme/Toggle/index.tsx +0 -113
  466. package/src/theme/Toggle/styles.module.css +0 -114
  467. package/src/theme/UserPreferencesContext.ts +0 -12
  468. package/src/theme/UserPreferencesProvider/index.tsx +0 -32
  469. package/src/theme/hooks/styles.css +0 -10
  470. package/src/theme/hooks/useAnnouncementBar.ts +0 -58
  471. package/src/theme/hooks/useContextualSearchFilters.ts +0 -52
  472. package/src/theme/hooks/useDocs.ts +0 -11
  473. package/src/theme/hooks/useHideableNavbar.ts +0 -85
  474. package/src/theme/hooks/useKeyboardNavigation.ts +0 -39
  475. package/src/theme/hooks/useLocationHash.ts +0 -25
  476. package/src/theme/hooks/useLockBodyScroll.ts +0 -20
  477. package/src/theme/hooks/usePrismTheme.ts +0 -22
  478. package/src/theme/hooks/useScrollPosition.ts +0 -45
  479. package/src/theme/hooks/useTOCHighlight.ts +0 -98
  480. package/src/theme/hooks/useTabGroupChoice.ts +0 -46
  481. package/src/theme/hooks/useTheme.ts +0 -92
  482. package/src/theme/hooks/useThemeContext.ts +0 -23
  483. package/src/theme/hooks/useUserPreferencesContext.ts +0 -25
  484. package/src/theme/hooks/useWindowSize.ts +0 -51
  485. package/src/validateThemeConfig.js +0 -317
  486. package/tsconfig.json +0 -12
  487. package/update-code-translations.js +0 -239
  488. package/update-code-translations.test.js +0 -33
@@ -0,0 +1,997 @@
1
+ /**
2
+ * Copyright (c) Facebook, Inc. and its affiliates.
3
+ *
4
+ * This source code is licensed under the MIT license found in the
5
+ * LICENSE file in the root directory of this source tree.
6
+ */
7
+
8
+ declare module '@docusaurus/theme-classic' {
9
+ export type Options = {
10
+ customCss?: string | string[];
11
+ };
12
+ }
13
+
14
+ declare module '@theme/Admonition' {
15
+ import type {ReactNode} from 'react';
16
+
17
+ export interface Props {
18
+ readonly children: ReactNode;
19
+ readonly type: 'note' | 'tip' | 'danger' | 'info' | 'caution';
20
+ readonly icon?: ReactNode;
21
+ readonly title?: string;
22
+ }
23
+ export default function Admonition(props: Props): JSX.Element;
24
+ }
25
+
26
+ declare module '@theme/AnnouncementBar' {
27
+ export default function AnnouncementBar(): JSX.Element | null;
28
+ }
29
+
30
+ declare module '@theme/BackToTopButton' {
31
+ export default function BackToTopButton(): JSX.Element;
32
+ }
33
+
34
+ declare module '@theme/BlogListPaginator' {
35
+ import type {Metadata} from '@theme/BlogListPage';
36
+
37
+ export interface Props {
38
+ readonly metadata: Metadata;
39
+ }
40
+ export default function BlogListPaginator(props: Props): JSX.Element;
41
+ }
42
+
43
+ declare module '@theme/BlogSidebar' {
44
+ import type {BlogSidebar} from '@docusaurus/plugin-content-blog';
45
+
46
+ export interface Props {
47
+ readonly sidebar: BlogSidebar;
48
+ }
49
+
50
+ export default function BlogSidebar(props: Props): JSX.Element;
51
+ }
52
+
53
+ declare module '@theme/BlogPostItem' {
54
+ import type {FrontMatter, Metadata} from '@theme/BlogPostPage';
55
+ import type {Assets} from '@docusaurus/plugin-content-blog';
56
+
57
+ export interface Props {
58
+ readonly frontMatter: FrontMatter;
59
+ readonly assets: Assets;
60
+ readonly metadata: Metadata;
61
+ readonly truncated?: string | boolean;
62
+ readonly isBlogPostPage?: boolean;
63
+ readonly children: JSX.Element;
64
+ }
65
+
66
+ export default function BlogPostItem(props: Props): JSX.Element;
67
+ }
68
+
69
+ declare module '@theme/BlogPostAuthor' {
70
+ import type {Metadata} from '@theme/BlogPostPage';
71
+
72
+ export interface Props {
73
+ readonly author: Metadata['authors'][number];
74
+ }
75
+
76
+ export default function BlogPostAuthor(props: Props): JSX.Element;
77
+ }
78
+
79
+ declare module '@theme/BlogPostAuthors' {
80
+ import type {Metadata} from '@theme/BlogPostPage';
81
+ import type {Assets} from '@docusaurus/plugin-content-blog';
82
+
83
+ export interface Props {
84
+ readonly authors: Metadata['authors'];
85
+ readonly assets: Assets;
86
+ }
87
+
88
+ export default function BlogPostAuthors(props: Props): JSX.Element;
89
+ }
90
+
91
+ declare module '@theme/BlogPostPaginator' {
92
+ type Item = {readonly title: string; readonly permalink: string};
93
+
94
+ export interface Props {
95
+ readonly nextItem?: Item;
96
+ readonly prevItem?: Item;
97
+ }
98
+
99
+ export default function BlogPostPaginator(props: Props): JSX.Element;
100
+ }
101
+
102
+ declare module '@theme/BlogLayout' {
103
+ import type {ReactNode} from 'react';
104
+ import type {Props as LayoutProps} from '@theme/Layout';
105
+ import type {BlogSidebar} from '@docusaurus/plugin-content-blog';
106
+
107
+ export interface Props extends LayoutProps {
108
+ readonly sidebar?: BlogSidebar;
109
+ readonly toc?: ReactNode;
110
+ }
111
+
112
+ export default function BlogLayout(props: Props): JSX.Element;
113
+ }
114
+
115
+ declare module '@theme/CodeBlock' {
116
+ import type {ReactElement} from 'react';
117
+
118
+ export interface Props {
119
+ readonly children: string | ReactElement;
120
+ readonly className?: string;
121
+ readonly metastring?: string;
122
+ readonly title?: string;
123
+ readonly language?: string;
124
+ }
125
+
126
+ export default function CodeBlock(props: Props): JSX.Element;
127
+ }
128
+
129
+ declare module '@theme/CodeBlock/CopyButton' {
130
+ export interface Props {
131
+ readonly code: string;
132
+ }
133
+
134
+ export default function CopyButton(props: Props): JSX.Element;
135
+ }
136
+
137
+ declare module '@theme/DocCard' {
138
+ import type {PropSidebarItem} from '@docusaurus/plugin-content-docs';
139
+
140
+ export interface Props {
141
+ readonly item: PropSidebarItem;
142
+ }
143
+
144
+ export default function DocCard(props: Props): JSX.Element;
145
+ }
146
+
147
+ declare module '@theme/DocCardList' {
148
+ import type {PropSidebarItem} from '@docusaurus/plugin-content-docs';
149
+
150
+ export interface Props {
151
+ readonly items: PropSidebarItem[];
152
+ }
153
+
154
+ export default function DocCardList(props: Props): JSX.Element;
155
+ }
156
+
157
+ declare module '@theme/DocItemFooter' {
158
+ import type {Props} from '@theme/DocItem';
159
+
160
+ export default function DocItemFooter(props: Props): JSX.Element;
161
+ }
162
+
163
+ declare module '@theme/DocPaginator' {
164
+ import type {PropNavigation} from '@docusaurus/plugin-content-docs';
165
+
166
+ // May be simpler to provide a {navigation: PropNavigation} prop?
167
+ export interface Props extends PropNavigation {}
168
+
169
+ export default function DocPaginator(props: Props): JSX.Element;
170
+ }
171
+
172
+ declare module '@theme/DocSidebar' {
173
+ import type {PropSidebarItem} from '@docusaurus/plugin-content-docs';
174
+
175
+ export interface Props {
176
+ readonly path: string;
177
+ readonly sidebar: readonly PropSidebarItem[];
178
+ readonly onCollapse: () => void;
179
+ readonly isHidden: boolean;
180
+ // MobileSecondaryFilter expects Record<string, unknown>
181
+ readonly [key: string]: unknown;
182
+ }
183
+
184
+ export default function DocSidebar(props: Props): JSX.Element;
185
+ }
186
+
187
+ declare module '@theme/DocSidebar/Mobile' {
188
+ import type {Props as DocSidebarProps} from '@theme/DocSidebar';
189
+
190
+ export interface Props extends DocSidebarProps {}
191
+
192
+ export default function DocSidebarMobile(props: Props): JSX.Element;
193
+ }
194
+
195
+ declare module '@theme/DocSidebar/Desktop' {
196
+ import type {Props as DocSidebarProps} from '@theme/DocSidebar';
197
+
198
+ export interface Props extends DocSidebarProps {}
199
+
200
+ export default function DocSidebarDesktop(props: Props): JSX.Element;
201
+ }
202
+
203
+ declare module '@theme/DocSidebar/Desktop/Content' {
204
+ import type {PropSidebarItem} from '@docusaurus/plugin-content-docs';
205
+
206
+ export interface Props {
207
+ readonly className?: string;
208
+ readonly path: string;
209
+ readonly sidebar: readonly PropSidebarItem[];
210
+ }
211
+
212
+ export default function Content(props: Props): JSX.Element;
213
+ }
214
+
215
+ declare module '@theme/DocSidebar/Desktop/CollapseButton' {
216
+ export interface Props {
217
+ onClick: React.MouseEventHandler;
218
+ }
219
+
220
+ export default function CollapseButton(props: Props): JSX.Element;
221
+ }
222
+
223
+ declare module '@theme/DocSidebarItem' {
224
+ import type {PropSidebarItem} from '@docusaurus/plugin-content-docs';
225
+
226
+ export interface Props {
227
+ readonly activePath: string;
228
+ readonly onItemClick?: (item: PropSidebarItem) => void;
229
+ readonly level: number;
230
+ readonly tabIndex?: number;
231
+ readonly item: PropSidebarItem;
232
+ readonly index: number;
233
+ }
234
+
235
+ export default function DocSidebarItem(props: Props): JSX.Element;
236
+ }
237
+
238
+ declare module '@theme/DocSidebarItems' {
239
+ import type {Props as DocSidebarItemProps} from '@theme/DocSidebarItem';
240
+ import type {PropSidebarItem} from '@docusaurus/plugin-content-docs';
241
+
242
+ export interface Props extends Omit<DocSidebarItemProps, 'item' | 'index'> {
243
+ readonly items: readonly PropSidebarItem[];
244
+ }
245
+
246
+ export default function DocSidebarItems(props: Props): JSX.Element;
247
+ }
248
+
249
+ declare module '@theme/DocVersionBanner' {
250
+ export interface Props {
251
+ readonly className?: string;
252
+ }
253
+
254
+ export default function DocVersionBanner(props: Props): JSX.Element;
255
+ }
256
+
257
+ declare module '@theme/DocVersionBadge' {
258
+ export interface Props {
259
+ readonly className?: string;
260
+ }
261
+
262
+ export default function DocVersionBadge(props: Props): JSX.Element;
263
+ }
264
+
265
+ declare module '@theme/DocVersionSuggestions' {
266
+ export default function DocVersionSuggestions(): JSX.Element;
267
+ }
268
+
269
+ declare module '@theme/EditThisPage' {
270
+ export interface Props {
271
+ readonly editUrl: string;
272
+ }
273
+ export default function EditThisPage(props: Props): JSX.Element;
274
+ }
275
+
276
+ declare module '@theme/ErrorPageContent' {
277
+ import type ErrorComponent from '@theme/Error';
278
+
279
+ const ErrorPageContent: typeof ErrorComponent;
280
+ export default ErrorPageContent;
281
+ }
282
+
283
+ declare module '@theme/Footer' {
284
+ export default function Footer(): JSX.Element | null;
285
+ }
286
+
287
+ declare module '@theme/Footer/Logo' {
288
+ import type {FooterLogo} from '@docusaurus/theme-common';
289
+
290
+ export interface Props {
291
+ logo: FooterLogo;
292
+ }
293
+
294
+ export default function FooterLogo(props: Props): JSX.Element;
295
+ }
296
+
297
+ declare module '@theme/Footer/Copyright' {
298
+ export interface Props {
299
+ copyright: string;
300
+ }
301
+
302
+ export default function FooterCopyright(props: Props): JSX.Element;
303
+ }
304
+
305
+ declare module '@theme/Footer/LinkItem' {
306
+ import type {FooterLinkItem} from '@docusaurus/theme-common';
307
+
308
+ export interface Props {
309
+ item: FooterLinkItem;
310
+ }
311
+
312
+ export default function FooterLinkItem(props: Props): JSX.Element;
313
+ }
314
+
315
+ declare module '@theme/Footer/Layout' {
316
+ import type {ReactNode} from 'react';
317
+
318
+ export interface Props {
319
+ style: 'light' | 'dark';
320
+ links: ReactNode;
321
+ logo: ReactNode;
322
+ copyright: ReactNode;
323
+ }
324
+
325
+ export default function FooterLayout(props: Props): JSX.Element;
326
+ }
327
+
328
+ declare module '@theme/Footer/Links' {
329
+ import type {Footer} from '@docusaurus/theme-common';
330
+
331
+ export interface Props {
332
+ links: Footer['links'];
333
+ }
334
+
335
+ export default function FooterLinks(props: Props): JSX.Element;
336
+ }
337
+
338
+ declare module '@theme/Footer/Links/MultiColumn' {
339
+ import type {MultiColumnFooter} from '@docusaurus/theme-common';
340
+
341
+ export interface Props {
342
+ columns: MultiColumnFooter['links'];
343
+ }
344
+
345
+ export default function FooterLinksMultiColumn(props: Props): JSX.Element;
346
+ }
347
+
348
+ declare module '@theme/Footer/Links/Simple' {
349
+ import type {SimpleFooter} from '@docusaurus/theme-common';
350
+
351
+ export interface Props {
352
+ links: SimpleFooter['links'];
353
+ }
354
+
355
+ export default function FooterLinksSimple(props: Props): JSX.Element;
356
+ }
357
+
358
+ declare module '@theme/Heading' {
359
+ import type {ComponentProps} from 'react';
360
+
361
+ type HeadingType = 'h1' | 'h2' | 'h3' | 'h4' | 'h5' | 'h6';
362
+
363
+ export interface Props extends ComponentProps<HeadingType> {
364
+ as: HeadingType;
365
+ }
366
+
367
+ export default function Heading(props: Props): JSX.Element;
368
+ }
369
+
370
+ declare module '@theme/Layout' {
371
+ import type {ReactNode} from 'react';
372
+
373
+ export interface Props {
374
+ readonly children?: ReactNode;
375
+ readonly noFooter?: boolean;
376
+ readonly wrapperClassName?: string;
377
+
378
+ // Not really layout-related, but kept for convenience/retro-compatibility
379
+ readonly title?: string;
380
+ readonly description?: string;
381
+ }
382
+
383
+ export default function Layout(props: Props): JSX.Element;
384
+ }
385
+
386
+ declare module '@theme/LayoutProviders' {
387
+ import type {ReactNode} from 'react';
388
+
389
+ export interface Props {
390
+ readonly children: ReactNode;
391
+ }
392
+
393
+ export default function LayoutProviders(props: Props): JSX.Element;
394
+ }
395
+
396
+ declare module '@theme/SearchMetadata' {
397
+ export interface Props {
398
+ readonly locale?: string;
399
+ readonly version?: string;
400
+ readonly tag?: string;
401
+ }
402
+
403
+ export default function SearchMetadata(props: Props): JSX.Element;
404
+ }
405
+
406
+ declare module '@theme/LastUpdated' {
407
+ export interface Props {
408
+ readonly lastUpdatedAt?: number;
409
+ readonly formattedLastUpdatedAt?: string;
410
+ readonly lastUpdatedBy?: string;
411
+ }
412
+
413
+ export default function LastUpdated(props: Props): JSX.Element;
414
+ }
415
+
416
+ declare module '@theme/SkipToContent' {
417
+ export default function SkipToContent(): JSX.Element;
418
+ }
419
+
420
+ declare module '@theme/MDXComponents/A' {
421
+ import type {ComponentProps} from 'react';
422
+
423
+ export interface Props extends ComponentProps<'a'> {}
424
+
425
+ export default function MDXA(props: Props): JSX.Element;
426
+ }
427
+
428
+ declare module '@theme/MDXComponents/Code' {
429
+ import type {ComponentProps} from 'react';
430
+
431
+ export interface Props extends ComponentProps<'code'> {}
432
+
433
+ export default function MDXCode(props: Props): JSX.Element;
434
+ }
435
+
436
+ declare module '@theme/MDXComponents/Details' {
437
+ import type {ComponentProps} from 'react';
438
+
439
+ export interface Props extends ComponentProps<'details'> {}
440
+
441
+ export default function MDXDetails(props: Props): JSX.Element;
442
+ }
443
+
444
+ declare module '@theme/MDXComponents/Ul' {
445
+ import type {ComponentProps} from 'react';
446
+
447
+ export interface Props extends ComponentProps<'ul'> {}
448
+
449
+ export default function MDXUl(props: Props): JSX.Element;
450
+ }
451
+
452
+ declare module '@theme/MDXComponents/Img' {
453
+ import type {ComponentProps} from 'react';
454
+
455
+ export interface Props extends ComponentProps<'img'> {}
456
+
457
+ export default function MDXImg(props: Props): JSX.Element;
458
+ }
459
+
460
+ declare module '@theme/MDXComponents/Head' {
461
+ import type {ComponentProps} from 'react';
462
+
463
+ export interface Props extends ComponentProps<'head'> {}
464
+
465
+ export default function MDXHead(props: Props): JSX.Element;
466
+ }
467
+
468
+ declare module '@theme/MDXComponents/Heading' {
469
+ import type {ComponentProps} from 'react';
470
+ import type Heading from '@theme/Heading';
471
+
472
+ export interface Props extends ComponentProps<typeof Heading> {}
473
+
474
+ export default function MDXHeading(props: Props): JSX.Element;
475
+ }
476
+
477
+ declare module '@theme/MDXComponents/Pre' {
478
+ import type {ComponentProps} from 'react';
479
+
480
+ export interface Props extends ComponentProps<'pre'> {}
481
+
482
+ export default function MDXPre(props: Props): JSX.Element;
483
+ }
484
+
485
+ declare module '@theme/MDXComponents' {
486
+ import type {ComponentType, ComponentProps} from 'react';
487
+
488
+ import type MDXHead from '@theme/MDXComponents/Head';
489
+ import type MDXCode from '@theme/MDXComponents/Code';
490
+ import type MDXA from '@theme/MDXComponents/A';
491
+ import type MDXPre from '@theme/MDXComponents/Pre';
492
+ import type MDXDetails from '@theme/MDXComponents/Details';
493
+ import type MDXUl from '@theme/MDXComponents/Ul';
494
+ import type MDXImg from '@theme/MDXComponents/Img';
495
+
496
+ export type MDXComponentsObject = {
497
+ readonly head: typeof MDXHead;
498
+ readonly code: typeof MDXCode;
499
+ readonly a: typeof MDXA;
500
+ readonly pre: typeof MDXPre;
501
+ readonly details: typeof MDXDetails;
502
+ readonly ul: typeof MDXUl;
503
+ readonly img: typeof MDXImg;
504
+ readonly h1: (props: ComponentProps<'h1'>) => JSX.Element;
505
+ readonly h2: (props: ComponentProps<'h2'>) => JSX.Element;
506
+ readonly h3: (props: ComponentProps<'h3'>) => JSX.Element;
507
+ readonly h4: (props: ComponentProps<'h4'>) => JSX.Element;
508
+ readonly h5: (props: ComponentProps<'h5'>) => JSX.Element;
509
+ readonly h6: (props: ComponentProps<'h6'>) => JSX.Element;
510
+ } & {[tagName: string]: ComponentType<unknown>};
511
+
512
+ const MDXComponents: MDXComponentsObject;
513
+ export default MDXComponents;
514
+ }
515
+
516
+ declare module '@theme/MDXContent' {
517
+ import type {ReactNode} from 'react';
518
+
519
+ export interface Props {
520
+ readonly children: ReactNode;
521
+ }
522
+
523
+ export default function MDXContent(props: Props): JSX.Element;
524
+ }
525
+
526
+ declare module '@theme/Navbar' {
527
+ export default function Navbar(): JSX.Element;
528
+ }
529
+
530
+ declare module '@theme/Navbar/ColorModeToggle' {
531
+ export interface Props {
532
+ readonly className?: string;
533
+ }
534
+
535
+ export default function NavbarColorModeToggle(
536
+ props: Props,
537
+ ): JSX.Element | null;
538
+ }
539
+
540
+ declare module '@theme/Navbar/Logo' {
541
+ export default function NavbarLogo(): JSX.Element;
542
+ }
543
+
544
+ declare module '@theme/Navbar/Content' {
545
+ export default function NavbarContent(): JSX.Element;
546
+ }
547
+
548
+ declare module '@theme/Navbar/Layout' {
549
+ export interface Props {
550
+ readonly children: React.ReactNode;
551
+ }
552
+
553
+ export default function NavbarLayout(props: Props): JSX.Element;
554
+ }
555
+
556
+ declare module '@theme/Navbar/MobileSidebar' {
557
+ export default function NavbarMobileSidebar(): JSX.Element;
558
+ }
559
+
560
+ declare module '@theme/Navbar/MobileSidebar/Layout' {
561
+ import type {ReactNode} from 'react';
562
+
563
+ interface Props {
564
+ header: ReactNode;
565
+ primaryMenu: ReactNode;
566
+ secondaryMenu: ReactNode;
567
+ }
568
+
569
+ export default function NavbarMobileSidebarLayout(props: Props): JSX.Element;
570
+ }
571
+
572
+ declare module '@theme/Navbar/MobileSidebar/Toggle' {
573
+ export default function NavbarMobileSidebarToggle(): JSX.Element;
574
+ }
575
+
576
+ declare module '@theme/Navbar/MobileSidebar/PrimaryMenu' {
577
+ export default function NavbarMobileSidebarPrimaryMenu(): JSX.Element;
578
+ }
579
+
580
+ declare module '@theme/Navbar/MobileSidebar/SecondaryMenu' {
581
+ export default function NavbarMobileSidebarSecondaryMenu(): JSX.Element;
582
+ }
583
+
584
+ declare module '@theme/Navbar/MobileSidebar/Header' {
585
+ export default function NavbarMobileSidebarHeader(): JSX.Element;
586
+ }
587
+
588
+ declare module '@theme/NavbarItem/DefaultNavbarItem' {
589
+ import type {Props as NavbarNavLinkProps} from '@theme/NavbarItem/NavbarNavLink';
590
+
591
+ export type DesktopOrMobileNavBarItemProps = NavbarNavLinkProps & {
592
+ readonly isDropdownItem?: boolean;
593
+ readonly className?: string;
594
+ readonly position?: 'left' | 'right';
595
+ };
596
+
597
+ export interface Props extends DesktopOrMobileNavBarItemProps {
598
+ readonly mobile?: boolean;
599
+ }
600
+
601
+ export default function DefaultNavbarItem(props: Props): JSX.Element;
602
+ }
603
+
604
+ declare module '@theme/NavbarItem/NavbarNavLink' {
605
+ import type {ReactNode} from 'react';
606
+ import type {Props as LinkProps} from '@docusaurus/Link';
607
+
608
+ export interface Props extends LinkProps {
609
+ readonly activeBasePath?: string;
610
+ readonly activeBaseRegex?: string;
611
+ readonly exact?: boolean;
612
+ readonly label?: ReactNode;
613
+ readonly prependBaseUrlToHref?: string;
614
+ }
615
+
616
+ export default function NavbarNavLink(props: Props): JSX.Element;
617
+ }
618
+
619
+ declare module '@theme/NavbarItem/DropdownNavbarItem' {
620
+ import type {Props as NavbarNavLinkProps} from '@theme/NavbarItem/NavbarNavLink';
621
+
622
+ import type {LinkLikeNavbarItemProps} from '@theme/NavbarItem';
623
+
624
+ export type DesktopOrMobileNavBarItemProps = NavbarNavLinkProps & {
625
+ readonly position?: 'left' | 'right';
626
+ readonly items: readonly LinkLikeNavbarItemProps[];
627
+ readonly className?: string;
628
+ };
629
+
630
+ export interface Props extends DesktopOrMobileNavBarItemProps {
631
+ readonly mobile?: boolean;
632
+ }
633
+
634
+ export default function DropdownNavbarItem(props: Props): JSX.Element;
635
+ }
636
+
637
+ declare module '@theme/NavbarItem/SearchNavbarItem' {
638
+ export interface Props {
639
+ readonly mobile?: boolean;
640
+ }
641
+
642
+ export default function SearchNavbarItem(props: Props): JSX.Element;
643
+ }
644
+
645
+ declare module '@theme/NavbarItem/LocaleDropdownNavbarItem' {
646
+ import type {Props as DropdownNavbarItemProps} from '@theme/NavbarItem/DropdownNavbarItem';
647
+ import type {LinkLikeNavbarItemProps} from '@theme/NavbarItem';
648
+
649
+ export interface Props extends DropdownNavbarItemProps {
650
+ readonly dropdownItemsBefore: LinkLikeNavbarItemProps[];
651
+ readonly dropdownItemsAfter: LinkLikeNavbarItemProps[];
652
+ }
653
+
654
+ export default function LocaleDropdownNavbarItem(props: Props): JSX.Element;
655
+ }
656
+
657
+ declare module '@theme/NavbarItem/DocsVersionDropdownNavbarItem' {
658
+ import type {Props as DropdownNavbarItemProps} from '@theme/NavbarItem/DropdownNavbarItem';
659
+ import type {LinkLikeNavbarItemProps} from '@theme/NavbarItem';
660
+
661
+ export interface Props extends DropdownNavbarItemProps {
662
+ readonly docsPluginId?: string;
663
+ readonly dropdownActiveClassDisabled?: boolean;
664
+ readonly dropdownItemsBefore: LinkLikeNavbarItemProps[];
665
+ readonly dropdownItemsAfter: LinkLikeNavbarItemProps[];
666
+ }
667
+
668
+ export default function DocsVersionDropdownNavbarItem(
669
+ props: Props,
670
+ ): JSX.Element;
671
+ }
672
+
673
+ declare module '@theme/NavbarItem/DocsVersionNavbarItem' {
674
+ import type {Props as DefaultNavbarItemProps} from '@theme/NavbarItem/DefaultNavbarItem';
675
+
676
+ export interface Props extends DefaultNavbarItemProps {
677
+ readonly docsPluginId?: string;
678
+ }
679
+
680
+ export default function DocsVersionNavbarItem(props: Props): JSX.Element;
681
+ }
682
+
683
+ declare module '@theme/NavbarItem/DocNavbarItem' {
684
+ import type {Props as DefaultNavbarItemProps} from '@theme/NavbarItem/DefaultNavbarItem';
685
+
686
+ export interface Props extends DefaultNavbarItemProps {
687
+ readonly docId: string;
688
+ readonly docsPluginId?: string;
689
+ }
690
+
691
+ export default function DocsSidebarNavbarItem(props: Props): JSX.Element;
692
+ }
693
+
694
+ declare module '@theme/NavbarItem/DocSidebarNavbarItem' {
695
+ import type {Props as DefaultNavbarItemProps} from '@theme/NavbarItem/DefaultNavbarItem';
696
+
697
+ export interface Props extends DefaultNavbarItemProps {
698
+ readonly sidebarId: string;
699
+ readonly docsPluginId?: string;
700
+ }
701
+
702
+ export default function DocSidebarNavbarItem(props: Props): JSX.Element;
703
+ }
704
+
705
+ declare module '@theme/NavbarItem' {
706
+ import type {ComponentProps} from 'react';
707
+ import type {Props as DefaultNavbarItemProps} from '@theme/NavbarItem/DefaultNavbarItem';
708
+ import type {Props as DocNavbarItemProps} from '@theme/NavbarItem/DocNavbarItem';
709
+ import type {Props as DocSidebarNavbarItemProps} from '@theme/NavbarItem/DocSidebarNavbarItem';
710
+ import type {Props as DocsVersionNavbarItemProps} from '@theme/NavbarItem/DocsVersionNavbarItem';
711
+ import type {Props as DropdownNavbarItemProps} from '@theme/NavbarItem/DropdownNavbarItem';
712
+ import type {Props as DocsVersionDropdownNavbarItemProps} from '@theme/NavbarItem/DocsVersionDropdownNavbarItem';
713
+ import type {Props as LocaleDropdownNavbarItemProps} from '@theme/NavbarItem/LocaleDropdownNavbarItem';
714
+ import type {Props as SearchNavbarItemProps} from '@theme/NavbarItem/SearchNavbarItem';
715
+
716
+ export type LinkLikeNavbarItemProps =
717
+ | ({readonly type?: 'default'} & DefaultNavbarItemProps)
718
+ | ({readonly type: 'doc'} & DocNavbarItemProps)
719
+ | ({readonly type: 'docsVersion'} & DocsVersionNavbarItemProps)
720
+ | ({readonly type: 'docSidebar'} & DocSidebarNavbarItemProps);
721
+
722
+ export type Props = ComponentProps<'a'> & {
723
+ readonly position?: 'left' | 'right';
724
+ } & (
725
+ | LinkLikeNavbarItemProps
726
+ | ({readonly type?: 'dropdown'} & DropdownNavbarItemProps)
727
+ | ({
728
+ readonly type: 'docsVersionDropdown';
729
+ } & DocsVersionDropdownNavbarItemProps)
730
+ | ({readonly type: 'localeDropdown'} & LocaleDropdownNavbarItemProps)
731
+ | ({
732
+ readonly type: 'search';
733
+ } & SearchNavbarItemProps)
734
+ );
735
+
736
+ export type Types = Props['type'];
737
+
738
+ export default function NavbarItem(props: Props): JSX.Element;
739
+ }
740
+
741
+ declare module '@theme/NavbarItem/utils' {
742
+ export function getInfimaActiveClassName(mobile?: boolean): string;
743
+ }
744
+
745
+ declare module '@theme/PaginatorNavLink' {
746
+ import type {ReactNode} from 'react';
747
+ import type {PropNavigationLink} from '@docusaurus/plugin-content-docs';
748
+
749
+ export interface Props extends Omit<PropNavigationLink, 'title'> {
750
+ readonly title: ReactNode;
751
+ readonly subLabel?: JSX.Element;
752
+ }
753
+
754
+ export default function PaginatorNavLink(props: Props): JSX.Element;
755
+ }
756
+
757
+ declare module '@theme/SearchBar' {
758
+ export default function SearchBar(): JSX.Element;
759
+ }
760
+
761
+ declare module '@theme/TabItem' {
762
+ import type {ReactNode} from 'react';
763
+
764
+ export interface Props {
765
+ readonly children: ReactNode;
766
+ readonly value: string;
767
+ readonly default?: boolean;
768
+ readonly label?: string;
769
+ readonly hidden?: boolean;
770
+ readonly className?: string;
771
+ readonly attributes?: {[key: string]: unknown};
772
+ }
773
+
774
+ export default function TabItem(props: Props): JSX.Element;
775
+ }
776
+
777
+ declare module '@theme/Tabs' {
778
+ import type {ReactElement} from 'react';
779
+ import type {Props as TabItemProps} from '@theme/TabItem';
780
+
781
+ export interface Props {
782
+ readonly lazy?: boolean;
783
+ readonly block?: boolean;
784
+ readonly children: readonly ReactElement<TabItemProps>[];
785
+ readonly defaultValue?: string | null;
786
+ readonly values?: readonly {
787
+ value: string;
788
+ label?: string;
789
+ attributes?: {[key: string]: unknown};
790
+ }[];
791
+ readonly groupId?: string;
792
+ readonly className?: string;
793
+ }
794
+
795
+ export default function Tabs(props: Props): JSX.Element;
796
+ }
797
+
798
+ declare module '@theme/ThemedImage' {
799
+ import type {ComponentProps} from 'react';
800
+
801
+ export interface Props extends Omit<ComponentProps<'img'>, 'src'> {
802
+ readonly sources: {
803
+ readonly light: string;
804
+ readonly dark: string;
805
+ };
806
+ }
807
+
808
+ export default function ThemedImage(props: Props): JSX.Element;
809
+ }
810
+
811
+ declare module '@theme/Details' {
812
+ import {Details, type DetailsProps} from '@docusaurus/theme-common';
813
+
814
+ export interface Props extends DetailsProps {}
815
+ export default Details;
816
+ }
817
+
818
+ declare module '@theme/TOCItems' {
819
+ import type {TOCItem} from '@docusaurus/types';
820
+
821
+ export interface Props {
822
+ readonly toc: readonly TOCItem[];
823
+ readonly minHeadingLevel?: number;
824
+ readonly maxHeadingLevel?: number;
825
+ readonly className?: string;
826
+ readonly linkClassName?: string | null;
827
+ readonly linkActiveClassName?: string;
828
+ }
829
+
830
+ export default function TOCItems(props: Props): JSX.Element;
831
+ }
832
+
833
+ declare module '@theme/TOC' {
834
+ import type {TOCItem} from '@docusaurus/types';
835
+
836
+ // minHeadingLevel only exists as a per-doc option, and won't have a default
837
+ // set by Joi. See TOC, TOCInline, TOCCollapsible for examples
838
+ export interface Props {
839
+ readonly toc: readonly TOCItem[];
840
+ readonly minHeadingLevel?: number;
841
+ readonly maxHeadingLevel?: number;
842
+ readonly className?: string;
843
+ }
844
+
845
+ export default function TOC(props: Props): JSX.Element;
846
+ }
847
+
848
+ declare module '@theme/TOCInline' {
849
+ import type {TOCItem} from '@docusaurus/types';
850
+
851
+ export interface Props {
852
+ readonly toc: readonly TOCItem[];
853
+ readonly minHeadingLevel?: number;
854
+ readonly maxHeadingLevel?: number;
855
+ }
856
+
857
+ export default function TOCInline(props: Props): JSX.Element;
858
+ }
859
+
860
+ declare module '@theme/TOCCollapsible' {
861
+ import type {TOCItem} from '@docusaurus/types';
862
+
863
+ export interface Props {
864
+ readonly className?: string;
865
+ readonly minHeadingLevel?: number;
866
+ readonly maxHeadingLevel?: number;
867
+ readonly toc: readonly TOCItem[];
868
+ }
869
+
870
+ export default function TOCCollapsible(props: Props): JSX.Element;
871
+ }
872
+
873
+ declare module '@theme/ColorModeToggle' {
874
+ import type {ColorMode} from '@docusaurus/theme-common';
875
+
876
+ export interface Props {
877
+ readonly className?: string;
878
+ readonly value: ColorMode;
879
+ /**
880
+ * The parameter represents the "to-be" value. For example, if currently in
881
+ * dark mode, clicking the button should call `onChange("light")`
882
+ */
883
+ readonly onChange: (colorMode: ColorMode) => void;
884
+ }
885
+
886
+ export default function ColorModeToggle(props: Props): JSX.Element;
887
+ }
888
+
889
+ declare module '@theme/Logo' {
890
+ import type {ComponentProps} from 'react';
891
+
892
+ export interface Props extends ComponentProps<'a'> {
893
+ readonly imageClassName?: string;
894
+ readonly titleClassName?: string;
895
+ }
896
+
897
+ export default function Logo(props: Props): JSX.Element;
898
+ }
899
+
900
+ declare module '@theme/IconArrow' {
901
+ import type {ComponentProps} from 'react';
902
+
903
+ export interface Props extends ComponentProps<'svg'> {}
904
+
905
+ export default function IconArrow(props: Props): JSX.Element;
906
+ }
907
+
908
+ declare module '@theme/IconDarkMode' {
909
+ import type {ComponentProps} from 'react';
910
+
911
+ export interface Props extends ComponentProps<'svg'> {}
912
+
913
+ export default function IconDarkMode(props: Props): JSX.Element;
914
+ }
915
+
916
+ declare module '@theme/IconEdit' {
917
+ import type {ComponentProps} from 'react';
918
+
919
+ export interface Props extends ComponentProps<'svg'> {}
920
+
921
+ export default function IconEdit(props: Props): JSX.Element;
922
+ }
923
+
924
+ declare module '@theme/IconLightMode' {
925
+ import type {ComponentProps} from 'react';
926
+
927
+ export interface Props extends ComponentProps<'svg'> {}
928
+
929
+ export default function IconLightMode(props: Props): JSX.Element;
930
+ }
931
+
932
+ declare module '@theme/IconMenu' {
933
+ import type {ComponentProps} from 'react';
934
+
935
+ export interface Props extends ComponentProps<'svg'> {}
936
+
937
+ export default function IconMenu(props: Props): JSX.Element;
938
+ }
939
+
940
+ declare module '@theme/IconClose' {
941
+ import type {ComponentProps} from 'react';
942
+
943
+ export interface Props extends ComponentProps<'svg'> {}
944
+
945
+ export default function IconClose(props: Props): JSX.Element;
946
+ }
947
+
948
+ declare module '@theme/IconLanguage' {
949
+ import type {ComponentProps} from 'react';
950
+
951
+ export interface Props extends ComponentProps<'svg'> {}
952
+
953
+ export default function IconLanguage(props: Props): JSX.Element;
954
+ }
955
+
956
+ declare module '@theme/IconExternalLink' {
957
+ import type {ComponentProps} from 'react';
958
+
959
+ export interface Props extends ComponentProps<'svg'> {}
960
+
961
+ export default function IconExternalLink(props: Props): JSX.Element;
962
+ }
963
+
964
+ declare module '@theme/TagsListByLetter' {
965
+ import type {TagsListItem} from '@docusaurus/theme-common';
966
+
967
+ export interface Props {
968
+ readonly tags: readonly TagsListItem[];
969
+ }
970
+ export default function TagsListByLetter(props: Props): JSX.Element;
971
+ }
972
+
973
+ declare module '@theme/TagsListInline' {
974
+ import type {Tag} from '@docusaurus/utils';
975
+
976
+ export interface Props {
977
+ readonly tags: readonly Tag[];
978
+ }
979
+ export default function TagsListInline(props: Props): JSX.Element;
980
+ }
981
+
982
+ declare module '@theme/Tag' {
983
+ import type {TagsListItem} from '@docusaurus/theme-common';
984
+ import type {Optional} from 'utility-types';
985
+
986
+ export interface Props extends Optional<TagsListItem, 'count'> {}
987
+
988
+ export default function Tag(props: Props): JSX.Element;
989
+ }
990
+
991
+ declare module '@theme/prism-include-languages' {
992
+ import type * as PrismNamespace from 'prismjs';
993
+
994
+ export default function prismIncludeLanguages(
995
+ PrismObject: typeof PrismNamespace,
996
+ ): void;
997
+ }