@docusaurus/theme-classic 2.0.0-beta.8e9b829d9 → 2.0.0-beta.9

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 (275) hide show
  1. package/README.md +1 -1
  2. package/codeTranslations/ar.json +12 -6
  3. package/codeTranslations/base.json +12 -0
  4. package/codeTranslations/bn.json +6 -0
  5. package/codeTranslations/cs.json +62 -0
  6. package/codeTranslations/da.json +6 -0
  7. package/codeTranslations/de.json +8 -2
  8. package/codeTranslations/es.json +10 -4
  9. package/codeTranslations/fa.json +9 -3
  10. package/codeTranslations/fil.json +6 -0
  11. package/codeTranslations/fr.json +6 -0
  12. package/codeTranslations/he.json +6 -0
  13. package/codeTranslations/hi.json +6 -0
  14. package/codeTranslations/ja.json +6 -0
  15. package/codeTranslations/ko.json +6 -0
  16. package/codeTranslations/pl.json +6 -0
  17. package/codeTranslations/pt-BR.json +8 -2
  18. package/codeTranslations/pt-PT.json +6 -0
  19. package/codeTranslations/ru.json +6 -0
  20. package/codeTranslations/sr.json +62 -0
  21. package/codeTranslations/tr.json +9 -3
  22. package/codeTranslations/vi.json +10 -4
  23. package/codeTranslations/zh-Hans.json +6 -0
  24. package/codeTranslations/zh-Hant.json +6 -0
  25. package/lib/__tests__/validateThemeConfig.test.js +154 -4
  26. package/lib/index.js +2 -3
  27. package/lib/prism-include-languages.js +9 -5
  28. package/lib/theme/AnnouncementBar/index.js +8 -12
  29. package/lib/theme/AnnouncementBar/styles.module.css +23 -32
  30. package/lib/theme/BackToTopButton/index.js +27 -13
  31. package/lib/theme/BackToTopButton/styles.module.css +17 -14
  32. package/lib/theme/BlogArchivePage/index.js +89 -0
  33. package/lib/theme/BlogLayout/index.js +2 -6
  34. package/lib/theme/BlogListPage/index.js +1 -1
  35. package/lib/theme/BlogPostAuthor/index.js +51 -0
  36. package/lib/theme/BlogPostAuthor/styles.module.css +12 -0
  37. package/lib/theme/BlogPostAuthors/index.js +47 -0
  38. package/lib/theme/BlogPostAuthors/styles.module.css +11 -0
  39. package/lib/theme/BlogPostItem/index.js +58 -67
  40. package/lib/theme/BlogPostPage/index.js +33 -4
  41. package/lib/theme/BlogSidebar/styles.module.css +2 -2
  42. package/lib/theme/BlogTagsListPage/index.js +3 -28
  43. package/lib/theme/BlogTagsPostsPage/index.js +5 -8
  44. package/lib/theme/CodeBlock/index.js +44 -37
  45. package/lib/theme/CodeBlock/styles.module.css +1 -2
  46. package/lib/theme/DocItem/index.js +15 -40
  47. package/lib/theme/DocItem/styles.module.css +2 -12
  48. package/lib/theme/DocItemFooter/index.js +79 -0
  49. package/lib/theme/DocItemFooter/styles.module.css +18 -0
  50. package/lib/theme/DocPage/index.js +18 -13
  51. package/lib/theme/DocSidebar/index.js +11 -16
  52. package/lib/theme/DocSidebarItem/index.js +12 -10
  53. package/lib/theme/DocTagDocListPage/index.js +89 -0
  54. package/lib/theme/DocTagsListPage/index.js +44 -0
  55. package/lib/theme/DocVersionBanner/index.js +6 -4
  56. package/lib/theme/EditThisPage/index.js +3 -1
  57. package/lib/theme/Footer/index.js +5 -3
  58. package/lib/theme/Heading/index.js +7 -9
  59. package/lib/theme/Heading/styles.css +4 -6
  60. package/lib/theme/Heading/styles.module.css +9 -5
  61. package/lib/theme/IconClose/index.js +31 -0
  62. package/lib/theme/LastUpdated/index.js +4 -2
  63. package/lib/theme/LayoutHead/index.js +13 -11
  64. package/lib/theme/LayoutProviders/index.js +7 -5
  65. package/lib/theme/Logo/index.js +14 -12
  66. package/lib/theme/MDXComponents/index.js +27 -1
  67. package/lib/theme/MDXComponents/styles.css +11 -0
  68. package/lib/theme/MDXPage/index.js +2 -1
  69. package/lib/theme/Navbar/index.js +20 -3
  70. package/lib/theme/Navbar/styles.module.css +5 -1
  71. package/lib/theme/NavbarItem/DefaultNavbarItem.js +12 -4
  72. package/lib/theme/NavbarItem/DocNavbarItem.js +5 -3
  73. package/lib/theme/NavbarItem/DocsVersionDropdownNavbarItem.js +7 -1
  74. package/lib/theme/NavbarItem/DropdownNavbarItem.js +3 -3
  75. package/lib/theme/NavbarItem/{LocaleDropdownNavbarItem.js → LocaleDropdownNavbarItem/index.js} +3 -4
  76. package/lib/theme/NavbarItem/LocaleDropdownNavbarItem/styles.module.css +11 -0
  77. package/lib/theme/NavbarItem/index.js +5 -0
  78. package/lib/theme/Seo/index.js +10 -7
  79. package/lib/theme/TOC/index.js +9 -30
  80. package/lib/theme/TOC/styles.module.css +1 -1
  81. package/lib/theme/TOCCollapsible/index.js +5 -3
  82. package/lib/theme/TOCInline/index.js +7 -27
  83. package/lib/theme/TOCItems/index.js +78 -0
  84. package/lib/theme/Tabs/__tests__/index.test.js +123 -0
  85. package/lib/theme/Tabs/index.js +73 -50
  86. package/lib/theme/Tabs/styles.module.css +0 -13
  87. package/lib/theme/Tag/index.js +40 -0
  88. package/lib/theme/Tag/styles.module.css +70 -0
  89. package/lib/theme/TagsListByLetter/index.js +48 -0
  90. package/lib/theme/TagsListByLetter/styles.module.css +11 -0
  91. package/lib/theme/TagsListInline/index.js +44 -0
  92. package/lib/theme/TagsListInline/styles.module.css +15 -0
  93. package/lib/theme/ThemedImage/index.js +3 -5
  94. package/lib/theme/Toggle/index.js +23 -18
  95. package/lib/theme/Toggle/styles.module.css +91 -0
  96. package/lib/theme/hooks/useHideableNavbar.js +14 -31
  97. package/lib/theme/hooks/useTheme.js +2 -2
  98. package/lib/theme/hooks/useWindowSize.js +2 -7
  99. package/lib/theme/prism-include-languages.js +4 -3
  100. package/lib/translations.js +4 -4
  101. package/lib/types.d.ts +216 -105
  102. package/lib/validateThemeConfig.js +215 -254
  103. package/lib-next/__tests__/validateThemeConfig.test.js +154 -4
  104. package/lib-next/index.js +1 -2
  105. package/lib-next/prism-include-languages.js +0 -2
  106. package/lib-next/theme/AnnouncementBar/index.js +7 -12
  107. package/lib-next/theme/AnnouncementBar/styles.module.css +23 -32
  108. package/lib-next/theme/BackToTopButton/index.js +37 -17
  109. package/lib-next/theme/BackToTopButton/styles.module.css +17 -14
  110. package/lib-next/theme/BlogArchivePage/index.js +80 -0
  111. package/lib-next/theme/BlogLayout/index.js +4 -7
  112. package/lib-next/theme/BlogListPage/index.js +1 -0
  113. package/lib-next/theme/BlogPostAuthor/index.js +46 -0
  114. package/lib-next/theme/BlogPostAuthor/styles.module.css +12 -0
  115. package/lib-next/theme/BlogPostAuthors/index.js +34 -0
  116. package/lib-next/theme/BlogPostAuthors/styles.module.css +11 -0
  117. package/lib-next/theme/BlogPostItem/index.js +79 -86
  118. package/lib-next/theme/BlogPostPage/index.js +55 -8
  119. package/lib-next/theme/BlogSidebar/styles.module.css +2 -2
  120. package/lib-next/theme/BlogTagsListPage/index.js +7 -39
  121. package/lib-next/theme/BlogTagsPostsPage/index.js +3 -4
  122. package/lib-next/theme/CodeBlock/index.js +53 -49
  123. package/lib-next/theme/CodeBlock/styles.module.css +1 -2
  124. package/lib-next/theme/DocItem/index.js +27 -45
  125. package/lib-next/theme/DocItem/styles.module.css +2 -12
  126. package/lib-next/theme/DocItemFooter/index.js +79 -0
  127. package/lib-next/theme/DocItemFooter/styles.module.css +18 -0
  128. package/lib-next/theme/DocPage/index.js +18 -14
  129. package/lib-next/theme/DocSidebar/index.js +18 -15
  130. package/lib-next/theme/DocSidebarItem/index.js +31 -11
  131. package/lib-next/theme/DocTagDocListPage/index.js +89 -0
  132. package/lib-next/theme/DocTagsListPage/index.js +38 -0
  133. package/lib-next/theme/DocVersionBanner/index.js +16 -9
  134. package/lib-next/theme/EditThisPage/index.js +6 -1
  135. package/lib-next/theme/Footer/index.js +14 -3
  136. package/lib-next/theme/Heading/index.js +10 -13
  137. package/lib-next/theme/Heading/styles.css +4 -6
  138. package/lib-next/theme/Heading/styles.module.css +9 -5
  139. package/lib-next/theme/IconClose/index.js +23 -0
  140. package/lib-next/theme/LastUpdated/index.js +3 -2
  141. package/lib-next/theme/LayoutHead/index.js +9 -15
  142. package/lib-next/theme/LayoutProviders/index.js +8 -5
  143. package/lib-next/theme/Logo/index.js +23 -19
  144. package/lib-next/theme/MDXComponents/index.js +20 -1
  145. package/lib-next/theme/MDXComponents/styles.css +11 -0
  146. package/lib-next/theme/MDXPage/index.js +10 -2
  147. package/lib-next/theme/Navbar/index.js +27 -3
  148. package/lib-next/theme/Navbar/styles.module.css +5 -1
  149. package/lib-next/theme/NavbarItem/DefaultNavbarItem.js +15 -4
  150. package/lib-next/theme/NavbarItem/DocNavbarItem.js +5 -3
  151. package/lib-next/theme/NavbarItem/DocsVersionDropdownNavbarItem.js +12 -4
  152. package/lib-next/theme/NavbarItem/DropdownNavbarItem.js +4 -6
  153. package/lib-next/theme/NavbarItem/{LocaleDropdownNavbarItem.js → LocaleDropdownNavbarItem/index.js} +2 -6
  154. package/lib-next/theme/NavbarItem/LocaleDropdownNavbarItem/styles.module.css +11 -0
  155. package/lib-next/theme/NavbarItem/index.js +2 -0
  156. package/lib-next/theme/Seo/index.js +11 -7
  157. package/lib-next/theme/TOC/index.js +12 -36
  158. package/lib-next/theme/TOC/styles.module.css +1 -1
  159. package/lib-next/theme/TOCCollapsible/index.js +12 -3
  160. package/lib-next/theme/TOCInline/index.js +10 -28
  161. package/lib-next/theme/TOCItems/index.js +85 -0
  162. package/lib-next/theme/Tabs/__tests__/index.test.js +142 -0
  163. package/lib-next/theme/Tabs/index.js +91 -43
  164. package/lib-next/theme/Tabs/styles.module.css +0 -13
  165. package/lib-next/theme/Tag/index.js +27 -0
  166. package/lib-next/theme/Tag/styles.module.css +70 -0
  167. package/lib-next/theme/TagsListByLetter/index.js +42 -0
  168. package/lib-next/theme/TagsListByLetter/styles.module.css +11 -0
  169. package/lib-next/theme/TagsListInline/index.js +31 -0
  170. package/lib-next/theme/TagsListInline/styles.module.css +15 -0
  171. package/lib-next/theme/ThemedImage/index.js +3 -3
  172. package/lib-next/theme/Toggle/index.js +20 -15
  173. package/lib-next/theme/Toggle/styles.module.css +91 -0
  174. package/lib-next/theme/hooks/useHideableNavbar.js +31 -47
  175. package/lib-next/theme/hooks/useTheme.js +2 -2
  176. package/lib-next/theme/hooks/useWindowSize.js +2 -6
  177. package/lib-next/theme/prism-include-languages.js +2 -1
  178. package/lib-next/translations.js +6 -10
  179. package/lib-next/types.d.ts +216 -105
  180. package/lib-next/validateThemeConfig.js +40 -36
  181. package/package.json +23 -19
  182. package/src/__tests__/validateThemeConfig.test.js +154 -4
  183. package/src/index.ts +11 -9
  184. package/src/{prism-include-languages.js → prism-include-languages.ts} +0 -0
  185. package/src/theme/AnnouncementBar/index.tsx +8 -12
  186. package/src/theme/AnnouncementBar/styles.module.css +23 -32
  187. package/src/theme/BackToTopButton/index.tsx +39 -17
  188. package/src/theme/BackToTopButton/styles.module.css +17 -14
  189. package/src/theme/BlogArchivePage/index.tsx +91 -0
  190. package/src/theme/BlogLayout/index.tsx +4 -8
  191. package/src/theme/BlogListPage/index.tsx +1 -0
  192. package/src/theme/BlogPostAuthor/index.tsx +49 -0
  193. package/src/theme/BlogPostAuthor/styles.module.css +12 -0
  194. package/src/theme/BlogPostAuthors/index.tsx +36 -0
  195. package/src/theme/BlogPostAuthors/styles.module.css +11 -0
  196. package/src/theme/BlogPostItem/index.tsx +70 -80
  197. package/src/theme/BlogPostPage/index.tsx +57 -8
  198. package/src/theme/BlogSidebar/styles.module.css +2 -2
  199. package/src/theme/BlogTagsListPage/index.tsx +7 -41
  200. package/src/theme/BlogTagsPostsPage/index.tsx +3 -4
  201. package/src/theme/CodeBlock/index.tsx +63 -47
  202. package/src/theme/CodeBlock/styles.module.css +1 -2
  203. package/src/theme/DocItem/index.tsx +27 -46
  204. package/src/theme/DocItem/styles.module.css +2 -12
  205. package/src/theme/DocItemFooter/index.tsx +91 -0
  206. package/src/theme/DocItemFooter/styles.module.css +18 -0
  207. package/src/theme/DocPage/index.tsx +16 -12
  208. package/src/theme/DocSidebar/index.tsx +20 -16
  209. package/src/theme/DocSidebarItem/index.tsx +29 -10
  210. package/src/theme/DocTagDocListPage/index.tsx +89 -0
  211. package/src/theme/DocTagsListPage/index.tsx +41 -0
  212. package/src/theme/DocVersionBanner/index.tsx +26 -15
  213. package/src/theme/EditThisPage/index.tsx +6 -1
  214. package/src/theme/Footer/index.tsx +16 -3
  215. package/src/theme/Heading/index.tsx +10 -13
  216. package/src/theme/Heading/styles.css +4 -6
  217. package/src/theme/Heading/styles.module.css +9 -5
  218. package/src/theme/IconClose/index.tsx +26 -0
  219. package/src/theme/LastUpdated/index.tsx +3 -2
  220. package/src/theme/LayoutHead/index.tsx +9 -9
  221. package/src/theme/LayoutProviders/index.tsx +8 -5
  222. package/src/theme/Logo/index.tsx +19 -15
  223. package/src/theme/MDXComponents/index.tsx +20 -1
  224. package/src/theme/MDXComponents/styles.css +11 -0
  225. package/src/theme/MDXPage/index.tsx +10 -2
  226. package/src/theme/Navbar/index.tsx +26 -2
  227. package/src/theme/Navbar/styles.module.css +5 -1
  228. package/src/theme/NavbarItem/DefaultNavbarItem.tsx +15 -4
  229. package/src/theme/NavbarItem/DocNavbarItem.tsx +9 -5
  230. package/src/theme/NavbarItem/DocsVersionDropdownNavbarItem.tsx +15 -6
  231. package/src/theme/NavbarItem/DocsVersionNavbarItem.tsx +7 -3
  232. package/src/theme/NavbarItem/DropdownNavbarItem.tsx +4 -6
  233. package/src/theme/NavbarItem/{LocaleDropdownNavbarItem.tsx → LocaleDropdownNavbarItem/index.tsx} +6 -5
  234. package/src/theme/NavbarItem/LocaleDropdownNavbarItem/styles.module.css +11 -0
  235. package/src/theme/NavbarItem/index.tsx +6 -1
  236. package/src/theme/Seo/index.tsx +7 -4
  237. package/src/theme/TOC/index.tsx +13 -38
  238. package/src/theme/TOC/styles.module.css +1 -1
  239. package/src/theme/TOCCollapsible/index.tsx +8 -2
  240. package/src/theme/TOCInline/index.tsx +13 -32
  241. package/src/theme/TOCItems/index.tsx +96 -0
  242. package/src/theme/Tabs/__tests__/index.test.tsx +129 -0
  243. package/src/theme/Tabs/index.tsx +93 -49
  244. package/src/theme/Tabs/styles.module.css +0 -13
  245. package/src/theme/Tag/index.tsx +31 -0
  246. package/src/theme/Tag/styles.module.css +70 -0
  247. package/src/theme/TagsListByLetter/index.tsx +45 -0
  248. package/src/theme/TagsListByLetter/styles.module.css +11 -0
  249. package/src/theme/TagsListInline/index.tsx +35 -0
  250. package/src/theme/TagsListInline/styles.module.css +15 -0
  251. package/src/theme/ThemedImage/index.tsx +3 -3
  252. package/src/theme/Toggle/index.tsx +20 -15
  253. package/src/theme/Toggle/styles.module.css +91 -0
  254. package/src/theme/hooks/useContextualSearchFilters.ts +1 -1
  255. package/src/theme/hooks/useHideableNavbar.ts +32 -47
  256. package/src/theme/hooks/useTabGroupChoice.ts +2 -2
  257. package/src/theme/hooks/useTheme.ts +2 -2
  258. package/src/theme/hooks/useWindowSize.ts +2 -7
  259. package/src/theme/prism-include-languages.ts +3 -2
  260. package/src/translations.ts +6 -10
  261. package/src/types.d.ts +216 -105
  262. package/src/{validateThemeConfig.js → validateThemeConfig.ts} +46 -12
  263. package/tsconfig.json +0 -1
  264. package/update-code-translations.js +5 -4
  265. package/update-code-translations.test.js +1 -1
  266. package/update.js +151 -0
  267. package/lib/theme/Toggle/styles.css +0 -103
  268. package/lib/theme/hooks/useScrollPosition.js +0 -51
  269. package/lib/theme/hooks/useTOCHighlight.js +0 -87
  270. package/lib-next/theme/Toggle/styles.css +0 -103
  271. package/lib-next/theme/hooks/useScrollPosition.js +0 -42
  272. package/lib-next/theme/hooks/useTOCHighlight.js +0 -84
  273. package/src/theme/Toggle/styles.css +0 -103
  274. package/src/theme/hooks/useScrollPosition.ts +0 -52
  275. package/src/theme/hooks/useTOCHighlight.ts +0 -98
