@docusaurus/theme-classic 2.0.0-beta.12faed89d → 2.0.0-beta.13
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.
- package/README.md +1 -1
- package/lib/__tests__/validateThemeConfig.test.js +277 -3
- package/lib/admonitions.css +35 -0
- package/lib/deps.d.ts +13 -0
- package/lib/index.js +16 -15
- package/lib/prism-include-languages.js +9 -5
- package/lib/theme/AnnouncementBar/index.js +8 -12
- package/lib/theme/AnnouncementBar/styles.module.css +23 -32
- package/lib/theme/BackToTopButton/index.js +140 -0
- package/lib/theme/BackToTopButton/styles.module.css +42 -0
- package/lib/theme/BlogArchivePage/index.js +89 -0
- package/lib/theme/BlogLayout/index.js +51 -0
- package/lib/theme/BlogListPage/index.js +10 -21
- package/lib/theme/BlogPostAuthor/index.js +51 -0
- package/lib/theme/BlogPostAuthor/styles.module.css +12 -0
- package/lib/theme/BlogPostAuthors/index.js +47 -0
- package/lib/theme/BlogPostAuthors/styles.module.css +11 -0
- package/lib/theme/BlogPostItem/index.js +58 -67
- package/lib/theme/BlogPostPage/index.js +37 -24
- package/lib/theme/BlogSidebar/index.js +5 -7
- package/lib/theme/BlogSidebar/styles.module.css +2 -2
- package/lib/theme/BlogTagsListPage/index.js +8 -44
- package/lib/theme/BlogTagsPostsPage/index.js +24 -38
- package/lib/theme/CodeBlock/index.js +18 -138
- package/lib/theme/CodeBlock/styles.module.css +6 -9
- package/lib/theme/Details/index.js +30 -0
- package/lib/theme/Details/styles.module.css +13 -0
- package/lib/theme/DocCard/index.js +84 -0
- package/lib/theme/DocCard/styles.module.css +43 -0
- package/lib/theme/DocCardList/index.js +28 -0
- package/lib/theme/DocCategoryGeneratedIndexPage/index.js +57 -0
- package/lib/theme/DocCategoryGeneratedIndexPage/styles.module.css +18 -0
- package/lib/theme/DocItem/index.js +22 -48
- package/lib/theme/DocItem/styles.module.css +2 -11
- package/lib/theme/DocItemFooter/index.js +79 -0
- package/lib/theme/DocItemFooter/styles.module.css +18 -0
- package/lib/theme/DocPage/index.js +35 -20
- package/lib/theme/DocPaginator/index.js +6 -7
- package/lib/theme/DocSidebar/index.js +23 -22
- package/lib/theme/DocSidebarItem/index.js +84 -50
- package/lib/theme/DocSidebarItem/styles.module.css +4 -0
- package/lib/theme/DocTagDocListPage/index.js +89 -0
- package/lib/theme/DocTagsListPage/index.js +44 -0
- package/lib/theme/DocVersionBadge/index.js +34 -0
- package/lib/theme/DocVersionBanner/index.js +12 -10
- package/lib/theme/EditThisPage/index.js +3 -1
- package/lib/theme/ErrorPageContent.js +43 -0
- package/lib/theme/Footer/index.js +8 -4
- package/lib/theme/Heading/index.js +17 -22
- package/lib/theme/Heading/styles.css +5 -6
- package/lib/theme/Heading/styles.module.css +9 -5
- package/lib/theme/IconArrow/index.js +2 -2
- package/lib/theme/IconClose/index.js +31 -0
- package/lib/theme/IconEdit/index.js +3 -3
- package/lib/theme/IconExternalLink/index.js +3 -3
- package/lib/theme/IconLanguage/index.js +3 -3
- package/lib/theme/IconMenu/index.js +3 -3
- package/lib/theme/LastUpdated/index.js +4 -2
- package/lib/theme/Layout/index.js +5 -1
- package/lib/theme/LayoutHead/index.js +22 -17
- package/lib/theme/LayoutProviders/index.js +7 -5
- package/lib/theme/Logo/index.js +16 -14
- package/lib/theme/MDXComponents/index.js +45 -4
- package/lib/theme/MDXComponents/styles.css +11 -0
- package/lib/theme/MDXPage/index.js +2 -1
- package/lib/theme/Navbar/index.js +46 -27
- package/lib/theme/Navbar/styles.module.css +3 -39
- package/lib/theme/NavbarItem/DefaultNavbarItem.js +27 -124
- package/lib/theme/NavbarItem/DocNavbarItem.js +7 -8
- package/lib/theme/NavbarItem/DocsVersionDropdownNavbarItem.js +19 -12
- package/lib/theme/NavbarItem/DropdownNavbarItem.js +155 -0
- package/lib/theme/NavbarItem/{LocaleDropdownNavbarItem.js → LocaleDropdownNavbarItem/index.js} +6 -10
- package/lib/theme/NavbarItem/LocaleDropdownNavbarItem/styles.module.css +11 -0
- package/lib/theme/NavbarItem/index.js +31 -11
- package/lib/theme/{SearchMetadatas → SearchMetadata}/index.js +2 -2
- package/lib/theme/Seo/index.js +10 -7
- package/lib/theme/TOC/index.js +9 -30
- package/lib/theme/TOC/styles.module.css +1 -1
- package/lib/theme/TOCCollapsible/index.js +7 -5
- package/lib/theme/TOCCollapsible/styles.module.css +1 -0
- package/lib/theme/TOCInline/index.js +7 -27
- package/lib/theme/TOCItems/index.js +78 -0
- package/lib/theme/Tabs/__tests__/index.test.js +123 -0
- package/lib/theme/Tabs/index.js +73 -50
- package/lib/theme/Tabs/styles.module.css +0 -13
- package/lib/theme/Tag/index.js +40 -0
- package/lib/theme/Tag/styles.module.css +70 -0
- package/lib/theme/TagsListByLetter/index.js +48 -0
- package/lib/theme/TagsListByLetter/styles.module.css +11 -0
- package/lib/theme/TagsListInline/index.js +44 -0
- package/lib/theme/TagsListInline/styles.module.css +15 -0
- package/lib/theme/ThemeProvider/index.js +8 -3
- package/lib/theme/ThemedImage/index.js +5 -7
- package/lib/theme/Toggle/index.js +41 -44
- package/lib/theme/Toggle/styles.module.css +91 -3
- package/lib/theme/UserPreferencesProvider/index.js +8 -3
- package/lib/theme/hooks/useHideableNavbar.js +14 -32
- package/lib/theme/hooks/useTheme.js +3 -5
- package/lib/theme/hooks/useWindowSize.js +2 -7
- package/lib/theme/prism-include-languages.js +4 -3
- package/lib/theme-classic.d.ts +806 -0
- package/lib/translations.js +4 -4
- package/lib/types.d.ts +0 -629
- package/lib/validateThemeConfig.js +230 -248
- package/lib-next/__tests__/validateThemeConfig.test.js +277 -3
- package/lib-next/admonitions.css +35 -0
- package/lib-next/deps.d.ts +13 -0
- package/lib-next/index.js +16 -10
- package/lib-next/prism-include-languages.js +0 -2
- package/lib-next/theme/AnnouncementBar/index.js +7 -12
- package/lib-next/theme/AnnouncementBar/styles.module.css +23 -32
- package/lib-next/theme/BackToTopButton/index.js +131 -0
- package/lib-next/theme/BackToTopButton/styles.module.css +42 -0
- package/lib-next/theme/BlogArchivePage/index.js +80 -0
- package/lib-next/theme/BlogLayout/index.js +40 -0
- package/lib-next/theme/BlogListPage/index.js +17 -25
- package/lib-next/theme/BlogPostAuthor/index.js +46 -0
- package/lib-next/theme/BlogPostAuthor/styles.module.css +12 -0
- package/lib-next/theme/BlogPostAuthors/index.js +34 -0
- package/lib-next/theme/BlogPostAuthors/styles.module.css +11 -0
- package/lib-next/theme/BlogPostItem/index.js +79 -86
- package/lib-next/theme/BlogPostPage/index.js +70 -35
- package/lib-next/theme/BlogSidebar/index.js +11 -13
- package/lib-next/theme/BlogSidebar/styles.module.css +2 -2
- package/lib-next/theme/BlogTagsListPage/index.js +14 -55
- package/lib-next/theme/BlogTagsPostsPage/index.js +29 -39
- package/lib-next/theme/CodeBlock/index.js +17 -149
- package/lib-next/theme/CodeBlock/styles.module.css +6 -9
- package/lib-next/theme/Details/index.js +20 -0
- package/lib-next/theme/Details/styles.module.css +13 -0
- package/lib-next/theme/DocCard/index.js +80 -0
- package/lib-next/theme/DocCard/styles.module.css +43 -0
- package/lib-next/theme/DocCardList/index.js +19 -0
- package/lib-next/theme/DocCategoryGeneratedIndexPage/index.js +49 -0
- package/lib-next/theme/DocCategoryGeneratedIndexPage/styles.module.css +18 -0
- package/lib-next/theme/DocItem/index.js +30 -59
- package/lib-next/theme/DocItem/styles.module.css +2 -11
- package/lib-next/theme/DocItemFooter/index.js +79 -0
- package/lib-next/theme/DocItemFooter/styles.module.css +18 -0
- package/lib-next/theme/DocPage/index.js +46 -23
- package/lib-next/theme/DocPaginator/index.js +7 -11
- package/lib-next/theme/DocSidebar/index.js +37 -43
- package/lib-next/theme/DocSidebarItem/index.js +115 -65
- package/lib-next/theme/DocSidebarItem/styles.module.css +4 -0
- package/lib-next/theme/DocTagDocListPage/index.js +89 -0
- package/lib-next/theme/DocTagsListPage/index.js +38 -0
- package/lib-next/theme/DocVersionBadge/index.js +27 -0
- package/lib-next/theme/DocVersionBanner/index.js +28 -14
- package/lib-next/theme/EditThisPage/index.js +6 -1
- package/lib-next/theme/ErrorPageContent.js +35 -0
- package/lib-next/theme/Footer/index.js +17 -4
- package/lib-next/theme/Heading/index.js +25 -29
- package/lib-next/theme/Heading/styles.css +5 -6
- package/lib-next/theme/Heading/styles.module.css +9 -5
- package/lib-next/theme/IconArrow/index.js +2 -2
- package/lib-next/theme/IconClose/index.js +23 -0
- package/lib-next/theme/IconEdit/index.js +2 -2
- package/lib-next/theme/IconExternalLink/index.js +2 -2
- package/lib-next/theme/IconLanguage/index.js +2 -2
- package/lib-next/theme/IconMenu/index.js +2 -2
- package/lib-next/theme/LastUpdated/index.js +3 -2
- package/lib-next/theme/Layout/index.js +3 -1
- package/lib-next/theme/LayoutHead/index.js +18 -23
- package/lib-next/theme/LayoutProviders/index.js +8 -5
- package/lib-next/theme/Logo/index.js +25 -21
- package/lib-next/theme/MDXComponents/index.js +34 -7
- package/lib-next/theme/MDXComponents/styles.css +11 -0
- package/lib-next/theme/MDXPage/index.js +10 -2
- package/lib-next/theme/Navbar/index.js +62 -34
- package/lib-next/theme/Navbar/styles.module.css +3 -39
- package/lib-next/theme/NavbarItem/DefaultNavbarItem.js +45 -143
- package/lib-next/theme/NavbarItem/DocNavbarItem.js +7 -7
- package/lib-next/theme/NavbarItem/DocsVersionDropdownNavbarItem.js +31 -19
- package/lib-next/theme/NavbarItem/DropdownNavbarItem.js +159 -0
- package/lib-next/theme/NavbarItem/{LocaleDropdownNavbarItem.js → LocaleDropdownNavbarItem/index.js} +4 -12
- package/lib-next/theme/NavbarItem/LocaleDropdownNavbarItem/styles.module.css +11 -0
- package/lib-next/theme/NavbarItem/index.js +25 -12
- package/lib-next/theme/{SearchMetadatas → SearchMetadata}/index.js +1 -1
- package/lib-next/theme/Seo/index.js +11 -7
- package/lib-next/theme/TOC/index.js +12 -36
- package/lib-next/theme/TOC/styles.module.css +1 -1
- package/lib-next/theme/TOCCollapsible/index.js +13 -4
- package/lib-next/theme/TOCCollapsible/styles.module.css +1 -0
- package/lib-next/theme/TOCInline/index.js +10 -28
- package/lib-next/theme/TOCItems/index.js +85 -0
- package/lib-next/theme/Tabs/__tests__/index.test.js +142 -0
- package/lib-next/theme/Tabs/index.js +91 -43
- package/lib-next/theme/Tabs/styles.module.css +0 -13
- package/lib-next/theme/Tag/index.js +27 -0
- package/lib-next/theme/Tag/styles.module.css +70 -0
- package/lib-next/theme/TagsListByLetter/index.js +42 -0
- package/lib-next/theme/TagsListByLetter/styles.module.css +11 -0
- package/lib-next/theme/TagsListInline/index.js +31 -0
- package/lib-next/theme/TagsListInline/styles.module.css +15 -0
- package/lib-next/theme/ThemeProvider/index.js +10 -7
- package/lib-next/theme/ThemedImage/index.js +5 -5
- package/lib-next/theme/Toggle/index.js +34 -37
- package/lib-next/theme/Toggle/styles.module.css +91 -3
- package/lib-next/theme/UserPreferencesProvider/index.js +9 -6
- package/lib-next/theme/hooks/useHideableNavbar.js +31 -44
- package/lib-next/theme/hooks/useTheme.js +4 -5
- package/lib-next/theme/hooks/useWindowSize.js +2 -6
- package/lib-next/theme/prism-include-languages.js +2 -1
- package/lib-next/theme-classic.d.ts +806 -0
- package/lib-next/translations.js +6 -10
- package/lib-next/types.d.ts +0 -629
- package/lib-next/validateThemeConfig.js +141 -116
- package/package.json +27 -24
- package/src/__tests__/validateThemeConfig.test.js +277 -3
- package/src/admonitions.css +35 -0
- package/src/deps.d.ts +13 -0
- package/src/index.ts +23 -17
- package/src/{prism-include-languages.js → prism-include-languages.ts} +0 -0
- package/src/theme/AnnouncementBar/index.tsx +8 -12
- package/src/theme/AnnouncementBar/styles.module.css +23 -32
- package/src/theme/BackToTopButton/index.tsx +142 -0
- package/src/theme/BackToTopButton/styles.module.css +42 -0
- package/src/theme/BlogArchivePage/index.tsx +91 -0
- package/src/theme/BlogLayout/index.tsx +44 -0
- package/src/theme/BlogListPage/index.tsx +18 -25
- package/src/theme/BlogPostAuthor/index.tsx +49 -0
- package/src/theme/BlogPostAuthor/styles.module.css +12 -0
- package/src/theme/BlogPostAuthors/index.tsx +39 -0
- package/src/theme/BlogPostAuthors/styles.module.css +11 -0
- package/src/theme/BlogPostItem/index.tsx +70 -80
- package/src/theme/BlogPostPage/index.tsx +72 -35
- package/src/theme/BlogSidebar/index.tsx +11 -13
- package/src/theme/BlogSidebar/styles.module.css +2 -2
- package/src/theme/BlogTagsListPage/index.tsx +14 -57
- package/src/theme/BlogTagsPostsPage/index.tsx +29 -39
- package/src/theme/CodeBlock/index.tsx +21 -151
- package/src/theme/CodeBlock/styles.module.css +6 -9
- package/src/theme/Details/index.tsx +24 -0
- package/src/theme/Details/styles.module.css +13 -0
- package/src/theme/DocCard/index.tsx +100 -0
- package/src/theme/DocCard/styles.module.css +43 -0
- package/src/theme/DocCardList/index.tsx +27 -0
- package/src/theme/DocCategoryGeneratedIndexPage/index.tsx +53 -0
- package/src/theme/DocCategoryGeneratedIndexPage/styles.module.css +18 -0
- package/src/theme/DocItem/index.tsx +30 -60
- package/src/theme/DocItem/styles.module.css +2 -11
- package/src/theme/DocItemFooter/index.tsx +91 -0
- package/src/theme/DocItemFooter/styles.module.css +18 -0
- package/src/theme/DocPage/index.tsx +44 -22
- package/src/theme/DocPaginator/index.tsx +9 -13
- package/src/theme/DocSidebar/index.tsx +38 -39
- package/src/theme/DocSidebarItem/index.tsx +108 -49
- package/src/theme/DocSidebarItem/styles.module.css +4 -0
- package/src/theme/DocTagDocListPage/index.tsx +89 -0
- package/src/theme/DocTagsListPage/index.tsx +41 -0
- package/src/theme/DocVersionBadge/index.tsx +30 -0
- package/src/theme/DocVersionBanner/index.tsx +48 -21
- package/src/theme/EditThisPage/index.tsx +6 -1
- package/src/theme/ErrorPageContent.tsx +41 -0
- package/src/theme/Footer/index.tsx +20 -5
- package/src/theme/Heading/index.tsx +25 -31
- package/src/theme/Heading/styles.css +5 -6
- package/src/theme/Heading/styles.module.css +9 -5
- package/src/theme/IconArrow/index.tsx +2 -2
- package/src/theme/IconClose/index.tsx +26 -0
- package/src/theme/IconEdit/index.tsx +2 -2
- package/src/theme/IconExternalLink/index.tsx +2 -5
- package/src/theme/IconLanguage/index.tsx +2 -6
- package/src/theme/IconMenu/index.tsx +3 -3
- package/src/theme/LastUpdated/index.tsx +3 -2
- package/src/theme/Layout/index.tsx +3 -1
- package/src/theme/LayoutHead/index.tsx +18 -17
- package/src/theme/LayoutProviders/index.tsx +8 -5
- package/src/theme/Logo/index.tsx +21 -17
- package/src/theme/MDXComponents/index.tsx +39 -5
- package/src/theme/MDXComponents/styles.css +11 -0
- package/src/theme/MDXPage/index.tsx +10 -2
- package/src/theme/Navbar/index.tsx +62 -35
- package/src/theme/Navbar/styles.module.css +3 -39
- package/src/theme/NavbarItem/DefaultNavbarItem.tsx +42 -149
- package/src/theme/NavbarItem/DocNavbarItem.tsx +12 -16
- package/src/theme/NavbarItem/DocsVersionDropdownNavbarItem.tsx +33 -21
- package/src/theme/NavbarItem/DocsVersionNavbarItem.tsx +7 -3
- package/src/theme/NavbarItem/DropdownNavbarItem.tsx +181 -0
- package/src/theme/NavbarItem/{LocaleDropdownNavbarItem.tsx → LocaleDropdownNavbarItem/index.tsx} +8 -9
- package/src/theme/NavbarItem/LocaleDropdownNavbarItem/styles.module.css +11 -0
- package/src/theme/NavbarItem/index.tsx +41 -16
- package/src/theme/{SearchMetadatas → SearchMetadata}/index.tsx +2 -2
- package/src/theme/Seo/index.tsx +7 -4
- package/src/theme/TOC/index.tsx +13 -35
- package/src/theme/TOC/styles.module.css +1 -1
- package/src/theme/TOCCollapsible/index.tsx +13 -4
- package/src/theme/TOCCollapsible/styles.module.css +1 -0
- package/src/theme/TOCInline/index.tsx +13 -32
- package/src/theme/TOCItems/index.tsx +96 -0
- package/src/theme/Tabs/__tests__/index.test.tsx +129 -0
- package/src/theme/Tabs/index.tsx +93 -49
- package/src/theme/Tabs/styles.module.css +0 -13
- package/src/theme/Tag/index.tsx +31 -0
- package/src/theme/Tag/styles.module.css +70 -0
- package/src/theme/TagsListByLetter/index.tsx +45 -0
- package/src/theme/TagsListByLetter/styles.module.css +11 -0
- package/src/theme/TagsListInline/index.tsx +35 -0
- package/src/theme/TagsListInline/styles.module.css +15 -0
- package/src/theme/ThemeProvider/index.tsx +6 -2
- package/src/theme/ThemedImage/index.tsx +5 -5
- package/src/theme/Toggle/index.tsx +36 -43
- package/src/theme/Toggle/styles.module.css +91 -3
- package/src/theme/UserPreferencesProvider/index.tsx +9 -6
- package/src/theme/hooks/useHideableNavbar.ts +32 -45
- package/src/theme/hooks/useTabGroupChoice.ts +2 -2
- package/src/theme/hooks/useTheme.ts +4 -5
- package/src/theme/hooks/useWindowSize.ts +2 -7
- package/src/theme/prism-include-languages.ts +3 -2
- package/src/theme-classic.d.ts +806 -0
- package/src/translations.ts +8 -10
- package/src/types.d.ts +0 -629
- package/src/{validateThemeConfig.js → validateThemeConfig.ts} +151 -96
- package/tsconfig.json +1 -2
- package/codeTranslations/README.md +0 -20
- package/codeTranslations/ar.json +0 -56
- package/codeTranslations/base.json +0 -110
- package/codeTranslations/bn.json +0 -56
- package/codeTranslations/da.json +0 -56
- package/codeTranslations/de.json +0 -56
- package/codeTranslations/es.json +0 -56
- package/codeTranslations/fa.json +0 -56
- package/codeTranslations/fil.json +0 -56
- package/codeTranslations/fr.json +0 -56
- package/codeTranslations/he.json +0 -56
- package/codeTranslations/hi.json +0 -56
- package/codeTranslations/ja.json +0 -56
- package/codeTranslations/ko.json +0 -56
- package/codeTranslations/pl.json +0 -56
- package/codeTranslations/pt-BR.json +0 -56
- package/codeTranslations/pt-PT.json +0 -56
- package/codeTranslations/ru.json +0 -56
- package/codeTranslations/tr.json +0 -56
- package/codeTranslations/vi.json +0 -56
- package/codeTranslations/zh-Hans.json +0 -56
- package/codeTranslations/zh-Hant.json +0 -56
- package/lib/theme/Toggle/styles.css +0 -103
- package/lib/theme/hooks/useContextualSearchFilters.js +0 -47
- package/lib/theme/hooks/useScrollPosition.js +0 -49
- package/lib/theme/hooks/useTOCHighlight.js +0 -87
- package/lib-next/theme/Toggle/styles.css +0 -103
- package/lib-next/theme/hooks/useContextualSearchFilters.js +0 -41
- package/lib-next/theme/hooks/useScrollPosition.js +0 -38
- package/lib-next/theme/hooks/useTOCHighlight.js +0 -84
- package/src/theme/Toggle/styles.css +0 -103
- package/src/theme/hooks/useContextualSearchFilters.ts +0 -52
- package/src/theme/hooks/useScrollPosition.ts +0 -45
- package/src/theme/hooks/useTOCHighlight.ts +0 -98
- package/update-code-translations.js +0 -242
- package/update-code-translations.test.js +0 -33
|
@@ -13,8 +13,6 @@ var _themeCommon = require("@docusaurus/theme-common");
|
|
|
13
13
|
|
|
14
14
|
var _useWindowSize = _interopRequireDefault(require("@theme/hooks/useWindowSize"));
|
|
15
15
|
|
|
16
|
-
var _useScrollPosition = _interopRequireDefault(require("@theme/hooks/useScrollPosition"));
|
|
17
|
-
|
|
18
16
|
var _Logo = _interopRequireDefault(require("@theme/Logo"));
|
|
19
17
|
|
|
20
18
|
var _IconArrow = _interopRequireDefault(require("@theme/IconArrow"));
|
|
@@ -39,17 +37,17 @@ function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj &&
|
|
|
39
37
|
*/
|
|
40
38
|
function useShowAnnouncementBar() {
|
|
41
39
|
const {
|
|
42
|
-
|
|
40
|
+
isActive
|
|
43
41
|
} = (0, _themeCommon.useAnnouncementBar)();
|
|
44
|
-
const [showAnnouncementBar, setShowAnnouncementBar] = (0, _react.useState)(
|
|
45
|
-
(0,
|
|
42
|
+
const [showAnnouncementBar, setShowAnnouncementBar] = (0, _react.useState)(isActive);
|
|
43
|
+
(0, _themeCommon.useScrollPosition)(({
|
|
46
44
|
scrollY
|
|
47
45
|
}) => {
|
|
48
|
-
if (
|
|
46
|
+
if (isActive) {
|
|
49
47
|
setShowAnnouncementBar(scrollY === 0);
|
|
50
48
|
}
|
|
51
|
-
});
|
|
52
|
-
return showAnnouncementBar;
|
|
49
|
+
}, [isActive]);
|
|
50
|
+
return isActive && showAnnouncementBar;
|
|
53
51
|
}
|
|
54
52
|
|
|
55
53
|
function HideableSidebarButton({
|
|
@@ -71,7 +69,6 @@ function HideableSidebarButton({
|
|
|
71
69
|
function DocSidebarDesktop({
|
|
72
70
|
path,
|
|
73
71
|
sidebar,
|
|
74
|
-
sidebarCollapsible,
|
|
75
72
|
onCollapse,
|
|
76
73
|
isHidden
|
|
77
74
|
}) {
|
|
@@ -82,35 +79,39 @@ function DocSidebarDesktop({
|
|
|
82
79
|
},
|
|
83
80
|
hideableSidebar
|
|
84
81
|
} = (0, _themeCommon.useThemeConfig)();
|
|
85
|
-
const {
|
|
86
|
-
isClosed: isAnnouncementBarClosed
|
|
87
|
-
} = (0, _themeCommon.useAnnouncementBar)();
|
|
88
82
|
return <div className={(0, _clsx.default)(_stylesModule.default.sidebar, {
|
|
89
83
|
[_stylesModule.default.sidebarWithHideableNavbar]: hideOnScroll,
|
|
90
84
|
[_stylesModule.default.sidebarHidden]: isHidden
|
|
91
85
|
})}>
|
|
92
86
|
{hideOnScroll && <_Logo.default tabIndex={-1} className={_stylesModule.default.sidebarLogo} />}
|
|
93
87
|
<nav className={(0, _clsx.default)('menu thin-scrollbar', _stylesModule.default.menu, {
|
|
94
|
-
[_stylesModule.default.menuWithAnnouncementBar]:
|
|
88
|
+
[_stylesModule.default.menuWithAnnouncementBar]: showAnnouncementBar
|
|
95
89
|
})}>
|
|
96
|
-
<ul className=
|
|
97
|
-
<_DocSidebarItem.DocSidebarItems items={sidebar}
|
|
90
|
+
<ul className={(0, _clsx.default)(_themeCommon.ThemeClassNames.docs.docSidebarMenu, 'menu__list')}>
|
|
91
|
+
<_DocSidebarItem.DocSidebarItems items={sidebar} activePath={path} level={1} />
|
|
98
92
|
</ul>
|
|
99
93
|
</nav>
|
|
100
94
|
{hideableSidebar && <HideableSidebarButton onClick={onCollapse} />}
|
|
101
95
|
</div>;
|
|
102
|
-
}
|
|
96
|
+
} // eslint-disable-next-line react/function-component-definition
|
|
97
|
+
|
|
103
98
|
|
|
104
99
|
const DocSidebarMobileSecondaryMenu = ({
|
|
105
100
|
toggleSidebar,
|
|
106
101
|
sidebar,
|
|
107
|
-
sidebarCollapsible,
|
|
108
102
|
path
|
|
109
|
-
}) => {
|
|
110
|
-
|
|
111
|
-
|
|
112
|
-
|
|
113
|
-
|
|
103
|
+
}) => <ul className={(0, _clsx.default)(_themeCommon.ThemeClassNames.docs.docSidebarMenu, 'menu__list')}>
|
|
104
|
+
<_DocSidebarItem.DocSidebarItems items={sidebar} activePath={path} onItemClick={item => {
|
|
105
|
+
// Mobile sidebar should only be closed if the category has a link
|
|
106
|
+
if (item.type === 'category' && item.href) {
|
|
107
|
+
toggleSidebar();
|
|
108
|
+
}
|
|
109
|
+
|
|
110
|
+
if (item.type === 'link') {
|
|
111
|
+
toggleSidebar();
|
|
112
|
+
}
|
|
113
|
+
}} level={1} />
|
|
114
|
+
</ul>;
|
|
114
115
|
|
|
115
116
|
function DocSidebarMobile(props) {
|
|
116
117
|
return <_themeCommon.MobileSecondaryMenuFiller component={DocSidebarMobileSecondaryMenu} props={props} />;
|
|
@@ -3,8 +3,8 @@
|
|
|
3
3
|
Object.defineProperty(exports, "__esModule", {
|
|
4
4
|
value: true
|
|
5
5
|
});
|
|
6
|
-
exports.default = DocSidebarItem;
|
|
7
6
|
exports.DocSidebarItems = void 0;
|
|
7
|
+
exports.default = DocSidebarItem;
|
|
8
8
|
|
|
9
9
|
var _react = _interopRequireWildcard(require("react"));
|
|
10
10
|
|
|
@@ -16,10 +16,14 @@ var _Link = _interopRequireDefault(require("@docusaurus/Link"));
|
|
|
16
16
|
|
|
17
17
|
var _isInternalUrl = _interopRequireDefault(require("@docusaurus/isInternalUrl"));
|
|
18
18
|
|
|
19
|
+
var _Translate = require("@docusaurus/Translate");
|
|
20
|
+
|
|
19
21
|
var _IconExternalLink = _interopRequireDefault(require("@theme/IconExternalLink"));
|
|
20
22
|
|
|
21
23
|
var _stylesModule = _interopRequireDefault(require("./styles.module.css"));
|
|
22
24
|
|
|
25
|
+
var _useIsBrowser = _interopRequireDefault(require("@docusaurus/useIsBrowser"));
|
|
26
|
+
|
|
23
27
|
function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
|
|
24
28
|
|
|
25
29
|
function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "function") return null; var cacheBabelInterop = new WeakMap(); var cacheNodeInterop = new WeakMap(); return (_getRequireWildcardCache = function (nodeInterop) { return nodeInterop ? cacheNodeInterop : cacheBabelInterop; })(nodeInterop); }
|
|
@@ -32,30 +36,16 @@ function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj &&
|
|
|
32
36
|
* This source code is licensed under the MIT license found in the
|
|
33
37
|
* LICENSE file in the root directory of this source tree.
|
|
34
38
|
*/
|
|
35
|
-
|
|
36
|
-
if (item.type === 'link') {
|
|
37
|
-
return (0, _themeCommon.isSamePath)(item.href, activePath);
|
|
38
|
-
}
|
|
39
|
-
|
|
40
|
-
if (item.type === 'category') {
|
|
41
|
-
return item.items.some(subItem => isActiveSidebarItem(subItem, activePath));
|
|
42
|
-
}
|
|
43
|
-
|
|
44
|
-
return false;
|
|
45
|
-
}; // Optimize sidebar at each "level"
|
|
39
|
+
// Optimize sidebar at each "level"
|
|
46
40
|
// TODO this item should probably not receive the "activePath" props
|
|
47
41
|
// TODO this triggers whole sidebar re-renders on navigation
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
const DocSidebarItems = (0, _react.memo)(function DocSidebarItems({
|
|
42
|
+
const DocSidebarItems = (0, _react.memo)(({
|
|
51
43
|
items,
|
|
52
44
|
...props
|
|
53
|
-
})
|
|
54
|
-
return <>
|
|
45
|
+
}) => <>
|
|
55
46
|
{items.map((item, index) => <DocSidebarItem key={index} // sidebar is static, the index does not change
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
});
|
|
47
|
+
item={item} {...props} />)}
|
|
48
|
+
</>);
|
|
59
49
|
exports.DocSidebarItems = DocSidebarItems;
|
|
60
50
|
|
|
61
51
|
function DocSidebarItem({
|
|
@@ -89,21 +79,47 @@ function useAutoExpandActiveCategory({
|
|
|
89
79
|
if (justBecameActive && collapsed) {
|
|
90
80
|
setCollapsed(false);
|
|
91
81
|
}
|
|
92
|
-
}, [isActive, wasActive, collapsed]);
|
|
82
|
+
}, [isActive, wasActive, collapsed, setCollapsed]);
|
|
83
|
+
} // When a collapsible category has no link, we still link it to its first child during SSR as a temporary fallback
|
|
84
|
+
// This allows to be able to navigate inside the category even when JS fails to load, is delayed or simply disabled
|
|
85
|
+
// React hydration becomes an optional progressive enhancement
|
|
86
|
+
// see https://github.com/facebookincubator/infima/issues/36#issuecomment-772543188
|
|
87
|
+
// see https://github.com/facebook/docusaurus/issues/3030
|
|
88
|
+
|
|
89
|
+
|
|
90
|
+
function useCategoryHrefWithSSRFallback(item) {
|
|
91
|
+
const isBrowser = (0, _useIsBrowser.default)();
|
|
92
|
+
return (0, _react.useMemo)(() => {
|
|
93
|
+
if (item.href) {
|
|
94
|
+
return item.href;
|
|
95
|
+
} // In these cases, it's not necessary to render a fallback
|
|
96
|
+
// We skip the "findFirstCategoryLink" computation
|
|
97
|
+
|
|
98
|
+
|
|
99
|
+
if (isBrowser || !item.collapsible) {
|
|
100
|
+
return undefined;
|
|
101
|
+
}
|
|
102
|
+
|
|
103
|
+
return (0, _themeCommon.findFirstCategoryLink)(item);
|
|
104
|
+
}, [item, isBrowser]);
|
|
93
105
|
}
|
|
94
106
|
|
|
95
107
|
function DocSidebarItemCategory({
|
|
96
108
|
item,
|
|
97
109
|
onItemClick,
|
|
98
|
-
collapsible = true,
|
|
99
110
|
activePath,
|
|
111
|
+
level,
|
|
100
112
|
...props
|
|
101
113
|
}) {
|
|
102
114
|
const {
|
|
103
115
|
items,
|
|
104
|
-
label
|
|
116
|
+
label,
|
|
117
|
+
collapsible,
|
|
118
|
+
className,
|
|
119
|
+
href
|
|
105
120
|
} = item;
|
|
106
|
-
const
|
|
121
|
+
const hrefWithSSRFallback = useCategoryHrefWithSSRFallback(item);
|
|
122
|
+
const isActive = (0, _themeCommon.isActiveSidebarItem)(item, activePath);
|
|
107
123
|
const {
|
|
108
124
|
collapsed,
|
|
109
125
|
setCollapsed,
|
|
@@ -112,13 +128,11 @@ function DocSidebarItemCategory({
|
|
|
112
128
|
// active categories are always initialized as expanded
|
|
113
129
|
// the default (item.collapsed) is only used for non-active categories
|
|
114
130
|
initialState: () => {
|
|
115
|
-
var _item$collapsed;
|
|
116
|
-
|
|
117
131
|
if (!collapsible) {
|
|
118
132
|
return false;
|
|
119
133
|
}
|
|
120
134
|
|
|
121
|
-
return isActive ? false :
|
|
135
|
+
return isActive ? false : item.collapsed;
|
|
122
136
|
}
|
|
123
137
|
});
|
|
124
138
|
useAutoExpandActiveCategory({
|
|
@@ -126,22 +140,43 @@ function DocSidebarItemCategory({
|
|
|
126
140
|
collapsed,
|
|
127
141
|
setCollapsed
|
|
128
142
|
});
|
|
129
|
-
return <li className={(0, _clsx.default)('menu__list-item', {
|
|
143
|
+
return <li className={(0, _clsx.default)(_themeCommon.ThemeClassNames.docs.docSidebarItemCategory, _themeCommon.ThemeClassNames.docs.docSidebarItemCategoryLevel(level), 'menu__list-item', {
|
|
130
144
|
'menu__list-item--collapsed': collapsed
|
|
131
|
-
})}>
|
|
132
|
-
|
|
133
|
-
|
|
134
|
-
|
|
135
|
-
|
|
136
|
-
|
|
137
|
-
|
|
138
|
-
|
|
139
|
-
|
|
140
|
-
|
|
141
|
-
|
|
142
|
-
|
|
143
|
-
|
|
144
|
-
|
|
145
|
+
}, className)}>
|
|
146
|
+
<div className="menu__list-item-collapsible">
|
|
147
|
+
<_Link.default className={(0, _clsx.default)('menu__link', {
|
|
148
|
+
'menu__link--sublist': collapsible && !href,
|
|
149
|
+
'menu__link--active': isActive,
|
|
150
|
+
[_stylesModule.default.menuLinkText]: !collapsible,
|
|
151
|
+
[_stylesModule.default.hasHref]: !!hrefWithSSRFallback
|
|
152
|
+
})} onClick={collapsible ? e => {
|
|
153
|
+
onItemClick === null || onItemClick === void 0 ? void 0 : onItemClick(item);
|
|
154
|
+
|
|
155
|
+
if (href) {
|
|
156
|
+
setCollapsed(false);
|
|
157
|
+
} else {
|
|
158
|
+
e.preventDefault();
|
|
159
|
+
toggleCollapsed();
|
|
160
|
+
}
|
|
161
|
+
} : () => {
|
|
162
|
+
onItemClick === null || onItemClick === void 0 ? void 0 : onItemClick(item);
|
|
163
|
+
}} href={collapsible ? hrefWithSSRFallback !== null && hrefWithSSRFallback !== void 0 ? hrefWithSSRFallback : '#' : hrefWithSSRFallback} {...props}>
|
|
164
|
+
{label}
|
|
165
|
+
</_Link.default>
|
|
166
|
+
{href && collapsible && <button aria-label={(0, _Translate.translate)({
|
|
167
|
+
id: 'theme.DocSidebarItem.toggleCollapsedCategoryAriaLabel',
|
|
168
|
+
message: "Toggle the collapsible sidebar category '{label}'",
|
|
169
|
+
description: 'The ARIA label to toggle the collapsible sidebar category'
|
|
170
|
+
}, {
|
|
171
|
+
label
|
|
172
|
+
})} type="button" className="clean-btn menu__caret" onClick={e => {
|
|
173
|
+
e.preventDefault();
|
|
174
|
+
toggleCollapsed();
|
|
175
|
+
}} />}
|
|
176
|
+
</div>
|
|
177
|
+
|
|
178
|
+
<_themeCommon.Collapsible lazy as="ul" className="menu__list" collapsed={collapsed}>
|
|
179
|
+
<DocSidebarItems items={items} tabIndex={collapsed ? -1 : 0} onItemClick={onItemClick} activePath={activePath} level={level + 1} />
|
|
145
180
|
</_themeCommon.Collapsible>
|
|
146
181
|
</li>;
|
|
147
182
|
}
|
|
@@ -150,21 +185,20 @@ function DocSidebarItemLink({
|
|
|
150
185
|
item,
|
|
151
186
|
onItemClick,
|
|
152
187
|
activePath,
|
|
153
|
-
|
|
188
|
+
level,
|
|
154
189
|
...props
|
|
155
190
|
}) {
|
|
156
191
|
const {
|
|
157
192
|
href,
|
|
158
|
-
label
|
|
193
|
+
label,
|
|
194
|
+
className
|
|
159
195
|
} = item;
|
|
160
|
-
const isActive = isActiveSidebarItem(item, activePath);
|
|
161
|
-
return <li className=
|
|
196
|
+
const isActive = (0, _themeCommon.isActiveSidebarItem)(item, activePath);
|
|
197
|
+
return <li className={(0, _clsx.default)(_themeCommon.ThemeClassNames.docs.docSidebarItemLink, _themeCommon.ThemeClassNames.docs.docSidebarItemLinkLevel(level), 'menu__list-item', className)} key={label}>
|
|
162
198
|
<_Link.default className={(0, _clsx.default)('menu__link', {
|
|
163
199
|
'menu__link--active': isActive
|
|
164
|
-
})} to={href} {...(0, _isInternalUrl.default)(href) && {
|
|
165
|
-
|
|
166
|
-
exact: true,
|
|
167
|
-
onClick: onItemClick
|
|
200
|
+
})} aria-current={isActive ? 'page' : undefined} to={href} {...(0, _isInternalUrl.default)(href) && {
|
|
201
|
+
onClick: onItemClick ? () => onItemClick(item) : undefined
|
|
168
202
|
}} {...props}>
|
|
169
203
|
{(0, _isInternalUrl.default)(href) ? label : <span>
|
|
170
204
|
{label}
|
|
@@ -0,0 +1,89 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
|
|
3
|
+
Object.defineProperty(exports, "__esModule", {
|
|
4
|
+
value: true
|
|
5
|
+
});
|
|
6
|
+
exports.default = DocTagDocListPage;
|
|
7
|
+
|
|
8
|
+
var _react = _interopRequireDefault(require("react"));
|
|
9
|
+
|
|
10
|
+
var _Layout = _interopRequireDefault(require("@theme/Layout"));
|
|
11
|
+
|
|
12
|
+
var _Link = _interopRequireDefault(require("@docusaurus/Link"));
|
|
13
|
+
|
|
14
|
+
var _themeCommon = require("@docusaurus/theme-common");
|
|
15
|
+
|
|
16
|
+
var _Translate = _interopRequireWildcard(require("@docusaurus/Translate"));
|
|
17
|
+
|
|
18
|
+
function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "function") return null; var cacheBabelInterop = new WeakMap(); var cacheNodeInterop = new WeakMap(); return (_getRequireWildcardCache = function (nodeInterop) { return nodeInterop ? cacheNodeInterop : cacheBabelInterop; })(nodeInterop); }
|
|
19
|
+
|
|
20
|
+
function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj && obj.__esModule) { return obj; } if (obj === null || typeof obj !== "object" && typeof obj !== "function") { return { default: obj }; } var cache = _getRequireWildcardCache(nodeInterop); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (key !== "default" && Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj.default = obj; if (cache) { cache.set(obj, newObj); } return newObj; }
|
|
21
|
+
|
|
22
|
+
function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
|
|
23
|
+
|
|
24
|
+
/**
|
|
25
|
+
* Copyright (c) Facebook, Inc. and its affiliates.
|
|
26
|
+
*
|
|
27
|
+
* This source code is licensed under the MIT license found in the
|
|
28
|
+
* LICENSE file in the root directory of this source tree.
|
|
29
|
+
*/
|
|
30
|
+
// Very simple pluralization: probably good enough for now
|
|
31
|
+
function useNDocsTaggedPlural() {
|
|
32
|
+
const {
|
|
33
|
+
selectMessage
|
|
34
|
+
} = (0, _themeCommon.usePluralForm)();
|
|
35
|
+
return count => selectMessage(count, (0, _Translate.translate)({
|
|
36
|
+
id: 'theme.docs.tagDocListPageTitle.nDocsTagged',
|
|
37
|
+
description: 'Pluralized label for "{count} docs tagged". Use as much plural forms (separated by "|") as your language support (see https://www.unicode.org/cldr/cldr-aux/charts/34/supplemental/language_plural_rules.html)',
|
|
38
|
+
message: 'One doc tagged|{count} docs tagged'
|
|
39
|
+
}, {
|
|
40
|
+
count
|
|
41
|
+
}));
|
|
42
|
+
}
|
|
43
|
+
|
|
44
|
+
function DocItem({
|
|
45
|
+
doc
|
|
46
|
+
}) {
|
|
47
|
+
return <article className="margin-vert--lg">
|
|
48
|
+
<_Link.default to={doc.permalink}>
|
|
49
|
+
<h2>{doc.title}</h2>
|
|
50
|
+
</_Link.default>
|
|
51
|
+
{doc.description && <p>{doc.description}</p>}
|
|
52
|
+
</article>;
|
|
53
|
+
}
|
|
54
|
+
|
|
55
|
+
function DocTagDocListPage({
|
|
56
|
+
tag
|
|
57
|
+
}) {
|
|
58
|
+
const nDocsTaggedPlural = useNDocsTaggedPlural();
|
|
59
|
+
const title = (0, _Translate.translate)({
|
|
60
|
+
id: 'theme.docs.tagDocListPageTitle',
|
|
61
|
+
description: 'The title of the page for a docs tag',
|
|
62
|
+
message: '{nDocsTagged} with "{tagName}"'
|
|
63
|
+
}, {
|
|
64
|
+
nDocsTagged: nDocsTaggedPlural(tag.docs.length),
|
|
65
|
+
tagName: tag.name
|
|
66
|
+
});
|
|
67
|
+
return <_Layout.default title={title} wrapperClassName={_themeCommon.ThemeClassNames.wrapper.docsPages} pageClassName={_themeCommon.ThemeClassNames.page.docsTagDocListPage} searchMetadata={{
|
|
68
|
+
// assign unique search tag to exclude this page from search results!
|
|
69
|
+
tag: 'doc_tag_doc_list'
|
|
70
|
+
}}>
|
|
71
|
+
<div className="container margin-vert--lg">
|
|
72
|
+
<div className="row">
|
|
73
|
+
<main className="col col--8 col--offset-2">
|
|
74
|
+
<header className="margin-bottom--xl">
|
|
75
|
+
<h1>{title}</h1>
|
|
76
|
+
<_Link.default href={tag.allTagsPath}>
|
|
77
|
+
<_Translate.default id="theme.tags.tagsPageLink" description="The label of the link targeting the tag list page">
|
|
78
|
+
View All Tags
|
|
79
|
+
</_Translate.default>
|
|
80
|
+
</_Link.default>
|
|
81
|
+
</header>
|
|
82
|
+
<section className="margin-vert--lg">
|
|
83
|
+
{tag.docs.map(doc => <DocItem key={doc.id} doc={doc} />)}
|
|
84
|
+
</section>
|
|
85
|
+
</main>
|
|
86
|
+
</div>
|
|
87
|
+
</div>
|
|
88
|
+
</_Layout.default>;
|
|
89
|
+
}
|
|
@@ -0,0 +1,44 @@
|
|
|
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 _Layout = _interopRequireDefault(require("@theme/Layout"));
|
|
11
|
+
|
|
12
|
+
var _themeCommon = require("@docusaurus/theme-common");
|
|
13
|
+
|
|
14
|
+
var _TagsListByLetter = _interopRequireDefault(require("@theme/TagsListByLetter"));
|
|
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 DocTagsListPage({
|
|
25
|
+
tags
|
|
26
|
+
}) {
|
|
27
|
+
const title = (0, _themeCommon.translateTagsPageTitle)();
|
|
28
|
+
return <_Layout.default title={title} wrapperClassName={_themeCommon.ThemeClassNames.wrapper.docsPages} pageClassName={_themeCommon.ThemeClassNames.page.docsTagsListPage} searchMetadata={{
|
|
29
|
+
// assign unique search tag to exclude this page from search results!
|
|
30
|
+
tag: 'doc_tags_list'
|
|
31
|
+
}}>
|
|
32
|
+
<div className="container margin-vert--lg">
|
|
33
|
+
<div className="row">
|
|
34
|
+
<main className="col col--8 col--offset-2">
|
|
35
|
+
<h1>{title}</h1>
|
|
36
|
+
<_TagsListByLetter.default tags={tags} />
|
|
37
|
+
</main>
|
|
38
|
+
</div>
|
|
39
|
+
</div>
|
|
40
|
+
</_Layout.default>;
|
|
41
|
+
}
|
|
42
|
+
|
|
43
|
+
var _default = DocTagsListPage;
|
|
44
|
+
exports.default = _default;
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
|
|
3
|
+
Object.defineProperty(exports, "__esModule", {
|
|
4
|
+
value: true
|
|
5
|
+
});
|
|
6
|
+
exports.default = DocVersionBadge;
|
|
7
|
+
|
|
8
|
+
var _react = _interopRequireDefault(require("react"));
|
|
9
|
+
|
|
10
|
+
var _themeCommon = require("@docusaurus/theme-common");
|
|
11
|
+
|
|
12
|
+
var _clsx = _interopRequireDefault(require("clsx"));
|
|
13
|
+
|
|
14
|
+
function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
|
|
15
|
+
|
|
16
|
+
/**
|
|
17
|
+
* Copyright (c) Facebook, Inc. and its affiliates.
|
|
18
|
+
*
|
|
19
|
+
* This source code is licensed under the MIT license found in the
|
|
20
|
+
* LICENSE file in the root directory of this source tree.
|
|
21
|
+
*/
|
|
22
|
+
function DocVersionBadge({
|
|
23
|
+
className
|
|
24
|
+
}) {
|
|
25
|
+
const versionMetadata = (0, _themeCommon.useDocsVersion)();
|
|
26
|
+
|
|
27
|
+
if (versionMetadata.badge) {
|
|
28
|
+
return <span className={(0, _clsx.default)(className, _themeCommon.ThemeClassNames.docs.docVersionBadge, 'badge badge--secondary')}>
|
|
29
|
+
Version: {versionMetadata.label}
|
|
30
|
+
</span>;
|
|
31
|
+
}
|
|
32
|
+
|
|
33
|
+
return null;
|
|
34
|
+
}
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
Object.defineProperty(exports, "__esModule", {
|
|
4
4
|
value: true
|
|
5
5
|
});
|
|
6
|
-
exports.default =
|
|
6
|
+
exports.default = DocVersionBanner;
|
|
7
7
|
|
|
8
8
|
var _react = _interopRequireDefault(require("react"));
|
|
9
9
|
|
|
@@ -17,6 +17,8 @@ var _useDocs = require("@theme/hooks/useDocs");
|
|
|
17
17
|
|
|
18
18
|
var _themeCommon = require("@docusaurus/theme-common");
|
|
19
19
|
|
|
20
|
+
var _clsx = _interopRequireDefault(require("clsx"));
|
|
21
|
+
|
|
20
22
|
function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
|
|
21
23
|
|
|
22
24
|
/**
|
|
@@ -79,6 +81,7 @@ function LatestVersionSuggestionLabel({
|
|
|
79
81
|
}
|
|
80
82
|
|
|
81
83
|
function DocVersionBannerEnabled({
|
|
84
|
+
className,
|
|
82
85
|
versionMetadata
|
|
83
86
|
}) {
|
|
84
87
|
const {
|
|
@@ -104,7 +107,7 @@ function DocVersionBannerEnabled({
|
|
|
104
107
|
// fallback to main doc of latest version
|
|
105
108
|
|
|
106
109
|
const latestVersionSuggestedDoc = latestDocSuggestion !== null && latestDocSuggestion !== void 0 ? latestDocSuggestion : getVersionMainDoc(latestVersionSuggestion);
|
|
107
|
-
return <div className=
|
|
110
|
+
return <div className={(0, _clsx.default)(className, _themeCommon.ThemeClassNames.docs.docVersionBanner, 'alert alert--warning margin-bottom--md')} role="alert">
|
|
108
111
|
<div>
|
|
109
112
|
<BannerLabel siteTitle={siteTitle} versionMetadata={versionMetadata} />
|
|
110
113
|
</div>
|
|
@@ -115,14 +118,13 @@ function DocVersionBannerEnabled({
|
|
|
115
118
|
}
|
|
116
119
|
|
|
117
120
|
function DocVersionBanner({
|
|
118
|
-
|
|
121
|
+
className
|
|
119
122
|
}) {
|
|
120
|
-
|
|
121
|
-
|
|
122
|
-
|
|
123
|
-
return <DocVersionBannerEnabled versionMetadata={versionMetadata} />;
|
|
123
|
+
const versionMetadata = (0, _themeCommon.useDocsVersion)();
|
|
124
|
+
|
|
125
|
+
if (versionMetadata.banner) {
|
|
126
|
+
return <DocVersionBannerEnabled className={className} versionMetadata={versionMetadata} />;
|
|
124
127
|
}
|
|
125
|
-
}
|
|
126
128
|
|
|
127
|
-
|
|
128
|
-
|
|
129
|
+
return null;
|
|
130
|
+
}
|
|
@@ -11,6 +11,8 @@ var _Translate = _interopRequireDefault(require("@docusaurus/Translate"));
|
|
|
11
11
|
|
|
12
12
|
var _IconEdit = _interopRequireDefault(require("@theme/IconEdit"));
|
|
13
13
|
|
|
14
|
+
var _themeCommon = require("@docusaurus/theme-common");
|
|
15
|
+
|
|
14
16
|
function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
|
|
15
17
|
|
|
16
18
|
/**
|
|
@@ -22,7 +24,7 @@ function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { de
|
|
|
22
24
|
function EditThisPage({
|
|
23
25
|
editUrl
|
|
24
26
|
}) {
|
|
25
|
-
return <a href={editUrl} target="_blank" rel="noreferrer noopener">
|
|
27
|
+
return <a href={editUrl} target="_blank" rel="noreferrer noopener" className={_themeCommon.ThemeClassNames.common.editThisPage}>
|
|
26
28
|
<_IconEdit.default />
|
|
27
29
|
<_Translate.default id="theme.common.editThisPage" description="The link label to edit the current page">
|
|
28
30
|
Edit this page
|
|
@@ -0,0 +1,43 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
|
|
3
|
+
Object.defineProperty(exports, "__esModule", {
|
|
4
|
+
value: true
|
|
5
|
+
});
|
|
6
|
+
exports.default = ErrorPageContent;
|
|
7
|
+
|
|
8
|
+
var _react = _interopRequireDefault(require("react"));
|
|
9
|
+
|
|
10
|
+
var _Translate = _interopRequireDefault(require("@docusaurus/Translate"));
|
|
11
|
+
|
|
12
|
+
function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
|
|
13
|
+
|
|
14
|
+
/**
|
|
15
|
+
* Copyright (c) Facebook, Inc. and its affiliates.
|
|
16
|
+
*
|
|
17
|
+
* This source code is licensed under the MIT license found in the
|
|
18
|
+
* LICENSE file in the root directory of this source tree.
|
|
19
|
+
*/
|
|
20
|
+
function ErrorPageContent({
|
|
21
|
+
error,
|
|
22
|
+
tryAgain
|
|
23
|
+
}) {
|
|
24
|
+
return <main className="container margin-vert--xl">
|
|
25
|
+
<div className="row">
|
|
26
|
+
<div className="col col--6 col--offset-3">
|
|
27
|
+
<h1 className="hero__title">
|
|
28
|
+
<_Translate.default id="theme.ErrorPageContent.title" description="The title of the fallback page when the page crashed">
|
|
29
|
+
This page crashed.
|
|
30
|
+
</_Translate.default>
|
|
31
|
+
</h1>
|
|
32
|
+
<p>{error.message}</p>
|
|
33
|
+
<div>
|
|
34
|
+
<button type="button" onClick={tryAgain}>
|
|
35
|
+
<_Translate.default id="theme.ErrorPageContent.tryAgain" description="The label of the button to try again when the page crashed">
|
|
36
|
+
Try again
|
|
37
|
+
</_Translate.default>
|
|
38
|
+
</button>
|
|
39
|
+
</div>
|
|
40
|
+
</div>
|
|
41
|
+
</div>
|
|
42
|
+
</main>;
|
|
43
|
+
}
|
|
@@ -54,10 +54,14 @@ function FooterLink({
|
|
|
54
54
|
</_Link.default>;
|
|
55
55
|
}
|
|
56
56
|
|
|
57
|
-
|
|
57
|
+
function FooterLogo({
|
|
58
58
|
sources,
|
|
59
|
-
alt
|
|
60
|
-
|
|
59
|
+
alt,
|
|
60
|
+
width,
|
|
61
|
+
height
|
|
62
|
+
}) {
|
|
63
|
+
return <_ThemedImage.default className="footer__logo" alt={alt} sources={sources} width={width} height={height} />;
|
|
64
|
+
}
|
|
61
65
|
|
|
62
66
|
function Footer() {
|
|
63
67
|
const {
|
|
@@ -98,7 +102,7 @@ function Footer() {
|
|
|
98
102
|
{(logo || copyright) && <div className="footer__bottom text--center">
|
|
99
103
|
{logo && (logo.src || logo.srcDark) && <div className="margin-bottom--sm">
|
|
100
104
|
{logo.href ? <_Link.default href={logo.href} className={_stylesModule.default.footerLogoLink}>
|
|
101
|
-
<FooterLogo alt={logo.alt} sources={sources} />
|
|
105
|
+
<FooterLogo alt={logo.alt} sources={sources} width={logo.width} height={logo.height} />
|
|
102
106
|
</_Link.default> : <FooterLogo alt={logo.alt} sources={sources} />}
|
|
103
107
|
</div>}
|
|
104
108
|
{copyright ? <div className="footer__copyright" // Developer provided the HTML, so assume it's safe.
|