@docusaurus/theme-classic 2.0.0-beta.1 → 2.0.0-beta.10

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 (367) hide show
  1. package/README.md +1 -1
  2. package/lib/__tests__/validateThemeConfig.test.js +277 -3
  3. package/lib/admonitions.css +35 -0
  4. package/lib/deps.d.ts +13 -0
  5. package/lib/index.js +41 -16
  6. package/lib/prism-include-languages.js +9 -5
  7. package/lib/theme/AnnouncementBar/index.js +10 -16
  8. package/lib/theme/AnnouncementBar/styles.module.css +25 -30
  9. package/lib/theme/BackToTopButton/index.js +140 -0
  10. package/lib/theme/BackToTopButton/styles.module.css +42 -0
  11. package/lib/theme/BlogArchivePage/index.js +89 -0
  12. package/lib/theme/BlogLayout/index.js +51 -0
  13. package/lib/theme/BlogListPage/index.js +10 -21
  14. package/lib/theme/BlogPostAuthor/index.js +51 -0
  15. package/lib/theme/BlogPostAuthor/styles.module.css +12 -0
  16. package/lib/theme/BlogPostAuthors/index.js +47 -0
  17. package/lib/theme/BlogPostAuthors/styles.module.css +11 -0
  18. package/lib/theme/BlogPostItem/index.js +58 -67
  19. package/lib/theme/BlogPostPage/index.js +37 -24
  20. package/lib/theme/BlogSidebar/index.js +5 -7
  21. package/lib/theme/BlogSidebar/styles.module.css +2 -2
  22. package/lib/theme/BlogTagsListPage/index.js +8 -44
  23. package/lib/theme/BlogTagsPostsPage/index.js +24 -38
  24. package/lib/theme/CodeBlock/index.js +18 -138
  25. package/lib/theme/CodeBlock/styles.module.css +6 -9
  26. package/lib/theme/Details/index.js +30 -0
  27. package/lib/theme/Details/styles.module.css +13 -0
  28. package/lib/theme/DocCard/index.js +84 -0
  29. package/lib/theme/DocCard/styles.module.css +43 -0
  30. package/lib/theme/DocCardList/index.js +28 -0
  31. package/lib/theme/DocCategoryGeneratedIndexPage/index.js +57 -0
  32. package/lib/theme/DocCategoryGeneratedIndexPage/styles.module.css +18 -0
  33. package/lib/theme/DocItem/index.js +29 -46
  34. package/lib/theme/DocItem/styles.module.css +5 -9
  35. package/lib/theme/DocItemFooter/index.js +79 -0
  36. package/lib/theme/DocItemFooter/styles.module.css +18 -0
  37. package/lib/theme/DocPage/index.js +35 -52
  38. package/lib/theme/DocPage/styles.module.css +8 -23
  39. package/lib/theme/DocPaginator/index.js +6 -7
  40. package/lib/theme/DocSidebar/index.js +53 -235
  41. package/lib/theme/DocSidebar/styles.module.css +0 -18
  42. package/lib/theme/DocSidebarItem/index.js +209 -0
  43. package/lib/theme/DocSidebarItem/styles.module.css +19 -0
  44. package/lib/theme/DocTagDocListPage/index.js +89 -0
  45. package/lib/theme/DocTagsListPage/index.js +44 -0
  46. package/lib/theme/DocVersionBadge/index.js +34 -0
  47. package/lib/theme/{DocVersionSuggestions → DocVersionBanner}/index.js +39 -20
  48. package/lib/theme/EditThisPage/index.js +3 -1
  49. package/lib/theme/ErrorPageContent.js +43 -0
  50. package/lib/theme/Footer/index.js +16 -5
  51. package/lib/theme/Heading/index.js +17 -22
  52. package/lib/theme/Heading/styles.css +5 -6
  53. package/lib/theme/Heading/styles.module.css +9 -5
  54. package/lib/theme/IconArrow/index.js +2 -2
  55. package/lib/theme/IconClose/index.js +31 -0
  56. package/lib/theme/IconEdit/index.js +3 -3
  57. package/lib/theme/IconExternalLink/index.js +3 -3
  58. package/lib/theme/IconLanguage/index.js +3 -3
  59. package/lib/theme/IconMenu/index.js +3 -3
  60. package/lib/theme/LastUpdated/index.js +4 -2
  61. package/lib/theme/Layout/index.js +5 -1
  62. package/lib/theme/LayoutHead/index.js +22 -17
  63. package/lib/theme/LayoutProviders/index.js +11 -5
  64. package/lib/theme/Logo/index.js +16 -14
  65. package/lib/theme/MDXComponents/index.js +45 -4
  66. package/lib/theme/MDXComponents/styles.css +11 -0
  67. package/lib/theme/MDXPage/index.js +2 -1
  68. package/lib/theme/Navbar/index.js +162 -42
  69. package/lib/theme/Navbar/styles.module.css +10 -3
  70. package/lib/theme/NavbarItem/DefaultNavbarItem.js +27 -123
  71. package/lib/theme/NavbarItem/DocNavbarItem.js +7 -8
  72. package/lib/theme/NavbarItem/DocsVersionDropdownNavbarItem.js +19 -12
  73. package/lib/theme/NavbarItem/DropdownNavbarItem.js +155 -0
  74. package/lib/theme/NavbarItem/{LocaleDropdownNavbarItem.js → LocaleDropdownNavbarItem/index.js} +6 -10
  75. package/lib/theme/NavbarItem/LocaleDropdownNavbarItem/styles.module.css +11 -0
  76. package/lib/theme/NavbarItem/index.js +31 -11
  77. package/lib/theme/{SearchMetadatas → SearchMetadata}/index.js +2 -2
  78. package/lib/theme/Seo/index.js +10 -7
  79. package/lib/theme/SkipToContent/index.js +12 -4
  80. package/lib/theme/SkipToContent/styles.module.css +1 -0
  81. package/lib/theme/TOC/index.js +9 -29
  82. package/lib/theme/TOC/styles.module.css +1 -1
  83. package/lib/theme/TOCCollapsible/index.js +53 -0
  84. package/lib/theme/TOCCollapsible/styles.module.css +50 -0
  85. package/lib/theme/TOCInline/index.js +7 -27
  86. package/lib/theme/TOCItems/index.js +78 -0
  87. package/lib/theme/Tabs/__tests__/index.test.js +123 -0
  88. package/lib/theme/Tabs/index.js +73 -50
  89. package/lib/theme/Tabs/styles.module.css +0 -13
  90. package/lib/theme/Tag/index.js +40 -0
  91. package/lib/theme/Tag/styles.module.css +70 -0
  92. package/lib/theme/TagsListByLetter/index.js +48 -0
  93. package/lib/theme/TagsListByLetter/styles.module.css +11 -0
  94. package/lib/theme/TagsListInline/index.js +44 -0
  95. package/lib/theme/TagsListInline/styles.module.css +15 -0
  96. package/lib/theme/ThemeProvider/index.js +8 -3
  97. package/lib/theme/ThemedImage/index.js +6 -7
  98. package/lib/theme/Toggle/index.js +41 -44
  99. package/lib/theme/Toggle/styles.module.css +91 -3
  100. package/lib/theme/UserPreferencesProvider/index.js +9 -12
  101. package/lib/theme/hooks/useHideableNavbar.js +14 -32
  102. package/lib/theme/hooks/useTabGroupChoice.js +2 -4
  103. package/lib/theme/hooks/useTheme.js +3 -5
  104. package/lib/theme/hooks/useWindowSize.js +33 -20
  105. package/lib/theme/prism-include-languages.js +4 -3
  106. package/lib/theme-classic.d.ts +806 -0
  107. package/lib/translations.js +4 -4
  108. package/lib/types.d.ts +0 -599
  109. package/lib/validateThemeConfig.js +230 -246
  110. package/lib-next/__tests__/validateThemeConfig.test.js +277 -3
  111. package/lib-next/admonitions.css +35 -0
  112. package/lib-next/deps.d.ts +13 -0
  113. package/lib-next/index.js +45 -13
  114. package/lib-next/prism-include-languages.js +0 -2
  115. package/lib-next/theme/AnnouncementBar/index.js +9 -18
  116. package/lib-next/theme/AnnouncementBar/styles.module.css +25 -30
  117. package/lib-next/theme/BackToTopButton/index.js +131 -0
  118. package/lib-next/theme/BackToTopButton/styles.module.css +42 -0
  119. package/lib-next/theme/BlogArchivePage/index.js +80 -0
  120. package/lib-next/theme/BlogLayout/index.js +40 -0
  121. package/lib-next/theme/BlogListPage/index.js +17 -25
  122. package/lib-next/theme/BlogPostAuthor/index.js +46 -0
  123. package/lib-next/theme/BlogPostAuthor/styles.module.css +12 -0
  124. package/lib-next/theme/BlogPostAuthors/index.js +34 -0
  125. package/lib-next/theme/BlogPostAuthors/styles.module.css +11 -0
  126. package/lib-next/theme/BlogPostItem/index.js +79 -86
  127. package/lib-next/theme/BlogPostPage/index.js +70 -35
  128. package/lib-next/theme/BlogSidebar/index.js +11 -13
  129. package/lib-next/theme/BlogSidebar/styles.module.css +2 -2
  130. package/lib-next/theme/BlogTagsListPage/index.js +14 -55
  131. package/lib-next/theme/BlogTagsPostsPage/index.js +29 -39
  132. package/lib-next/theme/CodeBlock/index.js +17 -149
  133. package/lib-next/theme/CodeBlock/styles.module.css +6 -9
  134. package/lib-next/theme/Details/index.js +20 -0
  135. package/lib-next/theme/Details/styles.module.css +13 -0
  136. package/lib-next/theme/DocCard/index.js +80 -0
  137. package/lib-next/theme/DocCard/styles.module.css +43 -0
  138. package/lib-next/theme/DocCardList/index.js +19 -0
  139. package/lib-next/theme/DocCategoryGeneratedIndexPage/index.js +49 -0
  140. package/lib-next/theme/DocCategoryGeneratedIndexPage/styles.module.css +18 -0
  141. package/lib-next/theme/DocItem/index.js +40 -56
  142. package/lib-next/theme/DocItem/styles.module.css +5 -9
  143. package/lib-next/theme/DocItemFooter/index.js +79 -0
  144. package/lib-next/theme/DocItemFooter/styles.module.css +18 -0
  145. package/lib-next/theme/DocPage/index.js +46 -47
  146. package/lib-next/theme/DocPage/styles.module.css +8 -23
  147. package/lib-next/theme/DocPaginator/index.js +7 -11
  148. package/lib-next/theme/DocSidebar/index.js +69 -295
  149. package/lib-next/theme/DocSidebar/styles.module.css +0 -18
  150. package/lib-next/theme/DocSidebarItem/index.js +217 -0
  151. package/lib-next/theme/DocSidebarItem/styles.module.css +19 -0
  152. package/lib-next/theme/DocTagDocListPage/index.js +89 -0
  153. package/lib-next/theme/DocTagsListPage/index.js +38 -0
  154. package/lib-next/theme/DocVersionBadge/index.js +27 -0
  155. package/lib-next/theme/{DocVersionSuggestions → DocVersionBanner}/index.js +51 -36
  156. package/lib-next/theme/EditThisPage/index.js +6 -1
  157. package/lib-next/theme/ErrorPageContent.js +35 -0
  158. package/lib-next/theme/Footer/index.js +27 -5
  159. package/lib-next/theme/Heading/index.js +25 -29
  160. package/lib-next/theme/Heading/styles.css +5 -6
  161. package/lib-next/theme/Heading/styles.module.css +9 -5
  162. package/lib-next/theme/IconArrow/index.js +2 -2
  163. package/lib-next/theme/IconClose/index.js +23 -0
  164. package/lib-next/theme/IconEdit/index.js +2 -2
  165. package/lib-next/theme/IconExternalLink/index.js +2 -2
  166. package/lib-next/theme/IconLanguage/index.js +2 -2
  167. package/lib-next/theme/IconMenu/index.js +2 -2
  168. package/lib-next/theme/LastUpdated/index.js +3 -2
  169. package/lib-next/theme/Layout/index.js +3 -1
  170. package/lib-next/theme/LayoutHead/index.js +18 -23
  171. package/lib-next/theme/LayoutProviders/index.js +17 -6
  172. package/lib-next/theme/Logo/index.js +25 -21
  173. package/lib-next/theme/MDXComponents/index.js +34 -7
  174. package/lib-next/theme/MDXComponents/styles.css +11 -0
  175. package/lib-next/theme/MDXPage/index.js +10 -2
  176. package/lib-next/theme/Navbar/index.js +193 -56
  177. package/lib-next/theme/Navbar/styles.module.css +10 -3
  178. package/lib-next/theme/NavbarItem/DefaultNavbarItem.js +45 -147
  179. package/lib-next/theme/NavbarItem/DocNavbarItem.js +7 -7
  180. package/lib-next/theme/NavbarItem/DocsVersionDropdownNavbarItem.js +31 -19
  181. package/lib-next/theme/NavbarItem/DropdownNavbarItem.js +159 -0
  182. package/lib-next/theme/NavbarItem/{LocaleDropdownNavbarItem.js → LocaleDropdownNavbarItem/index.js} +4 -12
  183. package/lib-next/theme/NavbarItem/LocaleDropdownNavbarItem/styles.module.css +11 -0
  184. package/lib-next/theme/NavbarItem/index.js +25 -12
  185. package/lib-next/theme/{SearchMetadatas → SearchMetadata}/index.js +1 -1
  186. package/lib-next/theme/Seo/index.js +11 -7
  187. package/lib-next/theme/SkipToContent/index.js +7 -8
  188. package/lib-next/theme/SkipToContent/styles.module.css +1 -0
  189. package/lib-next/theme/TOC/index.js +12 -36
  190. package/lib-next/theme/TOC/styles.module.css +1 -1
  191. package/lib-next/theme/TOCCollapsible/index.js +54 -0
  192. package/lib-next/theme/TOCCollapsible/styles.module.css +50 -0
  193. package/lib-next/theme/TOCInline/index.js +10 -28
  194. package/lib-next/theme/TOCItems/index.js +85 -0
  195. package/lib-next/theme/Tabs/__tests__/index.test.js +142 -0
  196. package/lib-next/theme/Tabs/index.js +91 -43
  197. package/lib-next/theme/Tabs/styles.module.css +0 -13
  198. package/lib-next/theme/Tag/index.js +27 -0
  199. package/lib-next/theme/Tag/styles.module.css +70 -0
  200. package/lib-next/theme/TagsListByLetter/index.js +42 -0
  201. package/lib-next/theme/TagsListByLetter/styles.module.css +11 -0
  202. package/lib-next/theme/TagsListInline/index.js +31 -0
  203. package/lib-next/theme/TagsListInline/styles.module.css +15 -0
  204. package/lib-next/theme/ThemeProvider/index.js +10 -7
  205. package/lib-next/theme/ThemedImage/index.js +7 -8
  206. package/lib-next/theme/Toggle/index.js +34 -37
  207. package/lib-next/theme/Toggle/styles.module.css +91 -3
  208. package/lib-next/theme/UserPreferencesProvider/index.js +9 -10
  209. package/lib-next/theme/hooks/useHideableNavbar.js +31 -44
  210. package/lib-next/theme/hooks/useTabGroupChoice.js +2 -4
  211. package/lib-next/theme/hooks/useTheme.js +4 -5
  212. package/lib-next/theme/hooks/useWindowSize.js +34 -20
  213. package/lib-next/theme/prism-include-languages.js +2 -1
  214. package/lib-next/theme-classic.d.ts +806 -0
  215. package/lib-next/translations.js +6 -10
  216. package/lib-next/types.d.ts +0 -599
  217. package/lib-next/validateThemeConfig.js +141 -114
  218. package/package.json +28 -25
  219. package/src/__tests__/validateThemeConfig.test.js +277 -3
  220. package/src/admonitions.css +35 -0
  221. package/src/deps.d.ts +13 -0
  222. package/src/index.ts +55 -22
  223. package/src/{prism-include-languages.js → prism-include-languages.ts} +0 -0
  224. package/src/theme/AnnouncementBar/index.tsx +10 -17
  225. package/src/theme/AnnouncementBar/styles.module.css +25 -30
  226. package/src/theme/BackToTopButton/index.tsx +142 -0
  227. package/src/theme/BackToTopButton/styles.module.css +42 -0
  228. package/src/theme/BlogArchivePage/index.tsx +91 -0
  229. package/src/theme/BlogLayout/index.tsx +44 -0
  230. package/src/theme/BlogListPage/index.tsx +18 -25
  231. package/src/theme/BlogPostAuthor/index.tsx +49 -0
  232. package/src/theme/BlogPostAuthor/styles.module.css +12 -0
  233. package/src/theme/BlogPostAuthors/index.tsx +39 -0
  234. package/src/theme/BlogPostAuthors/styles.module.css +11 -0
  235. package/src/theme/BlogPostItem/index.tsx +70 -80
  236. package/src/theme/BlogPostPage/index.tsx +72 -35
  237. package/src/theme/BlogSidebar/index.tsx +11 -13
  238. package/src/theme/BlogSidebar/styles.module.css +2 -2
  239. package/src/theme/BlogTagsListPage/index.tsx +14 -57
  240. package/src/theme/BlogTagsPostsPage/index.tsx +29 -39
  241. package/src/theme/CodeBlock/index.tsx +21 -151
  242. package/src/theme/CodeBlock/styles.module.css +6 -9
  243. package/src/theme/Details/index.tsx +24 -0
  244. package/src/theme/Details/styles.module.css +13 -0
  245. package/src/theme/DocCard/index.tsx +100 -0
  246. package/src/theme/DocCard/styles.module.css +43 -0
  247. package/src/theme/DocCardList/index.tsx +27 -0
  248. package/src/theme/DocCategoryGeneratedIndexPage/index.tsx +53 -0
  249. package/src/theme/DocCategoryGeneratedIndexPage/styles.module.css +18 -0
  250. package/src/theme/DocItem/index.tsx +43 -56
  251. package/src/theme/DocItem/styles.module.css +5 -9
  252. package/src/theme/DocItemFooter/index.tsx +91 -0
  253. package/src/theme/DocItemFooter/styles.module.css +18 -0
  254. package/src/theme/DocPage/index.tsx +44 -42
  255. package/src/theme/DocPage/styles.module.css +8 -23
  256. package/src/theme/DocPaginator/index.tsx +9 -13
  257. package/src/theme/DocSidebar/index.tsx +80 -307
  258. package/src/theme/DocSidebar/styles.module.css +0 -18
  259. package/src/theme/DocSidebarItem/index.tsx +242 -0
  260. package/src/theme/DocSidebarItem/styles.module.css +19 -0
  261. package/src/theme/DocTagDocListPage/index.tsx +89 -0
  262. package/src/theme/DocTagsListPage/index.tsx +41 -0
  263. package/src/theme/DocVersionBadge/index.tsx +30 -0
  264. package/src/theme/{DocVersionSuggestions → DocVersionBanner}/index.tsx +74 -44
  265. package/src/theme/EditThisPage/index.tsx +6 -1
  266. package/src/theme/ErrorPageContent.tsx +41 -0
  267. package/src/theme/Footer/index.tsx +30 -6
  268. package/src/theme/Heading/index.tsx +25 -31
  269. package/src/theme/Heading/styles.css +5 -6
  270. package/src/theme/Heading/styles.module.css +9 -5
  271. package/src/theme/IconArrow/index.tsx +2 -2
  272. package/src/theme/IconClose/index.tsx +26 -0
  273. package/src/theme/IconEdit/index.tsx +2 -2
  274. package/src/theme/IconExternalLink/index.tsx +2 -5
  275. package/src/theme/IconLanguage/index.tsx +2 -6
  276. package/src/theme/IconMenu/index.tsx +3 -3
  277. package/src/theme/LastUpdated/index.tsx +3 -2
  278. package/src/theme/Layout/index.tsx +3 -1
  279. package/src/theme/LayoutHead/index.tsx +18 -17
  280. package/src/theme/LayoutProviders/index.tsx +17 -6
  281. package/src/theme/Logo/index.tsx +21 -17
  282. package/src/theme/MDXComponents/index.tsx +39 -5
  283. package/src/theme/MDXComponents/styles.css +11 -0
  284. package/src/theme/MDXPage/index.tsx +10 -2
  285. package/src/theme/Navbar/index.tsx +203 -61
  286. package/src/theme/Navbar/styles.module.css +10 -3
  287. package/src/theme/NavbarItem/DefaultNavbarItem.tsx +42 -154
  288. package/src/theme/NavbarItem/DocNavbarItem.tsx +12 -16
  289. package/src/theme/NavbarItem/DocsVersionDropdownNavbarItem.tsx +33 -21
  290. package/src/theme/NavbarItem/DocsVersionNavbarItem.tsx +7 -3
  291. package/src/theme/NavbarItem/DropdownNavbarItem.tsx +181 -0
  292. package/src/theme/NavbarItem/{LocaleDropdownNavbarItem.tsx → LocaleDropdownNavbarItem/index.tsx} +8 -9
  293. package/src/theme/NavbarItem/LocaleDropdownNavbarItem/styles.module.css +11 -0
  294. package/src/theme/NavbarItem/index.tsx +41 -16
  295. package/src/theme/{SearchMetadatas → SearchMetadata}/index.tsx +2 -2
  296. package/src/theme/Seo/index.tsx +7 -4
  297. package/src/theme/SkipToContent/index.tsx +7 -8
  298. package/src/theme/SkipToContent/styles.module.css +1 -0
  299. package/src/theme/TOC/index.tsx +12 -41
  300. package/src/theme/TOC/styles.module.css +1 -1
  301. package/src/theme/TOCCollapsible/index.tsx +58 -0
  302. package/src/theme/TOCCollapsible/styles.module.css +50 -0
  303. package/src/theme/TOCInline/index.tsx +13 -32
  304. package/src/theme/TOCItems/index.tsx +96 -0
  305. package/src/theme/Tabs/__tests__/index.test.tsx +129 -0
  306. package/src/theme/Tabs/index.tsx +93 -49
  307. package/src/theme/Tabs/styles.module.css +0 -13
  308. package/src/theme/Tag/index.tsx +31 -0
  309. package/src/theme/Tag/styles.module.css +70 -0
  310. package/src/theme/TagsListByLetter/index.tsx +45 -0
  311. package/src/theme/TagsListByLetter/styles.module.css +11 -0
  312. package/src/theme/TagsListInline/index.tsx +35 -0
  313. package/src/theme/TagsListInline/styles.module.css +15 -0
  314. package/src/theme/ThemeProvider/index.tsx +6 -2
  315. package/src/theme/ThemedImage/index.tsx +8 -8
  316. package/src/theme/Toggle/index.tsx +36 -43
  317. package/src/theme/Toggle/styles.module.css +91 -3
  318. package/src/theme/UserPreferencesProvider/index.tsx +9 -11
  319. package/src/theme/hooks/useHideableNavbar.ts +32 -45
  320. package/src/theme/hooks/useTabGroupChoice.ts +4 -4
  321. package/src/theme/hooks/useTheme.ts +4 -5
  322. package/src/theme/hooks/useWindowSize.ts +38 -20
  323. package/src/theme/prism-include-languages.ts +3 -2
  324. package/src/theme-classic.d.ts +806 -0
  325. package/src/translations.ts +8 -10
  326. package/src/types.d.ts +0 -599
  327. package/src/{validateThemeConfig.js → validateThemeConfig.ts} +151 -94
  328. package/tsconfig.json +1 -2
  329. package/codeTranslations/README.md +0 -20
  330. package/codeTranslations/ar.json +0 -57
  331. package/codeTranslations/base.json +0 -112
  332. package/codeTranslations/bn.json +0 -56
  333. package/codeTranslations/da.json +0 -57
  334. package/codeTranslations/de.json +0 -57
  335. package/codeTranslations/es.json +0 -57
  336. package/codeTranslations/fa.json +0 -57
  337. package/codeTranslations/fil.json +0 -57
  338. package/codeTranslations/fr.json +0 -57
  339. package/codeTranslations/he.json +0 -57
  340. package/codeTranslations/hi.json +0 -57
  341. package/codeTranslations/ja.json +0 -57
  342. package/codeTranslations/ko.json +0 -57
  343. package/codeTranslations/pl.json +0 -57
  344. package/codeTranslations/pt-BR.json +0 -57
  345. package/codeTranslations/pt-PT.json +0 -57
  346. package/codeTranslations/ru.json +0 -57
  347. package/codeTranslations/tr.json +0 -57
  348. package/codeTranslations/vi.json +0 -57
  349. package/codeTranslations/zh-Hans.json +0 -57
  350. package/codeTranslations/zh-Hant.json +0 -57
  351. package/lib/theme/Toggle/styles.css +0 -103
  352. package/lib/theme/hooks/useAnnouncementBar.js +0 -63
  353. package/lib/theme/hooks/useContextualSearchFilters.js +0 -47
  354. package/lib/theme/hooks/useScrollPosition.js +0 -49
  355. package/lib/theme/hooks/useTOCHighlight.js +0 -87
  356. package/lib-next/theme/Toggle/styles.css +0 -103
  357. package/lib-next/theme/hooks/useAnnouncementBar.js +0 -49
  358. package/lib-next/theme/hooks/useContextualSearchFilters.js +0 -41
  359. package/lib-next/theme/hooks/useScrollPosition.js +0 -38
  360. package/lib-next/theme/hooks/useTOCHighlight.js +0 -84
  361. package/src/theme/Toggle/styles.css +0 -103
  362. package/src/theme/hooks/useAnnouncementBar.ts +0 -58
  363. package/src/theme/hooks/useContextualSearchFilters.ts +0 -52
  364. package/src/theme/hooks/useScrollPosition.ts +0 -45
  365. package/src/theme/hooks/useTOCHighlight.ts +0 -98
  366. package/update-code-translations.js +0 -239
  367. package/update-code-translations.test.js +0 -33