@@ -0,0 +1,123 @@
1
+ "use strict";
2
+
3
+ var _react = _interopRequireDefault(require("react"));
4
+
5
+ var _reactTestRenderer = _interopRequireDefault(require("react-test-renderer"));
6
+
7
+ var _index = _interopRequireDefault(require("../index"));
8
+
9
+ var _TabItem = _interopRequireDefault(require("../../TabItem"));
10
+
11
+ var _UserPreferencesProvider = _interopRequireDefault(require("@theme/UserPreferencesProvider"));
12
+
13
+ var _themeCommon = require("@docusaurus/theme-common");
14
+
15
+ function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
16
+
17
+ /**
18
+ * Copyright (c) Facebook, Inc. and its affiliates.
19
+ *
20
+ * This source code is licensed under the MIT license found in the
21
+ * LICENSE file in the root directory of this source tree.
22
+ */
23
+ describe('Tabs', () => {
24
+ test('Should reject bad Tabs child', () => {
25
+ expect(() => {
26
+ _reactTestRenderer.default.create(<_index.default>
27
+ <div>Naughty</div>
28
+ <_TabItem.default value="good">Good</_TabItem.default>
29
+ </_index.default>);
30
+ }).toThrowErrorMatchingInlineSnapshot(`"Docusaurus error: Bad <Tabs> child <div>: all children of the <Tabs> component should be <TabItem>, and every <TabItem> should have a unique \\"value\\" prop."`);
31
+ });
32
+ test('Should reject bad Tabs defaultValue', () => {
33
+ expect(() => {
34
+ _reactTestRenderer.default.create(<_index.default defaultValue="bad">
35
+ <_TabItem.default value="v1">Tab 1</_TabItem.default>
36
+ <_TabItem.default value="v2">Tab 2</_TabItem.default>
37
+ </_index.default>);
38
+ }).toThrowErrorMatchingInlineSnapshot(`"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."`);
39
+ });
40
+ test('Should reject duplicate values', () => {
41
+ expect(() => {
42
+ _reactTestRenderer.default.create(<_index.default>
43
+ <_TabItem.default value="v1">Tab 1</_TabItem.default>
44
+ <_TabItem.default value="v2">Tab 2</_TabItem.default>
45
+ <_TabItem.default value="v3">Tab 3</_TabItem.default>
46
+ <_TabItem.default value="v4">Tab 4</_TabItem.default>
47
+ <_TabItem.default value="v1">Tab 5</_TabItem.default>
48
+ <_TabItem.default value="v2">Tab 6</_TabItem.default>
49
+ </_index.default>);
50
+ }).toThrowErrorMatchingInlineSnapshot(`"Docusaurus error: Duplicate values \\"v1, v2\\" found in <Tabs>. Every value needs to be unique."`);
51
+ });
52
+ test('Should accept valid Tabs config', () => {
53
+ expect(() => {
54
+ _reactTestRenderer.default.create(<_themeCommon.ScrollControllerProvider>
55
+ <_UserPreferencesProvider.default>
56
+ <_index.default>
57
+ <_TabItem.default value="v1">Tab 1</_TabItem.default>
58
+ <_TabItem.default value="v2">Tab 2</_TabItem.default>
59
+ </_index.default>
60
+ <_index.default>
61
+ <_TabItem.default value="v1">Tab 1</_TabItem.default>
62
+ <_TabItem.default value="v2" default>
63
+ Tab 2
64
+ </_TabItem.default>
65
+ </_index.default>
66
+ <_index.default defaultValue="v1">
67
+ <_TabItem.default value="v1" label="V1">
68
+ Tab 1
69
+ </_TabItem.default>
70
+ <_TabItem.default value="v2" label="V2">
71
+ Tab 2
72
+ </_TabItem.default>
73
+ </_index.default>
74
+ <_index.default defaultValue="v1" values={[{
75
+ value: 'v1',
76
+ label: 'V1'
77
+ }, {
78
+ value: 'v2',
79
+ label: 'V2'
80
+ }]}>
81
+ <_TabItem.default value="v1">Tab 1</_TabItem.default>
82
+ <_TabItem.default value="v2">Tab 2</_TabItem.default>
83
+ </_index.default>
84
+ <_index.default defaultValue={null} values={[{
85
+ value: 'v1',
86
+ label: 'V1'
87
+ }, {
88
+ value: 'v2',
89
+ label: 'V2'
90
+ }]}>
91
+ <_TabItem.default value="v1">Tab 1</_TabItem.default>
92
+ <_TabItem.default value="v2">Tab 2</_TabItem.default>
93
+ </_index.default>
94
+ <_index.default defaultValue={null}>
95
+ <_TabItem.default value="v1" label="V1">
96
+ Tab 1
97
+ </_TabItem.default>
98
+ <_TabItem.default value="v2" label="V2">
99
+ Tab 2
100
+ </_TabItem.default>
101
+ </_index.default>
102
+ </_UserPreferencesProvider.default>
103
+ </_themeCommon.ScrollControllerProvider>);
104
+ }).not.toThrow(); // TODO Better Jest infrastructure to mock the Layout
105
+ }); // https://github.com/facebook/docusaurus/issues/5729
106
+
107
+ test('Should accept dynamic Tabs with number values', () => {
108
+ expect(() => {
109
+ const tabs = ['Apple', 'Banana', 'Carrot'];
110
+
111
+ _reactTestRenderer.default.create(<_themeCommon.ScrollControllerProvider>
112
+ <_UserPreferencesProvider.default>
113
+ <_index.default values={tabs.map((t, idx) => ({
114
+ label: t,
115
+ value: idx
116
+ }))} defaultValue={0}>
117
+ {tabs.map((t, idx) => <_TabItem.default value={idx}>{t}</_TabItem.default>)}
118
+ </_index.default>
119
+ </_UserPreferencesProvider.default>
120
+ </_themeCommon.ScrollControllerProvider>);
121
+ }).not.toThrow();
122
+ });
123
+ });
@@ -3,12 +3,16 @@
3
3
  Object.defineProperty(exports, "__esModule", {
4
4
  value: true
5
5
  });
6
- exports.default = void 0;
6
+ exports.default = Tabs;
7
7
 
8
8
  var _react = _interopRequireWildcard(require("react"));
9
9
 
10
+ var _useIsBrowser = _interopRequireDefault(require("@docusaurus/useIsBrowser"));
11
+
10
12
  var _useUserPreferencesContext = _interopRequireDefault(require("@theme/hooks/useUserPreferencesContext"));
11
13
 
14
+ var _themeCommon = require("@docusaurus/theme-common");
15
+
12
16
  var _clsx = _interopRequireDefault(require("clsx"));
13
17
 
14
18
  var _stylesModule = _interopRequireDefault(require("./styles.module.css"));
@@ -25,43 +29,66 @@ function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj &&
25
29
  * This source code is licensed under the MIT license found in the
26
30
  * LICENSE file in the root directory of this source tree.
27
31
  */
28
- function isInViewport(element) {
29
- const {
30
- top,
31
- left,
32
- bottom,
33
- right
34
- } = element.getBoundingClientRect();
35
- const {
36
- innerHeight,
37
- innerWidth
38
- } = window;
39
- return top >= 0 && right <= innerWidth && bottom <= innerHeight && left >= 0;
32
+ // A very rough duck type, but good enough to guard against mistakes while
33
+ // allowing customization
34
+ function isTabItem(comp) {
35
+ return typeof comp.props.value !== 'undefined';
40
36
  }
41
37
 
42
- const keys = {
43
- left: 37,
44
- right: 39
45
- };
38
+ function TabsComponent(props) {
39
+ var _ref, _children$find, _children$;
46
40
 
47
- function Tabs(props) {
48
41
  const {
49
42
  lazy,
50
43
  block,
51
- defaultValue,
52
- values,
44
+ defaultValue: defaultValueProp,
45
+ values: valuesProp,
53
46
  groupId,
54
47
  className
55
48
  } = props;
49
+
50
+ const children = _react.Children.map(props.children, child => {
51
+ if ((0, _react.isValidElement)(child) && isTabItem(child)) {
52
+ return child;
53
+ } // child.type.name will give non-sensical values in prod because of
54
+ // minification, but we assume it won't throw in prod.
55
+
56
+
57
+ throw new Error(`Docusaurus error: Bad <Tabs> child <${// @ts-expect-error: guarding against unexpected cases
58
+ typeof child.type === 'string' ? child.type : child.type.name}>: all children of the <Tabs> component should be <TabItem>, and every <TabItem> should have a unique "value" prop.`);
59
+ });
60
+
61
+ const values = valuesProp !== null && valuesProp !== void 0 ? valuesProp : children.map(({
62
+ props: {
63
+ value,
64
+ label
65
+ }
66
+ }) => ({
67
+ value,
68
+ label
69
+ }));
70
+ const dup = (0, _themeCommon.duplicates)(values, (a, b) => a.value === b.value);
71
+
72
+ if (dup.length > 0) {
73
+ throw new Error(`Docusaurus error: Duplicate values "${dup.map(a => a.value).join(', ')}" found in <Tabs>. Every value needs to be unique.`);
74
+ } // When defaultValueProp is null, don't show a default tab
75
+
76
+
77
+ const defaultValue = defaultValueProp === null ? defaultValueProp : (_ref = defaultValueProp !== null && defaultValueProp !== void 0 ? defaultValueProp : (_children$find = children.find(child => child.props.default)) === null || _children$find === void 0 ? void 0 : _children$find.props.value) !== null && _ref !== void 0 ? _ref : (_children$ = children[0]) === null || _children$ === void 0 ? void 0 : _children$.props.value;
78
+
79
+ if (defaultValue !== null && !values.some(a => a.value === defaultValue)) {
80
+ throw new Error(`Docusaurus error: The <Tabs> has a defaultValue "${defaultValue}" but none of its children has the corresponding value. Available values are: ${values.map(a => a.value).join(', ')}. If you intend to show no default tab, use defaultValue={null} instead.`);
81
+ }
82
+
56
83
  const {
57
84
  tabGroupChoices,
58
85
  setTabGroupChoices
59
86
  } = (0, _useUserPreferencesContext.default)();
60
87
  const [selectedValue, setSelectedValue] = (0, _react.useState)(defaultValue);
61
-
62
- const children = _react.Children.toArray(props.children);
63
-
64
88
  const tabRefs = [];
89
+ const {
90
+ blockElementScrollPositionUntilNextRender
91
+ } = (0, _themeCommon.useScrollPositionBlocker)();
65
92
 
66
93
  if (groupId != null) {
67
94
  const relevantTabGroupChoice = tabGroupChoices[groupId];
@@ -72,44 +99,36 @@ function Tabs(props) {
72
99
  }
73
100
 
74
101
  const handleTabChange = event => {
75
- const selectedTab = event.currentTarget;
76
- const selectedTabIndex = tabRefs.indexOf(selectedTab);
77
- const selectedTabValue = values[selectedTabIndex].value;
78
- setSelectedValue(selectedTabValue);
79
-
80
- if (groupId != null) {
81
- setTabGroupChoices(groupId, selectedTabValue);
82
- setTimeout(() => {
83
- if (isInViewport(selectedTab)) {
84
- return;
85
- }
102
+ const newTab = event.currentTarget;
103
+ const newTabIndex = tabRefs.indexOf(newTab);
104
+ const newTabValue = values[newTabIndex].value;
86
105
 
87
- selectedTab.scrollIntoView({
88
- block: 'center',
89
- behavior: 'smooth'
90
- });
91
- selectedTab.classList.add(_stylesModule.default.tabItemActive);
92
- setTimeout(() => selectedTab.classList.remove(_stylesModule.default.tabItemActive), 2000);
93
- }, 150);
106
+ if (newTabValue !== selectedValue) {
107
+ blockElementScrollPositionUntilNextRender(newTab);
108
+ setSelectedValue(newTabValue);
109
+
110
+ if (groupId != null) {
111
+ setTabGroupChoices(groupId, newTabValue);
112
+ }
94
113
  }
95
114
  };
96
115
 
97
116
  const handleKeydown = event => {
98
117
  var _focusElement;
99
118
 
100
- let focusElement;
119
+ let focusElement = null;
101
120
 
102
- switch (event.keyCode) {
103
- case keys.right:
121
+ switch (event.key) {
122
+ case 'ArrowRight':
104
123
  {
105
- const nextTab = tabRefs.indexOf(event.target) + 1;
124
+ const nextTab = tabRefs.indexOf(event.currentTarget) + 1;
106
125
  focusElement = tabRefs[nextTab] || tabRefs[0];
107
126
  break;
108
127
  }
109
128
 
110
- case keys.left:
129
+ case 'ArrowLeft':
111
130
  {
112
- const prevTab = tabRefs.indexOf(event.target) - 1;
131
+ const prevTab = tabRefs.indexOf(event.currentTarget) - 1;
113
132
  focusElement = tabRefs[prevTab] || tabRefs[tabRefs.length - 1];
114
133
  break;
115
134
  }
@@ -131,7 +150,7 @@ function Tabs(props) {
131
150
  }) => <li role="tab" tabIndex={selectedValue === value ? 0 : -1} aria-selected={selectedValue === value} className={(0, _clsx.default)('tabs__item', _stylesModule.default.tabItem, {
132
151
  'tabs__item--active': selectedValue === value
133
152
  })} key={value} ref={tabControl => tabRefs.push(tabControl)} onKeyDown={handleKeydown} onFocus={handleTabChange} onClick={handleTabChange}>
134
- {label}
153
+ {label !== null && label !== void 0 ? label : value}
135
154
  </li>)}
136
155
  </ul>
137
156
 
@@ -146,5 +165,9 @@ function Tabs(props) {
146
165
  </div>;
147
166
  }
148
167
 
149
- var _default = Tabs;
150
- exports.default = _default;
168
+ function Tabs(props) {
169
+ const isBrowser = (0, _useIsBrowser.default)();
170
+ return <TabsComponent // Remount tabs after hydration
171
+ // Temporary fix for https://github.com/facebook/docusaurus/issues/5653
172
+ key={String(isBrowser)} {...props} />;
173
+ }
@@ -8,16 +8,3 @@
8
8
  .tabItem {
9
9
  margin-top: 0 !important;
10
10
  }
11
-
12
- .tabItemActive {
13
- animation: blink 0.5s ease-in-out 5;
14
- }
15
-
16
- @keyframes blink {
17
- 0% {
18
- background-color: var(--ifm-hover-overlay);
19
- }
20
- 100% {
21
- background-color: rgba(0, 0, 0, 0);
22
- }
23
- }
@@ -0,0 +1,40 @@
1
+ "use strict";
2
+
3
+ Object.defineProperty(exports, "__esModule", {
4
+ value: true
5
+ });
6
+ exports.default = void 0;
7
+
8
+ var _react = _interopRequireDefault(require("react"));
9
+
10
+ var _clsx = _interopRequireDefault(require("clsx"));
11
+
12
+ var _Link = _interopRequireDefault(require("@docusaurus/Link"));
13
+
14
+ var _stylesModule = _interopRequireDefault(require("./styles.module.css"));
15
+
16
+ function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
17
+
18
+ /**
19
+ * Copyright (c) Facebook, Inc. and its affiliates.
20
+ *
21
+ * This source code is licensed under the MIT license found in the
22
+ * LICENSE file in the root directory of this source tree.
23
+ */
24
+ function Tag(props) {
25
+ const {
26
+ permalink,
27
+ name,
28
+ count
29
+ } = props;
30
+ return <_Link.default href={permalink} className={(0, _clsx.default)(_stylesModule.default.tag, {
31
+ [_stylesModule.default.tagRegular]: !count,
32
+ [_stylesModule.default.tagWithCount]: count
33
+ })}>
34
+ {name}
35
+ {count && <span>{count}</span>}
36
+ </_Link.default>;
37
+ }
38
+
39
+ var _default = Tag;
40
+ exports.default = _default;
@@ -0,0 +1,70 @@
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
+ :root {
9
+ --docusaurus-tag-list-border: var(--ifm-color-emphasis-300);
10
+ }
11
+
12
+ .tag {
13
+ border: 1px solid var(--docusaurus-tag-list-border);
14
+ transition: border var(--ifm-transition-fast);
15
+ }
16
+
17
+ .tag:hover {
18
+ --docusaurus-tag-list-border: var(--ifm-link-color);
19
+ text-decoration: none;
20
+ }
21
+
22
+ .tagRegular {
23
+ border-radius: 0.5rem;
24
+ padding: 0.3rem 0.5rem;
25
+ font-size: 90%;
26
+ }
27
+
28
+ .tagWithCount {
29
+ display: flex;
30
+ align-items: center;
31
+ position: relative;
32
+ padding: 0 0.5rem 0 1rem;
33
+ border-left: 0;
34
+ }
35
+
36
+ .tagWithCount:before,
37
+ .tagWithCount:after {
38
+ content: '';
39
+ position: absolute;
40
+ top: 50%;
41
+ border: 1px solid var(--docusaurus-tag-list-border);
42
+ transition: inherit;
43
+ }
44
+
45
+ .tagWithCount:before {
46
+ right: 100%;
47
+ transform: translate(50%, -50%) rotate(-45deg);
48
+ width: 1.18rem;
49
+ height: 1.18rem;
50
+ border-right: 0;
51
+ border-bottom: 0;
52
+ }
53
+
54
+ .tagWithCount:after {
55
+ left: 0;
56
+ transform: translateY(-50%);
57
+ width: 0.5rem;
58
+ height: 0.5rem;
59
+ border-radius: 50%;
60
+ }
61
+
62
+ .tagWithCount span {
63
+ background: var(--ifm-color-secondary);
64
+ color: var(--ifm-color-black);
65
+ font-size: 0.7rem;
66
+ line-height: 1.2;
67
+ border-radius: var(--ifm-global-radius);
68
+ padding: 0.1rem 0.4rem;
69
+ margin-left: 0.3rem;
70
+ }
@@ -0,0 +1,48 @@
1
+ "use strict";
2
+
3
+ Object.defineProperty(exports, "__esModule", {
4
+ value: true
5
+ });
6
+ exports.default = void 0;
7
+
8
+ var _react = _interopRequireDefault(require("react"));
9
+
10
+ var _Tag = _interopRequireDefault(require("@theme/Tag"));
11
+
12
+ var _themeCommon = require("@docusaurus/theme-common");
13
+
14
+ var _stylesModule = _interopRequireDefault(require("./styles.module.css"));
15
+
16
+ function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
17
+
18
+ /**
19
+ * Copyright (c) Facebook, Inc. and its affiliates.
20
+ *
21
+ * This source code is licensed under the MIT license found in the
22
+ * LICENSE file in the root directory of this source tree.
23
+ */
24
+ function TagLetterEntryItem({
25
+ letterEntry
26
+ }) {
27
+ return <article>
28
+ <h2>{letterEntry.letter}</h2>
29
+ <ul className="padding--none">
30
+ {letterEntry.tags.map(tag => <li key={tag.permalink} className={_stylesModule.default.tag}>
31
+ <_Tag.default {...tag} />
32
+ </li>)}
33
+ </ul>
34
+ <hr />
35
+ </article>;
36
+ }
37
+
38
+ function TagsListByLetter({
39
+ tags
40
+ }) {
41
+ const letterList = (0, _themeCommon.listTagsByLetters)(tags);
42
+ return <section className="margin-vert--lg">
43
+ {letterList.map(letterEntry => <TagLetterEntryItem key={letterEntry.letter} letterEntry={letterEntry} />)}
44
+ </section>;
45
+ }
46
+
47
+ var _default = TagsListByLetter;
48
+ exports.default = _default;
@@ -0,0 +1,11 @@
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
+ .tag {
9
+ display: inline-block;
10
+ margin: 0.5rem 0.5rem 0 1rem;
11
+ }
@@ -0,0 +1,44 @@
1
+ "use strict";
2
+
3
+ Object.defineProperty(exports, "__esModule", {
4
+ value: true
5
+ });
6
+ exports.default = TagsListInline;
7
+
8
+ var _react = _interopRequireDefault(require("react"));
9
+
10
+ var _clsx = _interopRequireDefault(require("clsx"));
11
+
12
+ var _Translate = _interopRequireDefault(require("@docusaurus/Translate"));
13
+
14
+ var _Tag = _interopRequireDefault(require("@theme/Tag"));
15
+
16
+ var _stylesModule = _interopRequireDefault(require("./styles.module.css"));
17
+
18
+ function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
19
+
20
+ /**
21
+ * Copyright (c) Facebook, Inc. and its affiliates.
22
+ *
23
+ * This source code is licensed under the MIT license found in the
24
+ * LICENSE file in the root directory of this source tree.
25
+ */
26
+ function TagsListInline({
27
+ tags
28
+ }) {
29
+ return <>
30
+ <b>
31
+ <_Translate.default id="theme.tags.tagsListLabel" description="The label alongside a tag list">
32
+ Tags:
33
+ </_Translate.default>
34
+ </b>
35
+ <ul className={(0, _clsx.default)(_stylesModule.default.tags, 'padding--none', 'margin-left--sm')}>
36
+ {tags.map(({
37
+ label,
38
+ permalink: tagPermalink
39
+ }) => <li key={tagPermalink} className={_stylesModule.default.tag}>
40
+ <_Tag.default name={label} permalink={tagPermalink} />
41
+ </li>)}
42
+ </ul>
43
+ </>;
44
+ }
@@ -0,0 +1,15 @@
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
+ .tags {
9
+ display: inline;
10
+ }
11
+
12
+ .tag {
13
+ margin: 0 0.4rem 0.5rem 0;
14
+ display: inline-block;
15
+ }
@@ -9,7 +9,7 @@ var _react = _interopRequireDefault(require("react"));
9
9
 
10
10
  var _clsx = _interopRequireDefault(require("clsx"));
11
11
 
12
- var _useDocusaurusContext = _interopRequireDefault(require("@docusaurus/useDocusaurusContext"));
12
+ var _useIsBrowser = _interopRequireDefault(require("@docusaurus/useIsBrowser"));
13
13
 
14
14
  var _useThemeContext = _interopRequireDefault(require("@theme/hooks/useThemeContext"));
15
15
 
@@ -24,9 +24,7 @@ function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { de
24
24
  * LICENSE file in the root directory of this source tree.
25
25
  */
26
26
  const ThemedImage = props => {
27
- const {
28
- isClient
29
- } = (0, _useDocusaurusContext.default)();
27
+ const isBrowser = (0, _useIsBrowser.default)();
30
28
  const {
31
29
  isDarkTheme
32
30
  } = (0, _useThemeContext.default)();
@@ -37,7 +35,7 @@ const ThemedImage = props => {
37
35
  ...propsRest
38
36
  } = props;
39
37
  const clientThemes = isDarkTheme ? ['dark'] : ['light'];
40
- const renderedSourceNames = isClient ? clientThemes : // We need to render both images on the server to avoid flash
38
+ const renderedSourceNames = isBrowser ? clientThemes : // We need to render both images on the server to avoid flash
41
39
  // See https://github.com/facebook/docusaurus/pull/3730
42
40
  ['light', 'dark'];
43
41
  return <>
@@ -9,12 +9,10 @@ var _react = _interopRequireWildcard(require("react"));
9
9
 
10
10
  var _themeCommon = require("@docusaurus/theme-common");
11
11
 
12
- var _useDocusaurusContext = _interopRequireDefault(require("@docusaurus/useDocusaurusContext"));
12
+ var _useIsBrowser = _interopRequireDefault(require("@docusaurus/useIsBrowser"));
13
13
 
14
14
  var _clsx = _interopRequireDefault(require("clsx"));
15
15
 
16
- require("./styles.css");
17
-
18
16
  var _stylesModule = _interopRequireDefault(require("./styles.module.css"));
19
17
 
20
18
  function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
@@ -32,14 +30,14 @@ function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj &&
32
30
  const Dark = ({
33
31
  icon,
34
32
  style
35
- }) => <span className={(0, _clsx.default)(_stylesModule.default.toggle, _stylesModule.default.dark)} style={style}>
33
+ }) => <span className={(0, _clsx.default)(_stylesModule.default.toggleIcon, _stylesModule.default.dark)} style={style}>
36
34
  {icon}
37
35
  </span>;
38
36
 
39
37
  const Light = ({
40
38
  icon,
41
39
  style
42
- }) => <span className={(0, _clsx.default)(_stylesModule.default.toggle, _stylesModule.default.light)} style={style}>
40
+ }) => <span className={(0, _clsx.default)(_stylesModule.default.toggleIcon, _stylesModule.default.light)} style={style}>
43
41
  {icon}
44
42
  </span>; // Based on react-toggle (https://github.com/aaronshaf/react-toggle/).
45
43
 
@@ -54,22 +52,31 @@ const Toggle = (0, _react.memo)(({
54
52
  const [checked, setChecked] = (0, _react.useState)(defaultChecked);
55
53
  const [focused, setFocused] = (0, _react.useState)(false);
56
54
  const inputRef = (0, _react.useRef)(null);
57
- return <div className={(0, _clsx.default)('react-toggle', className, {
58
- 'react-toggle--checked': checked,
59
- 'react-toggle--focus': focused,
60
- 'react-toggle--disabled': disabled
55
+ return <div className={(0, _clsx.default)(_stylesModule.default.toggle, className, {
56
+ [_stylesModule.default.toggleChecked]: checked,
57
+ [_stylesModule.default.toggleFocused]: focused,
58
+ [_stylesModule.default.toggleDisabled]: disabled
61
59
  })}>
62
- <div className="react-toggle-track" role="button" tabIndex={-1} onClick={() => {
60
+ {
61
+ /* eslint-disable-next-line jsx-a11y/click-events-have-key-events */
62
+ }
63
+ <div className={_stylesModule.default.toggleTrack} role="button" tabIndex={-1} onClick={() => {
63
64
  var _inputRef$current;
64
65
 
65
66
  return (_inputRef$current = inputRef.current) === null || _inputRef$current === void 0 ? void 0 : _inputRef$current.click();
66
67
  }}>
67
- <div className="react-toggle-track-check">{icons.checked}</div>
68
- <div className="react-toggle-track-x">{icons.unchecked}</div>
69
- <div className="react-toggle-thumb" />
68
+ <div className={_stylesModule.default.toggleTrackCheck}>{icons.checked}</div>
69
+ <div className={_stylesModule.default.toggleTrackX}>{icons.unchecked}</div>
70
+ <div className={_stylesModule.default.toggleTrackThumb} />
70
71
  </div>
71
72
 
72
- <input ref={inputRef} checked={checked} type="checkbox" className="react-toggle-screenreader-only" aria-label="Switch between dark and light mode" onChange={onChange} onClick={() => setChecked(!checked)} onFocus={() => setFocused(true)} onBlur={() => setFocused(false)} />
73
+ <input ref={inputRef} checked={checked} type="checkbox" className={_stylesModule.default.toggleScreenReader} aria-label="Switch between dark and light mode" onChange={onChange} onClick={() => setChecked(!checked)} onFocus={() => setFocused(true)} onBlur={() => setFocused(false)} onKeyDown={e => {
74
+ if (e.key === 'Enter') {
75
+ var _inputRef$current2;
76
+
77
+ (_inputRef$current2 = inputRef.current) === null || _inputRef$current2 === void 0 ? void 0 : _inputRef$current2.click();
78
+ }
79
+ }} />
73
80
  </div>;
74
81
  });
75
82
 
@@ -84,10 +91,8 @@ function _default(props) {
84
91
  }
85
92
  }
86
93
  } = (0, _themeCommon.useThemeConfig)();
87
- const {
88
- isClient
89
- } = (0, _useDocusaurusContext.default)();
90
- return <Toggle disabled={!isClient} icons={{
94
+ const isBrowser = (0, _useIsBrowser.default)();
95
+ return <Toggle disabled={!isBrowser} icons={{
91
96
  checked: <Dark icon={darkIcon} style={darkIconStyle} />,
92
97
  unchecked: <Light icon={lightIcon} style={lightIconStyle} />
93
98
  }} {...props} />;