package/lib-next/theme/Seo/index.js CHANGED
@@ -6,14 +6,16 @@
6
6
  */
7
7
  import React from 'react';
8
8
  import Head from '@docusaurus/Head';
9
- import {useThemeConfig, useTitleFormatter} from '@docusaurus/theme-common';
10
- import useBaseUrl from '@docusaurus/useBaseUrl';
11
- export default function Seo({title, description, keywords, image}) {
12
- const {image: defaultImage} = useThemeConfig();
9
+ import {useTitleFormatter} from '@docusaurus/theme-common';
10
+ import {useBaseUrlUtils} from '@docusaurus/useBaseUrl';
11
+ export default function Seo({title, description, keywords, image, children}) {
13
12
  const pageTitle = useTitleFormatter(title);
14
- const pageImage = useBaseUrl(image || defaultImage, {
15
- absolute: true,
16
- });
13
+ const {withBaseUrl} = useBaseUrlUtils();
14
+ const pageImage = image
15
+ ? withBaseUrl(image, {
16
+ absolute: true,
17
+ })
18
+ : undefined;
17
19
  return (
18
20
  <Head>
19
21
  {title && <title>{pageTitle}</title>}
@@ -31,6 +33,8 @@ export default function Seo({title, description, keywords, image}) {
31
33
 
32
34
  {pageImage && <meta property="og:image" content={pageImage} />}
33
35
  {pageImage && <meta name="twitter:image" content={pageImage} />}
36
+
37
+ {children}
34
38
  </Head>
35
39
  );
36
40
  }
package/lib-next/theme/SkipToContent/index.js CHANGED
@@ -5,9 +5,9 @@
5
5
  * LICENSE file in the root directory of this source tree.
6
6
  */
7
7
  import React, {useRef} from 'react';
8
- import clsx from 'clsx';
8
+ import {useHistory} from '@docusaurus/router';
9
9
  import Translate from '@docusaurus/Translate';
10
- import {useChangeRoute} from '@docusaurus/theme-common';
10
+ import {useLocationChange} from '@docusaurus/theme-common';
11
11
  import styles from './styles.module.css';
12
12
 
13
13
  function programmaticFocus(el) {
@@ -18,6 +18,7 @@ function programmaticFocus(el) {
18
18
 
19
19
  function SkipToContent() {
20
20
  const containerRef = useRef(null);
21
+ const {action} = useHistory();
21
22
 
22
23
  const handleSkip = (e) => {
23
24
  e.preventDefault();
@@ -30,17 +31,15 @@ function SkipToContent() {
30
31
  }
31
32
  };
32
33
 
33
- useChangeRoute(() => {
34
- if (containerRef.current) {
34
+ useLocationChange(({location}) => {
35
+ if (containerRef.current && !location.hash && action === 'PUSH') {
35
36
  programmaticFocus(containerRef.current);
36
37
  }
37
38
  });
38
39
  return (
39
40
  <div ref={containerRef}>
40
- <a
41
- href="#main"
42
- className={clsx(styles.skipToContent, 'shadow--md')}
43
- onClick={handleSkip}>
41
+ {/* eslint-disable-next-line jsx-a11y/anchor-is-valid */}
42
+ <a href="#" className={styles.skipToContent} onClick={handleSkip}>
44
43
  <Translate
45
44
  id="theme.common.skipToMainContent"
46
45
  description="The skip to content label used for accessibility, allowing to rapidly navigate to main content with keyboard tab/enter navigation">
package/lib-next/theme/SkipToContent/styles.module.css CHANGED
@@ -10,4 +10,5 @@
10
10
 
11
11
  .skipToContent:focus {
12
12
  left: 1rem;
13
+ box-shadow: var(--ifm-global-shadow-md);
13
14
  }
package/lib-next/theme/TOC/index.js CHANGED
@@ -6,45 +6,21 @@
6
6
  */
7
7
  import React from 'react';
8
8
  import clsx from 'clsx';
9
- import useTOCHighlight from '@theme/hooks/useTOCHighlight';
10
- import styles from './styles.module.css';
11
- const LINK_CLASS_NAME = 'table-of-contents__link';
12
- const ACTIVE_LINK_CLASS_NAME = 'table-of-contents__link--active';
13
- const TOP_OFFSET = 100;
14
- /* eslint-disable jsx-a11y/control-has-associated-label */
9
+ import TOCItems from '@theme/TOCItems';
10
+ import styles from './styles.module.css'; // Using a custom className
11
+ // This prevents TOC highlighting to highlight TOCInline/TOCCollapsible by mistake
15
12
 
16
- function Headings({toc, isChild}) {
17
- if (!toc.length) {
18
- return null;
19
- }
13
+ const LINK_CLASS_NAME = 'table-of-contents__link toc-highlight';
14
+ const LINK_ACTIVE_CLASS_NAME = 'table-of-contents__link--active';
20
15
 
16
+ function TOC({className, ...props}) {
21
17
  return (
22
- <ul
23
- className={
24
- isChild ? '' : 'table-of-contents table-of-contents__left-border'
25
- }>
26
- {toc.map((heading) => (
27
- <li key={heading.id}>
28
- <a
29
- href={`#${heading.id}`}
30
- className={LINK_CLASS_NAME} // Developer provided the HTML, so assume it's safe.
31
- // eslint-disable-next-line react/no-danger
32
- dangerouslySetInnerHTML={{
33
- __html: heading.value,
34
- }}
35
- />
36
- <Headings isChild toc={heading.children} />
37
- </li>
38
- ))}
39
- </ul>
40
- );
41
- }
42
-
43
- function TOC({toc}) {
44
- useTOCHighlight(LINK_CLASS_NAME, ACTIVE_LINK_CLASS_NAME, TOP_OFFSET);
45
- return (
46
- <div className={clsx(styles.tableOfContents, 'thin-scrollbar')}>
47
- <Headings toc={toc} />
18
+ <div className={clsx(styles.tableOfContents, 'thin-scrollbar', className)}>
19
+ <TOCItems
20
+ {...props}
21
+ linkClassName={LINK_CLASS_NAME}
22
+ linkActiveClassName={LINK_ACTIVE_CLASS_NAME}
23
+ />
48
24
  </div>
49
25
  );
50
26
  }
package/lib-next/theme/TOC/styles.module.css CHANGED
@@ -12,7 +12,7 @@
12
12
  top: calc(var(--ifm-navbar-height) + 1rem);
13
13
  }
14
14
 
15
- @media only screen and (max-width: 996px) {
15
+ @media (max-width: 996px) {
16
16
  .tableOfContents {
17
17
  display: none;
18
18
  }
package/lib-next/theme/TOCCollapsible/index.js ADDED
@@ -0,0 +1,54 @@
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
+ import React from 'react';
8
+ import clsx from 'clsx';
9
+ import Translate from '@docusaurus/Translate';
10
+ import {useCollapsible, Collapsible} from '@docusaurus/theme-common';
11
+ import styles from './styles.module.css';
12
+ import TOCItems from '@theme/TOCItems';
13
+ export default function TOCCollapsible({
14
+ toc,
15
+ className,
16
+ minHeadingLevel,
17
+ maxHeadingLevel,
18
+ }) {
19
+ const {collapsed, toggleCollapsed} = useCollapsible({
20
+ initialState: true,
21
+ });
22
+ return (
23
+ <div
24
+ className={clsx(
25
+ styles.tocCollapsible,
26
+ {
27
+ [styles.tocCollapsibleExpanded]: !collapsed,
28
+ },
29
+ className,
30
+ )}>
31
+ <button
32
+ type="button"
33
+ className={clsx('clean-btn', styles.tocCollapsibleButton)}
34
+ onClick={toggleCollapsed}>
35
+ <Translate
36
+ id="theme.TOCCollapsible.toggleButtonLabel"
37
+ description="The label used by the button on the collapsible TOC component">
38
+ On this page
39
+ </Translate>
40
+ </button>
41
+
42
+ <Collapsible
43
+ lazy
44
+ className={styles.tocCollapsibleContent}
45
+ collapsed={collapsed}>
46
+ <TOCItems
47
+ toc={toc}
48
+ minHeadingLevel={minHeadingLevel}
49
+ maxHeadingLevel={maxHeadingLevel}
50
+ />
51
+ </Collapsible>
52
+ </div>
53
+ );
54
+ }
package/lib-next/theme/TOCCollapsible/styles.module.css ADDED
@@ -0,0 +1,50 @@
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
+ .tocCollapsible {
9
+ background-color: var(--ifm-menu-color-background-active);
10
+ border-radius: var(--ifm-global-radius);
11
+ margin: 1rem 0;
12
+ }
13
+
14
+ .tocCollapsibleButton {
15
+ font-size: inherit;
16
+ display: flex;
17
+ justify-content: space-between;
18
+ align-items: center;
19
+ padding: 0.4rem 0.8rem;
20
+ width: 100%;
21
+ }
22
+
23
+ .tocCollapsibleButton:after {
24
+ content: '';
25
+ background: var(--ifm-menu-link-sublist-icon) 50% 50% / 2rem 2rem no-repeat;
26
+ filter: var(--ifm-menu-link-sublist-icon-filter);
27
+ height: 1.25rem;
28
+ width: 1.25rem;
29
+ transform: rotate(180deg);
30
+ transition: transform var(--ifm-transition-fast);
31
+ }
32
+
33
+ .tocCollapsibleContent > ul {
34
+ border-left: none;
35
+ border-top: 1px solid var(--ifm-color-emphasis-300);
36
+ padding: 0.2rem 0;
37
+ font-size: 15px;
38
+ }
39
+
40
+ .tocCollapsibleContent ul li {
41
+ margin: 0.4rem 0.8rem;
42
+ }
43
+
44
+ .tocCollapsibleContent a {
45
+ display: block;
46
+ }
47
+
48
+ .tocCollapsibleExpanded .tocCollapsibleButton:after {
49
+ transform: none;
50
+ }
package/lib-next/theme/TOCInline/index.js CHANGED
@@ -5,37 +5,19 @@
5
5
  * LICENSE file in the root directory of this source tree.
6
6
  */
7
7
  import React from 'react';
8
- import clsx from 'clsx';
9
8
  import styles from './styles.module.css';
9
+ import TOCItems from '@theme/TOCItems';
10
10
 
11
- /* eslint-disable jsx-a11y/control-has-associated-label */
12
- function HeadingsInline({toc, isChild}) {
13
- if (!toc.length) {
14
- return null;
15
- }
16
-
17
- return (
18
- <ul className={isChild ? '' : 'table-of-contents'}>
19
- {toc.map((heading) => (
20
- <li key={heading.id}>
21
- <a
22
- href={`#${heading.id}`} // Developer provided the HTML, so assume it's safe.
23
- // eslint-disable-next-line react/no-danger
24
- dangerouslySetInnerHTML={{
25
- __html: heading.value,
26
- }}
27
- />
28
- <HeadingsInline isChild toc={heading.children} />
29
- </li>
30
- ))}
31
- </ul>
32
- );
33
- }
34
-
35
- function TOCInline({toc}) {
11
+ function TOCInline({toc, minHeadingLevel, maxHeadingLevel}) {
36
12
  return (
37
- <div className={clsx(styles.tableOfContentsInline)}>
38
- <HeadingsInline toc={toc} />
13
+ <div className={styles.tableOfContentsInline}>
14
+ <TOCItems
15
+ toc={toc}
16
+ minHeadingLevel={minHeadingLevel}
17
+ maxHeadingLevel={maxHeadingLevel}
18
+ className="table-of-contents"
19
+ linkClassName={null}
20
+ />
39
21
  </div>
40
22
  );
41
23
  }
package/lib-next/theme/TOCItems/index.js ADDED
@@ -0,0 +1,85 @@
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
+ import React, {useMemo} from 'react';
8
+ import {
9
+ useThemeConfig,
10
+ useTOCFilter,
11
+ useTOCHighlight,
12
+ } from '@docusaurus/theme-common'; // Recursive component rendering the toc tree
13
+
14
+ /* eslint-disable jsx-a11y/control-has-associated-label */
15
+
16
+ function TOCItemList({toc, className, linkClassName, isChild}) {
17
+ if (!toc.length) {
18
+ return null;
19
+ }
20
+
21
+ return (
22
+ <ul className={isChild ? undefined : className}>
23
+ {toc.map((heading) => (
24
+ <li key={heading.id}>
25
+ <a
26
+ href={`#${heading.id}`}
27
+ className={linkClassName ?? undefined} // Developer provided the HTML, so assume it's safe.
28
+ // eslint-disable-next-line react/no-danger
29
+ dangerouslySetInnerHTML={{
30
+ __html: heading.value,
31
+ }}
32
+ />
33
+ <TOCItemList
34
+ isChild
35
+ toc={heading.children}
36
+ className={className}
37
+ linkClassName={linkClassName}
38
+ />
39
+ </li>
40
+ ))}
41
+ </ul>
42
+ );
43
+ }
44
+
45
+ export default function TOCItems({
46
+ toc,
47
+ className = 'table-of-contents table-of-contents__left-border',
48
+ linkClassName = 'table-of-contents__link',
49
+ linkActiveClassName = undefined,
50
+ minHeadingLevel: minHeadingLevelOption,
51
+ maxHeadingLevel: maxHeadingLevelOption,
52
+ ...props
53
+ }) {
54
+ const themeConfig = useThemeConfig();
55
+ const minHeadingLevel =
56
+ minHeadingLevelOption ?? themeConfig.tableOfContents.minHeadingLevel;
57
+ const maxHeadingLevel =
58
+ maxHeadingLevelOption ?? themeConfig.tableOfContents.maxHeadingLevel;
59
+ const tocFiltered = useTOCFilter({
60
+ toc,
61
+ minHeadingLevel,
62
+ maxHeadingLevel,
63
+ });
64
+ const tocHighlightConfig = useMemo(() => {
65
+ if (linkClassName && linkActiveClassName) {
66
+ return {
67
+ linkClassName,
68
+ linkActiveClassName,
69
+ minHeadingLevel,
70
+ maxHeadingLevel,
71
+ };
72
+ }
73
+
74
+ return undefined;
75
+ }, [linkClassName, linkActiveClassName, minHeadingLevel, maxHeadingLevel]);
76
+ useTOCHighlight(tocHighlightConfig);
77
+ return (
78
+ <TOCItemList
79
+ toc={tocFiltered}
80
+ className={className}
81
+ linkClassName={linkClassName}
82
+ {...props}
83
+ />
84
+ );
85
+ }
package/lib-next/theme/Tabs/__tests__/index.test.js ADDED
@@ -0,0 +1,142 @@
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
+ import React from 'react';
8
+ import renderer from 'react-test-renderer';
9
+ import Tabs from '../index';
10
+ import TabItem from '../../TabItem';
11
+ import UserPreferencesProvider from '@theme/UserPreferencesProvider';
12
+ import {ScrollControllerProvider} from '@docusaurus/theme-common';
13
+ describe('Tabs', () => {
14
+ test('Should reject bad Tabs child', () => {
15
+ expect(() => {
16
+ renderer.create(
17
+ <Tabs>
18
+ <div>Naughty</div>
19
+ <TabItem value="good">Good</TabItem>
20
+ </Tabs>,
21
+ );
22
+ }).toThrowErrorMatchingInlineSnapshot(
23
+ `"Docusaurus error: Bad <Tabs> child <div>: all children of the <Tabs> component should be <TabItem>, and every <TabItem> should have a unique \\"value\\" prop."`,
24
+ );
25
+ });
26
+ test('Should reject bad Tabs defaultValue', () => {
27
+ expect(() => {
28
+ renderer.create(
29
+ <Tabs defaultValue="bad">
30
+ <TabItem value="v1">Tab 1</TabItem>
31
+ <TabItem value="v2">Tab 2</TabItem>
32
+ </Tabs>,
33
+ );
34
+ }).toThrowErrorMatchingInlineSnapshot(
35
+ `"Docusaurus error: The <Tabs> has a defaultValue \\"bad\\" but none of its children has the corresponding value. Available values are: v1, v2. If you intend to show no default tab, use defaultValue={null} instead."`,
36
+ );
37
+ });
38
+ test('Should reject duplicate values', () => {
39
+ expect(() => {
40
+ renderer.create(
41
+ <Tabs>
42
+ <TabItem value="v1">Tab 1</TabItem>
43
+ <TabItem value="v2">Tab 2</TabItem>
44
+ <TabItem value="v3">Tab 3</TabItem>
45
+ <TabItem value="v4">Tab 4</TabItem>
46
+ <TabItem value="v1">Tab 5</TabItem>
47
+ <TabItem value="v2">Tab 6</TabItem>
48
+ </Tabs>,
49
+ );
50
+ }).toThrowErrorMatchingInlineSnapshot(
51
+ `"Docusaurus error: Duplicate values \\"v1, v2\\" found in <Tabs>. Every value needs to be unique."`,
52
+ );
53
+ });
54
+ test('Should accept valid Tabs config', () => {
55
+ expect(() => {
56
+ renderer.create(
57
+ <ScrollControllerProvider>
58
+ <UserPreferencesProvider>
59
+ <Tabs>
60
+ <TabItem value="v1">Tab 1</TabItem>
61
+ <TabItem value="v2">Tab 2</TabItem>
62
+ </Tabs>
63
+ <Tabs>
64
+ <TabItem value="v1">Tab 1</TabItem>
65
+ <TabItem value="v2" default>
66
+ Tab 2
67
+ </TabItem>
68
+ </Tabs>
69
+ <Tabs defaultValue="v1">
70
+ <TabItem value="v1" label="V1">
71
+ Tab 1
72
+ </TabItem>
73
+ <TabItem value="v2" label="V2">
74
+ Tab 2
75
+ </TabItem>
76
+ </Tabs>
77
+ <Tabs
78
+ defaultValue="v1"
79
+ values={[
80
+ {
81
+ value: 'v1',
82
+ label: 'V1',
83
+ },
84
+ {
85
+ value: 'v2',
86
+ label: 'V2',
87
+ },
88
+ ]}>
89
+ <TabItem value="v1">Tab 1</TabItem>
90
+ <TabItem value="v2">Tab 2</TabItem>
91
+ </Tabs>
92
+ <Tabs
93
+ defaultValue={null}
94
+ values={[
95
+ {
96
+ value: 'v1',
97
+ label: 'V1',
98
+ },
99
+ {
100
+ value: 'v2',
101
+ label: 'V2',
102
+ },
103
+ ]}>
104
+ <TabItem value="v1">Tab 1</TabItem>
105
+ <TabItem value="v2">Tab 2</TabItem>
106
+ </Tabs>
107
+ <Tabs defaultValue={null}>
108
+ <TabItem value="v1" label="V1">
109
+ Tab 1
110
+ </TabItem>
111
+ <TabItem value="v2" label="V2">
112
+ Tab 2
113
+ </TabItem>
114
+ </Tabs>
115
+ </UserPreferencesProvider>
116
+ </ScrollControllerProvider>,
117
+ );
118
+ }).not.toThrow(); // TODO Better Jest infrastructure to mock the Layout
119
+ }); // https://github.com/facebook/docusaurus/issues/5729
120
+
121
+ test('Should accept dynamic Tabs with number values', () => {
122
+ expect(() => {
123
+ const tabs = ['Apple', 'Banana', 'Carrot'];
124
+ renderer.create(
125
+ <ScrollControllerProvider>
126
+ <UserPreferencesProvider>
127
+ <Tabs
128
+ values={tabs.map((t, idx) => ({
129
+ label: t,
130
+ value: idx,
131
+ }))}
132
+ defaultValue={0}>
133
+ {tabs.map((t, idx) => (
134
+ <TabItem value={idx}>{t}</TabItem>
135
+ ))}
136
+ </Tabs>
137
+ </UserPreferencesProvider>
138
+ </ScrollControllerProvider>,
139
+ );
140
+ }).not.toThrow();
141
+ });
142
+ });