@docusaurus/theme-classic 2.0.0-beta.12faed89d → 2.0.0-beta.14
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/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-next/types.d.ts → lib/theme-classic.d.ts} +338 -156
- package/lib/translations.js +16 -7
- package/lib/types.d.ts +0 -629
- package/lib/validateThemeConfig.js +232 -248
- package/lib-next/theme/Admonition/index.js +101 -0
- 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/theme/MDXPage → lib-next/theme/BlogPostAuthor}/styles.module.css +4 -2
- package/lib-next/theme/BlogPostAuthors/index.js +34 -0
- package/{lib/theme/IconExternalLink → lib-next/theme/BlogPostAuthors}/styles.module.css +3 -4
- 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 +23 -149
- package/lib-next/theme/CodeBlock/styles.module.css +12 -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/theme/DocSidebarItem → lib-next/theme/DocItemFooter}/styles.module.css +8 -5
- package/lib-next/theme/DocPage/index.js +46 -23
- package/lib-next/theme/DocPaginator/index.js +5 -33
- package/lib-next/theme/DocPaginatorNavLink/index.js +36 -0
- 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 +90 -39
- package/lib-next/theme/Heading/index.js +24 -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/theme/hooks → lib-next/theme/MDXComponents}/styles.css +3 -2
- 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 +158 -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 +103 -48
- 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/package.json +26 -24
- package/src/admonitions.css +35 -0
- package/src/deps.d.ts +13 -0
- package/src/index.ts +23 -20
- package/{lib-next/prism-include-languages.js → src/prism-include-languages.ts} +0 -0
- package/src/theme/Admonition/index.tsx +106 -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/{lib/theme/IconEdit → src/theme/BlogPostAuthor}/styles.module.css +4 -3
- 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 +27 -151
- package/src/theme/CodeBlock/styles.module.css +12 -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/{lib/theme/BlogPostItem → src/theme/DocItemFooter}/styles.module.css +8 -8
- package/src/theme/DocPage/index.tsx +44 -22
- package/src/theme/DocPaginator/index.tsx +5 -33
- package/src/theme/DocPaginatorNavLink/index.tsx +38 -0
- 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 +103 -42
- package/src/theme/Heading/index.tsx +24 -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 +180 -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/index.tsx +110 -54
- 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 +822 -0
- package/src/translations.ts +41 -23
- package/src/types.d.ts +0 -629
- package/src/{validateThemeConfig.js → validateThemeConfig.ts} +160 -100
- package/babel.config.js +0 -35
- 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/__tests__/__snapshots__/translations.test.ts.snap +0 -116
- package/lib/__tests__/translations.test.js +0 -112
- package/lib/__tests__/validateThemeConfig.test.js +0 -333
- package/lib/theme/AnnouncementBar/index.js +0 -72
- package/lib/theme/AnnouncementBar/styles.module.css +0 -72
- package/lib/theme/BlogListPage/index.js +0 -71
- package/lib/theme/BlogListPaginator/index.js +0 -63
- package/lib/theme/BlogPostItem/index.js +0 -161
- package/lib/theme/BlogPostPage/index.js +0 -69
- package/lib/theme/BlogPostPaginator/index.js +0 -64
- package/lib/theme/BlogSidebar/index.js +0 -51
- package/lib/theme/BlogSidebar/styles.module.css +0 -44
- package/lib/theme/BlogTagsListPage/index.js +0 -76
- package/lib/theme/BlogTagsPostsPage/index.js +0 -100
- package/lib/theme/CodeBlock/index.js +0 -253
- package/lib/theme/CodeBlock/styles.module.css +0 -68
- package/lib/theme/DocItem/index.js +0 -138
- package/lib/theme/DocItem/styles.module.css +0 -31
- package/lib/theme/DocPage/index.js +0 -139
- package/lib/theme/DocPage/styles.module.css +0 -85
- package/lib/theme/DocPaginator/index.js +0 -63
- package/lib/theme/DocSidebar/index.js +0 -133
- package/lib/theme/DocSidebar/styles.module.css +0 -106
- package/lib/theme/DocSidebarItem/index.js +0 -175
- package/lib/theme/DocVersionBanner/index.js +0 -128
- package/lib/theme/EditThisPage/index.js +0 -31
- package/lib/theme/Footer/index.js +0 -115
- package/lib/theme/Footer/styles.module.css +0 -15
- package/lib/theme/Heading/index.js +0 -76
- package/lib/theme/Heading/styles.css +0 -23
- package/lib/theme/Heading/styles.module.css +0 -15
- package/lib/theme/IconArrow/index.js +0 -28
- package/lib/theme/IconEdit/index.js +0 -34
- package/lib/theme/IconExternalLink/index.js +0 -30
- package/lib/theme/IconLanguage/index.js +0 -29
- package/lib/theme/IconMenu/index.js +0 -30
- package/lib/theme/LastUpdated/index.js +0 -61
- package/lib/theme/Layout/index.js +0 -64
- package/lib/theme/Layout/styles.css +0 -27
- package/lib/theme/LayoutHead/index.js +0 -144
- package/lib/theme/LayoutProviders/index.js +0 -38
- package/lib/theme/Logo/index.js +0 -60
- package/lib/theme/MDXComponents/index.js +0 -65
- package/lib/theme/MDXPage/index.js +0 -66
- package/lib/theme/Navbar/index.js +0 -248
- package/lib/theme/Navbar/styles.module.css +0 -63
- package/lib/theme/NavbarItem/DefaultNavbarItem.js +0 -210
- package/lib/theme/NavbarItem/DocNavbarItem.js +0 -63
- package/lib/theme/NavbarItem/DocsVersionDropdownNavbarItem.js +0 -76
- package/lib/theme/NavbarItem/DocsVersionNavbarItem.js +0 -43
- package/lib/theme/NavbarItem/LocaleDropdownNavbarItem.js +0 -72
- package/lib/theme/NavbarItem/SearchNavbarItem.js +0 -28
- package/lib/theme/NavbarItem/index.js +0 -54
- package/lib/theme/NotFound.js +0 -57
- package/lib/theme/SearchBar.js +0 -15
- package/lib/theme/SearchMetadatas/index.js +0 -33
- package/lib/theme/Seo/index.js +0 -49
- package/lib/theme/SkipToContent/index.js +0 -71
- package/lib/theme/SkipToContent/styles.module.css +0 -14
- package/lib/theme/TOC/index.js +0 -60
- package/lib/theme/TOC/styles.module.css +0 -23
- package/lib/theme/TOCCollapsible/index.js +0 -51
- package/lib/theme/TOCCollapsible/styles.module.css +0 -49
- package/lib/theme/TOCInline/index.js +0 -53
- package/lib/theme/TOCInline/styles.module.css +0 -12
- package/lib/theme/TabItem/index.js +0 -32
- package/lib/theme/Tabs/index.js +0 -150
- package/lib/theme/Tabs/styles.module.css +0 -23
- package/lib/theme/ThemeContext.js +0 -21
- package/lib/theme/ThemeProvider/index.js +0 -38
- package/lib/theme/ThemedImage/index.js +0 -49
- package/lib/theme/ThemedImage/styles.module.css +0 -18
- package/lib/theme/Toggle/index.js +0 -94
- package/lib/theme/Toggle/styles.css +0 -103
- package/lib/theme/Toggle/styles.module.css +0 -17
- package/lib/theme/UserPreferencesContext.js +0 -18
- package/lib/theme/UserPreferencesProvider/index.js +0 -36
- package/lib/theme/hooks/useContextualSearchFilters.js +0 -47
- package/lib/theme/hooks/useDocs.js +0 -18
- package/lib/theme/hooks/useHideableNavbar.js +0 -92
- package/lib/theme/hooks/useKeyboardNavigation.js +0 -45
- package/lib/theme/hooks/useLocationHash.js +0 -28
- package/lib/theme/hooks/useLockBodyScroll.js +0 -26
- package/lib/theme/hooks/usePrismTheme.js +0 -36
- package/lib/theme/hooks/useScrollPosition.js +0 -49
- package/lib/theme/hooks/useTOCHighlight.js +0 -87
- package/lib/theme/hooks/useTabGroupChoice.js +0 -51
- package/lib/theme/hooks/useTheme.js +0 -99
- package/lib/theme/hooks/useThemeContext.js +0 -31
- package/lib/theme/hooks/useUserPreferencesContext.js +0 -31
- package/lib/theme/hooks/useWindowSize.js +0 -73
- package/lib/theme/prism-include-languages.js +0 -39
- package/lib-next/__tests__/__snapshots__/translations.test.ts.snap +0 -116
- package/lib-next/__tests__/translations.test.js +0 -128
- package/lib-next/__tests__/validateThemeConfig.test.js +0 -333
- package/lib-next/index.js +0 -221
- package/lib-next/theme/Toggle/styles.css +0 -103
- package/lib-next/theme/hooks/useContextualSearchFilters.js +0 -41
- package/lib-next/theme/hooks/useLocationHash.js +0 -20
- package/lib-next/theme/hooks/useScrollPosition.js +0 -38
- package/lib-next/theme/hooks/useTOCHighlight.js +0 -84
- package/lib-next/translations.js +0 -145
- package/lib-next/validateThemeConfig.js +0 -319
- package/src/__tests__/__snapshots__/translations.test.ts.snap +0 -116
- package/src/__tests__/translations.test.ts +0 -116
- package/src/__tests__/validateThemeConfig.test.js +0 -333
- package/src/prism-include-languages.js +0 -11
- package/src/theme/Toggle/styles.css +0 -103
- package/src/theme/hooks/useContextualSearchFilters.ts +0 -52
- package/src/theme/hooks/useLocationHash.ts +0 -25
- package/src/theme/hooks/useScrollPosition.ts +0 -45
- package/src/theme/hooks/useTOCHighlight.ts +0 -98
- package/tsconfig.json +0 -12
- package/update-code-translations.js +0 -242
- package/update-code-translations.test.js +0 -33
|
@@ -1,85 +0,0 @@
|
|
|
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
|
-
--doc-sidebar-width: 300px;
|
|
10
|
-
--doc-sidebar-hidden-width: 30px;
|
|
11
|
-
}
|
|
12
|
-
|
|
13
|
-
:global(.docs-wrapper) {
|
|
14
|
-
display: flex;
|
|
15
|
-
}
|
|
16
|
-
|
|
17
|
-
.docPage,
|
|
18
|
-
.docMainContainer {
|
|
19
|
-
display: flex;
|
|
20
|
-
width: 100%;
|
|
21
|
-
}
|
|
22
|
-
|
|
23
|
-
.docSidebarContainer {
|
|
24
|
-
display: none;
|
|
25
|
-
}
|
|
26
|
-
|
|
27
|
-
@media (min-width: 997px) {
|
|
28
|
-
.docMainContainer {
|
|
29
|
-
flex-grow: 1;
|
|
30
|
-
max-width: calc(100% - var(--doc-sidebar-width));
|
|
31
|
-
}
|
|
32
|
-
|
|
33
|
-
.docMainContainerEnhanced {
|
|
34
|
-
max-width: calc(100% - var(--doc-sidebar-hidden-width));
|
|
35
|
-
}
|
|
36
|
-
|
|
37
|
-
.docSidebarContainer {
|
|
38
|
-
display: block;
|
|
39
|
-
width: var(--doc-sidebar-width);
|
|
40
|
-
margin-top: calc(-1 * var(--ifm-navbar-height));
|
|
41
|
-
border-right: 1px solid var(--ifm-toc-border-color);
|
|
42
|
-
will-change: width;
|
|
43
|
-
transition: width var(--ifm-transition-fast) ease;
|
|
44
|
-
clip-path: inset(0);
|
|
45
|
-
}
|
|
46
|
-
|
|
47
|
-
.docSidebarContainerHidden {
|
|
48
|
-
width: var(--doc-sidebar-hidden-width);
|
|
49
|
-
cursor: pointer;
|
|
50
|
-
}
|
|
51
|
-
|
|
52
|
-
.collapsedDocSidebar {
|
|
53
|
-
position: sticky;
|
|
54
|
-
top: 0;
|
|
55
|
-
height: 100%;
|
|
56
|
-
max-height: 100vh;
|
|
57
|
-
display: flex;
|
|
58
|
-
align-items: center;
|
|
59
|
-
justify-content: center;
|
|
60
|
-
transition: background-color var(--ifm-transition-fast) ease;
|
|
61
|
-
}
|
|
62
|
-
|
|
63
|
-
.collapsedDocSidebar:hover,
|
|
64
|
-
.collapsedDocSidebar:focus {
|
|
65
|
-
background-color: var(--ifm-color-emphasis-200);
|
|
66
|
-
}
|
|
67
|
-
|
|
68
|
-
.expandSidebarButtonIcon {
|
|
69
|
-
transform: rotate(0);
|
|
70
|
-
}
|
|
71
|
-
html[dir='rtl'] .expandSidebarButtonIcon {
|
|
72
|
-
transform: rotate(180deg);
|
|
73
|
-
}
|
|
74
|
-
|
|
75
|
-
html[data-theme='dark'] .collapsedDocSidebar:hover,
|
|
76
|
-
html[data-theme='dark'] .collapsedDocSidebar:focus {
|
|
77
|
-
background-color: var(--collapse-button-bg-color-dark);
|
|
78
|
-
}
|
|
79
|
-
|
|
80
|
-
.docItemWrapperEnhanced {
|
|
81
|
-
max-width: calc(
|
|
82
|
-
var(--ifm-container-width) + var(--doc-sidebar-width)
|
|
83
|
-
) !important;
|
|
84
|
-
}
|
|
85
|
-
}
|
|
@@ -1,63 +0,0 @@
|
|
|
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 _Link = _interopRequireDefault(require("@docusaurus/Link"));
|
|
11
|
-
|
|
12
|
-
var _Translate = _interopRequireWildcard(require("@docusaurus/Translate"));
|
|
13
|
-
|
|
14
|
-
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); }
|
|
15
|
-
|
|
16
|
-
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; }
|
|
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 DocPaginator(props) {
|
|
27
|
-
const {
|
|
28
|
-
metadata
|
|
29
|
-
} = props;
|
|
30
|
-
return <nav className="pagination-nav docusaurus-mt-lg" aria-label={(0, _Translate.translate)({
|
|
31
|
-
id: 'theme.docs.paginator.navAriaLabel',
|
|
32
|
-
message: 'Docs pages navigation',
|
|
33
|
-
description: 'The ARIA label for the docs pagination'
|
|
34
|
-
})}>
|
|
35
|
-
<div className="pagination-nav__item">
|
|
36
|
-
{metadata.previous && <_Link.default className="pagination-nav__link" to={metadata.previous.permalink}>
|
|
37
|
-
<div className="pagination-nav__sublabel">
|
|
38
|
-
<_Translate.default id="theme.docs.paginator.previous" description="The label used to navigate to the previous doc">
|
|
39
|
-
Previous
|
|
40
|
-
</_Translate.default>
|
|
41
|
-
</div>
|
|
42
|
-
<div className="pagination-nav__label">
|
|
43
|
-
« {metadata.previous.title}
|
|
44
|
-
</div>
|
|
45
|
-
</_Link.default>}
|
|
46
|
-
</div>
|
|
47
|
-
<div className="pagination-nav__item pagination-nav__item--next">
|
|
48
|
-
{metadata.next && <_Link.default className="pagination-nav__link" to={metadata.next.permalink}>
|
|
49
|
-
<div className="pagination-nav__sublabel">
|
|
50
|
-
<_Translate.default id="theme.docs.paginator.next" description="The label used to navigate to the next doc">
|
|
51
|
-
Next
|
|
52
|
-
</_Translate.default>
|
|
53
|
-
</div>
|
|
54
|
-
<div className="pagination-nav__label">
|
|
55
|
-
{metadata.next.title} »
|
|
56
|
-
</div>
|
|
57
|
-
</_Link.default>}
|
|
58
|
-
</div>
|
|
59
|
-
</nav>;
|
|
60
|
-
}
|
|
61
|
-
|
|
62
|
-
var _default = DocPaginator;
|
|
63
|
-
exports.default = _default;
|
|
@@ -1,133 +0,0 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
|
|
3
|
-
Object.defineProperty(exports, "__esModule", {
|
|
4
|
-
value: true
|
|
5
|
-
});
|
|
6
|
-
exports.default = DocSidebar;
|
|
7
|
-
|
|
8
|
-
var _react = _interopRequireWildcard(require("react"));
|
|
9
|
-
|
|
10
|
-
var _clsx = _interopRequireDefault(require("clsx"));
|
|
11
|
-
|
|
12
|
-
var _themeCommon = require("@docusaurus/theme-common");
|
|
13
|
-
|
|
14
|
-
var _useWindowSize = _interopRequireDefault(require("@theme/hooks/useWindowSize"));
|
|
15
|
-
|
|
16
|
-
var _useScrollPosition = _interopRequireDefault(require("@theme/hooks/useScrollPosition"));
|
|
17
|
-
|
|
18
|
-
var _Logo = _interopRequireDefault(require("@theme/Logo"));
|
|
19
|
-
|
|
20
|
-
var _IconArrow = _interopRequireDefault(require("@theme/IconArrow"));
|
|
21
|
-
|
|
22
|
-
var _Translate = require("@docusaurus/Translate");
|
|
23
|
-
|
|
24
|
-
var _DocSidebarItem = require("@theme/DocSidebarItem");
|
|
25
|
-
|
|
26
|
-
var _stylesModule = _interopRequireDefault(require("./styles.module.css"));
|
|
27
|
-
|
|
28
|
-
function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
|
|
29
|
-
|
|
30
|
-
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); }
|
|
31
|
-
|
|
32
|
-
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; }
|
|
33
|
-
|
|
34
|
-
/**
|
|
35
|
-
* Copyright (c) Facebook, Inc. and its affiliates.
|
|
36
|
-
*
|
|
37
|
-
* This source code is licensed under the MIT license found in the
|
|
38
|
-
* LICENSE file in the root directory of this source tree.
|
|
39
|
-
*/
|
|
40
|
-
function useShowAnnouncementBar() {
|
|
41
|
-
const {
|
|
42
|
-
isClosed
|
|
43
|
-
} = (0, _themeCommon.useAnnouncementBar)();
|
|
44
|
-
const [showAnnouncementBar, setShowAnnouncementBar] = (0, _react.useState)(!isClosed);
|
|
45
|
-
(0, _useScrollPosition.default)(({
|
|
46
|
-
scrollY
|
|
47
|
-
}) => {
|
|
48
|
-
if (!isClosed) {
|
|
49
|
-
setShowAnnouncementBar(scrollY === 0);
|
|
50
|
-
}
|
|
51
|
-
});
|
|
52
|
-
return showAnnouncementBar;
|
|
53
|
-
}
|
|
54
|
-
|
|
55
|
-
function HideableSidebarButton({
|
|
56
|
-
onClick
|
|
57
|
-
}) {
|
|
58
|
-
return <button type="button" title={(0, _Translate.translate)({
|
|
59
|
-
id: 'theme.docs.sidebar.collapseButtonTitle',
|
|
60
|
-
message: 'Collapse sidebar',
|
|
61
|
-
description: 'The title attribute for collapse button of doc sidebar'
|
|
62
|
-
})} aria-label={(0, _Translate.translate)({
|
|
63
|
-
id: 'theme.docs.sidebar.collapseButtonAriaLabel',
|
|
64
|
-
message: 'Collapse sidebar',
|
|
65
|
-
description: 'The title attribute for collapse button of doc sidebar'
|
|
66
|
-
})} className={(0, _clsx.default)('button button--secondary button--outline', _stylesModule.default.collapseSidebarButton)} onClick={onClick}>
|
|
67
|
-
<_IconArrow.default className={_stylesModule.default.collapseSidebarButtonIcon} />
|
|
68
|
-
</button>;
|
|
69
|
-
}
|
|
70
|
-
|
|
71
|
-
function DocSidebarDesktop({
|
|
72
|
-
path,
|
|
73
|
-
sidebar,
|
|
74
|
-
sidebarCollapsible,
|
|
75
|
-
onCollapse,
|
|
76
|
-
isHidden
|
|
77
|
-
}) {
|
|
78
|
-
const showAnnouncementBar = useShowAnnouncementBar();
|
|
79
|
-
const {
|
|
80
|
-
navbar: {
|
|
81
|
-
hideOnScroll
|
|
82
|
-
},
|
|
83
|
-
hideableSidebar
|
|
84
|
-
} = (0, _themeCommon.useThemeConfig)();
|
|
85
|
-
const {
|
|
86
|
-
isClosed: isAnnouncementBarClosed
|
|
87
|
-
} = (0, _themeCommon.useAnnouncementBar)();
|
|
88
|
-
return <div className={(0, _clsx.default)(_stylesModule.default.sidebar, {
|
|
89
|
-
[_stylesModule.default.sidebarWithHideableNavbar]: hideOnScroll,
|
|
90
|
-
[_stylesModule.default.sidebarHidden]: isHidden
|
|
91
|
-
})}>
|
|
92
|
-
{hideOnScroll && <_Logo.default tabIndex={-1} className={_stylesModule.default.sidebarLogo} />}
|
|
93
|
-
<nav className={(0, _clsx.default)('menu thin-scrollbar', _stylesModule.default.menu, {
|
|
94
|
-
[_stylesModule.default.menuWithAnnouncementBar]: !isAnnouncementBarClosed && showAnnouncementBar
|
|
95
|
-
})}>
|
|
96
|
-
<ul className="menu__list">
|
|
97
|
-
<_DocSidebarItem.DocSidebarItems items={sidebar} collapsible={sidebarCollapsible} activePath={path} />
|
|
98
|
-
</ul>
|
|
99
|
-
</nav>
|
|
100
|
-
{hideableSidebar && <HideableSidebarButton onClick={onCollapse} />}
|
|
101
|
-
</div>;
|
|
102
|
-
}
|
|
103
|
-
|
|
104
|
-
const DocSidebarMobileSecondaryMenu = ({
|
|
105
|
-
toggleSidebar,
|
|
106
|
-
sidebar,
|
|
107
|
-
sidebarCollapsible,
|
|
108
|
-
path
|
|
109
|
-
}) => {
|
|
110
|
-
return <ul className="menu__list">
|
|
111
|
-
<_DocSidebarItem.DocSidebarItems items={sidebar} collapsible={sidebarCollapsible} activePath={path} onItemClick={() => toggleSidebar()} />
|
|
112
|
-
</ul>;
|
|
113
|
-
};
|
|
114
|
-
|
|
115
|
-
function DocSidebarMobile(props) {
|
|
116
|
-
return <_themeCommon.MobileSecondaryMenuFiller component={DocSidebarMobileSecondaryMenu} props={props} />;
|
|
117
|
-
}
|
|
118
|
-
|
|
119
|
-
const DocSidebarDesktopMemo = _react.default.memo(DocSidebarDesktop);
|
|
120
|
-
|
|
121
|
-
const DocSidebarMobileMemo = _react.default.memo(DocSidebarMobile);
|
|
122
|
-
|
|
123
|
-
function DocSidebar(props) {
|
|
124
|
-
const windowSize = (0, _useWindowSize.default)(); // Desktop sidebar visible on hydration: need SSR rendering
|
|
125
|
-
|
|
126
|
-
const shouldRenderSidebarDesktop = windowSize === 'desktop' || windowSize === 'ssr'; // Mobile sidebar not visible on hydration: can avoid SSR rendering
|
|
127
|
-
|
|
128
|
-
const shouldRenderSidebarMobile = windowSize === 'mobile';
|
|
129
|
-
return <>
|
|
130
|
-
{shouldRenderSidebarDesktop && <DocSidebarDesktopMemo {...props} />}
|
|
131
|
-
{shouldRenderSidebarMobile && <DocSidebarMobileMemo {...props} />}
|
|
132
|
-
</>;
|
|
133
|
-
}
|
|
@@ -1,106 +0,0 @@
|
|
|
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
|
-
--collapse-button-bg-color-dark: #2e333a;
|
|
10
|
-
}
|
|
11
|
-
|
|
12
|
-
@media (min-width: 997px) {
|
|
13
|
-
.sidebar {
|
|
14
|
-
display: flex;
|
|
15
|
-
flex-direction: column;
|
|
16
|
-
max-height: 100vh;
|
|
17
|
-
height: 100%;
|
|
18
|
-
position: sticky;
|
|
19
|
-
top: 0;
|
|
20
|
-
padding-top: var(--ifm-navbar-height);
|
|
21
|
-
width: var(--doc-sidebar-width);
|
|
22
|
-
transition: opacity 50ms ease;
|
|
23
|
-
}
|
|
24
|
-
|
|
25
|
-
.sidebarWithHideableNavbar {
|
|
26
|
-
padding-top: 0;
|
|
27
|
-
}
|
|
28
|
-
|
|
29
|
-
.sidebarHidden {
|
|
30
|
-
opacity: 0;
|
|
31
|
-
height: 0;
|
|
32
|
-
overflow: hidden;
|
|
33
|
-
visibility: hidden;
|
|
34
|
-
}
|
|
35
|
-
|
|
36
|
-
.sidebarLogo {
|
|
37
|
-
display: flex !important;
|
|
38
|
-
align-items: center;
|
|
39
|
-
margin: 0 var(--ifm-navbar-padding-horizontal);
|
|
40
|
-
min-height: var(--ifm-navbar-height);
|
|
41
|
-
max-height: var(--ifm-navbar-height);
|
|
42
|
-
color: inherit !important;
|
|
43
|
-
text-decoration: none !important;
|
|
44
|
-
}
|
|
45
|
-
|
|
46
|
-
.sidebarLogo img {
|
|
47
|
-
margin-right: 0.5rem;
|
|
48
|
-
height: 2rem;
|
|
49
|
-
}
|
|
50
|
-
|
|
51
|
-
.menu {
|
|
52
|
-
flex-grow: 1;
|
|
53
|
-
padding: 0.5rem;
|
|
54
|
-
}
|
|
55
|
-
|
|
56
|
-
.menuWithAnnouncementBar {
|
|
57
|
-
margin-bottom: var(--docusaurus-announcement-bar-height);
|
|
58
|
-
}
|
|
59
|
-
|
|
60
|
-
.collapseSidebarButton {
|
|
61
|
-
display: block !important;
|
|
62
|
-
background-color: var(--ifm-button-background-color);
|
|
63
|
-
height: 40px;
|
|
64
|
-
position: sticky;
|
|
65
|
-
bottom: 0;
|
|
66
|
-
border-radius: 0;
|
|
67
|
-
border: 1px solid var(--ifm-toc-border-color);
|
|
68
|
-
}
|
|
69
|
-
|
|
70
|
-
.collapseSidebarButtonIcon {
|
|
71
|
-
transform: rotate(180deg);
|
|
72
|
-
margin-top: 4px;
|
|
73
|
-
}
|
|
74
|
-
html[dir='rtl'] .collapseSidebarButtonIcon {
|
|
75
|
-
transform: rotate(0);
|
|
76
|
-
}
|
|
77
|
-
|
|
78
|
-
html[data-theme='dark'] .collapseSidebarButton {
|
|
79
|
-
background-color: var(--collapse-button-bg-color-dark);
|
|
80
|
-
}
|
|
81
|
-
|
|
82
|
-
html[data-theme='dark'] .collapseSidebarButton:hover,
|
|
83
|
-
html[data-theme='dark'] .collapseSidebarButton:focus {
|
|
84
|
-
background-color: var(--ifm-color-emphasis-200);
|
|
85
|
-
}
|
|
86
|
-
}
|
|
87
|
-
|
|
88
|
-
.sidebarLogo,
|
|
89
|
-
.collapseSidebarButton {
|
|
90
|
-
display: none;
|
|
91
|
-
}
|
|
92
|
-
|
|
93
|
-
.sidebarMenuIcon {
|
|
94
|
-
vertical-align: middle;
|
|
95
|
-
}
|
|
96
|
-
|
|
97
|
-
.sidebarMenuCloseIcon {
|
|
98
|
-
display: inline-flex;
|
|
99
|
-
justify-content: center;
|
|
100
|
-
align-items: center;
|
|
101
|
-
height: 24px;
|
|
102
|
-
font-size: 1.5rem;
|
|
103
|
-
font-weight: var(--ifm-font-weight-bold);
|
|
104
|
-
line-height: 0.9;
|
|
105
|
-
width: 24px;
|
|
106
|
-
}
|
|
@@ -1,175 +0,0 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
|
|
3
|
-
Object.defineProperty(exports, "__esModule", {
|
|
4
|
-
value: true
|
|
5
|
-
});
|
|
6
|
-
exports.default = DocSidebarItem;
|
|
7
|
-
exports.DocSidebarItems = void 0;
|
|
8
|
-
|
|
9
|
-
var _react = _interopRequireWildcard(require("react"));
|
|
10
|
-
|
|
11
|
-
var _clsx = _interopRequireDefault(require("clsx"));
|
|
12
|
-
|
|
13
|
-
var _themeCommon = require("@docusaurus/theme-common");
|
|
14
|
-
|
|
15
|
-
var _Link = _interopRequireDefault(require("@docusaurus/Link"));
|
|
16
|
-
|
|
17
|
-
var _isInternalUrl = _interopRequireDefault(require("@docusaurus/isInternalUrl"));
|
|
18
|
-
|
|
19
|
-
var _IconExternalLink = _interopRequireDefault(require("@theme/IconExternalLink"));
|
|
20
|
-
|
|
21
|
-
var _stylesModule = _interopRequireDefault(require("./styles.module.css"));
|
|
22
|
-
|
|
23
|
-
function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
|
|
24
|
-
|
|
25
|
-
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); }
|
|
26
|
-
|
|
27
|
-
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; }
|
|
28
|
-
|
|
29
|
-
/**
|
|
30
|
-
* Copyright (c) Facebook, Inc. and its affiliates.
|
|
31
|
-
*
|
|
32
|
-
* This source code is licensed under the MIT license found in the
|
|
33
|
-
* LICENSE file in the root directory of this source tree.
|
|
34
|
-
*/
|
|
35
|
-
const isActiveSidebarItem = (item, activePath) => {
|
|
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"
|
|
46
|
-
// TODO this item should probably not receive the "activePath" props
|
|
47
|
-
// TODO this triggers whole sidebar re-renders on navigation
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
const DocSidebarItems = (0, _react.memo)(function DocSidebarItems({
|
|
51
|
-
items,
|
|
52
|
-
...props
|
|
53
|
-
}) {
|
|
54
|
-
return <>
|
|
55
|
-
{items.map((item, index) => <DocSidebarItem key={index} // sidebar is static, the index does not change
|
|
56
|
-
item={item} {...props} />)}
|
|
57
|
-
</>;
|
|
58
|
-
});
|
|
59
|
-
exports.DocSidebarItems = DocSidebarItems;
|
|
60
|
-
|
|
61
|
-
function DocSidebarItem({
|
|
62
|
-
item,
|
|
63
|
-
...props
|
|
64
|
-
}) {
|
|
65
|
-
switch (item.type) {
|
|
66
|
-
case 'category':
|
|
67
|
-
if (item.items.length === 0) {
|
|
68
|
-
return null;
|
|
69
|
-
}
|
|
70
|
-
|
|
71
|
-
return <DocSidebarItemCategory item={item} {...props} />;
|
|
72
|
-
|
|
73
|
-
case 'link':
|
|
74
|
-
default:
|
|
75
|
-
return <DocSidebarItemLink item={item} {...props} />;
|
|
76
|
-
}
|
|
77
|
-
} // If we navigate to a category and it becomes active, it should automatically expand itself
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
function useAutoExpandActiveCategory({
|
|
81
|
-
isActive,
|
|
82
|
-
collapsed,
|
|
83
|
-
setCollapsed
|
|
84
|
-
}) {
|
|
85
|
-
const wasActive = (0, _themeCommon.usePrevious)(isActive);
|
|
86
|
-
(0, _react.useEffect)(() => {
|
|
87
|
-
const justBecameActive = isActive && !wasActive;
|
|
88
|
-
|
|
89
|
-
if (justBecameActive && collapsed) {
|
|
90
|
-
setCollapsed(false);
|
|
91
|
-
}
|
|
92
|
-
}, [isActive, wasActive, collapsed]);
|
|
93
|
-
}
|
|
94
|
-
|
|
95
|
-
function DocSidebarItemCategory({
|
|
96
|
-
item,
|
|
97
|
-
onItemClick,
|
|
98
|
-
collapsible = true,
|
|
99
|
-
activePath,
|
|
100
|
-
...props
|
|
101
|
-
}) {
|
|
102
|
-
const {
|
|
103
|
-
items,
|
|
104
|
-
label
|
|
105
|
-
} = item;
|
|
106
|
-
const isActive = isActiveSidebarItem(item, activePath);
|
|
107
|
-
const {
|
|
108
|
-
collapsed,
|
|
109
|
-
setCollapsed,
|
|
110
|
-
toggleCollapsed
|
|
111
|
-
} = (0, _themeCommon.useCollapsible)({
|
|
112
|
-
// active categories are always initialized as expanded
|
|
113
|
-
// the default (item.collapsed) is only used for non-active categories
|
|
114
|
-
initialState: () => {
|
|
115
|
-
var _item$collapsed;
|
|
116
|
-
|
|
117
|
-
if (!collapsible) {
|
|
118
|
-
return false;
|
|
119
|
-
}
|
|
120
|
-
|
|
121
|
-
return isActive ? false : (_item$collapsed = item.collapsed) !== null && _item$collapsed !== void 0 ? _item$collapsed : true;
|
|
122
|
-
}
|
|
123
|
-
});
|
|
124
|
-
useAutoExpandActiveCategory({
|
|
125
|
-
isActive,
|
|
126
|
-
collapsed,
|
|
127
|
-
setCollapsed
|
|
128
|
-
});
|
|
129
|
-
return <li className={(0, _clsx.default)('menu__list-item', {
|
|
130
|
-
'menu__list-item--collapsed': collapsed
|
|
131
|
-
})}>
|
|
132
|
-
{
|
|
133
|
-
/* eslint-disable-next-line jsx-a11y/anchor-is-valid */
|
|
134
|
-
}
|
|
135
|
-
<a className={(0, _clsx.default)('menu__link', {
|
|
136
|
-
'menu__link--sublist': collapsible,
|
|
137
|
-
'menu__link--active': collapsible && isActive,
|
|
138
|
-
[_stylesModule.default.menuLinkText]: !collapsible
|
|
139
|
-
})} onClick={collapsible ? toggleCollapsed : undefined} href={collapsible ? '#' : undefined} {...props}>
|
|
140
|
-
{label}
|
|
141
|
-
</a>
|
|
142
|
-
|
|
143
|
-
<_themeCommon.Collapsible as="ul" className="menu__list" collapsed={collapsed}>
|
|
144
|
-
<DocSidebarItems items={items} tabIndex={collapsed ? -1 : 0} onItemClick={onItemClick} collapsible={collapsible} activePath={activePath} />
|
|
145
|
-
</_themeCommon.Collapsible>
|
|
146
|
-
</li>;
|
|
147
|
-
}
|
|
148
|
-
|
|
149
|
-
function DocSidebarItemLink({
|
|
150
|
-
item,
|
|
151
|
-
onItemClick,
|
|
152
|
-
activePath,
|
|
153
|
-
collapsible: _collapsible,
|
|
154
|
-
...props
|
|
155
|
-
}) {
|
|
156
|
-
const {
|
|
157
|
-
href,
|
|
158
|
-
label
|
|
159
|
-
} = item;
|
|
160
|
-
const isActive = isActiveSidebarItem(item, activePath);
|
|
161
|
-
return <li className="menu__list-item" key={label}>
|
|
162
|
-
<_Link.default className={(0, _clsx.default)('menu__link', {
|
|
163
|
-
'menu__link--active': isActive
|
|
164
|
-
})} to={href} {...(0, _isInternalUrl.default)(href) && {
|
|
165
|
-
isNavLink: true,
|
|
166
|
-
exact: true,
|
|
167
|
-
onClick: onItemClick
|
|
168
|
-
}} {...props}>
|
|
169
|
-
{(0, _isInternalUrl.default)(href) ? label : <span>
|
|
170
|
-
{label}
|
|
171
|
-
<_IconExternalLink.default />
|
|
172
|
-
</span>}
|
|
173
|
-
</_Link.default>
|
|
174
|
-
</li>;
|
|
175
|
-
}
|
|
@@ -1,128 +0,0 @@
|
|
|
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 _useDocusaurusContext = _interopRequireDefault(require("@docusaurus/useDocusaurusContext"));
|
|
11
|
-
|
|
12
|
-
var _Link = _interopRequireDefault(require("@docusaurus/Link"));
|
|
13
|
-
|
|
14
|
-
var _Translate = _interopRequireDefault(require("@docusaurus/Translate"));
|
|
15
|
-
|
|
16
|
-
var _useDocs = require("@theme/hooks/useDocs");
|
|
17
|
-
|
|
18
|
-
var _themeCommon = require("@docusaurus/theme-common");
|
|
19
|
-
|
|
20
|
-
function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
|
|
21
|
-
|
|
22
|
-
/**
|
|
23
|
-
* Copyright (c) Facebook, Inc. and its affiliates.
|
|
24
|
-
*
|
|
25
|
-
* This source code is licensed under the MIT license found in the
|
|
26
|
-
* LICENSE file in the root directory of this source tree.
|
|
27
|
-
*/
|
|
28
|
-
function UnreleasedVersionLabel({
|
|
29
|
-
siteTitle,
|
|
30
|
-
versionMetadata
|
|
31
|
-
}) {
|
|
32
|
-
return <_Translate.default id="theme.docs.versions.unreleasedVersionLabel" description="The label used to tell the user that he's browsing an unreleased doc version" values={{
|
|
33
|
-
siteTitle,
|
|
34
|
-
versionLabel: <b>{versionMetadata.label}</b>
|
|
35
|
-
}}>
|
|
36
|
-
{'This is unreleased documentation for {siteTitle} {versionLabel} version.'}
|
|
37
|
-
</_Translate.default>;
|
|
38
|
-
}
|
|
39
|
-
|
|
40
|
-
function UnmaintainedVersionLabel({
|
|
41
|
-
siteTitle,
|
|
42
|
-
versionMetadata
|
|
43
|
-
}) {
|
|
44
|
-
return <_Translate.default id="theme.docs.versions.unmaintainedVersionLabel" description="The label used to tell the user that he's browsing an unmaintained doc version" values={{
|
|
45
|
-
siteTitle,
|
|
46
|
-
versionLabel: <b>{versionMetadata.label}</b>
|
|
47
|
-
}}>
|
|
48
|
-
{'This is documentation for {siteTitle} {versionLabel}, which is no longer actively maintained.'}
|
|
49
|
-
</_Translate.default>;
|
|
50
|
-
}
|
|
51
|
-
|
|
52
|
-
const BannerLabelComponents = {
|
|
53
|
-
unreleased: UnreleasedVersionLabel,
|
|
54
|
-
unmaintained: UnmaintainedVersionLabel
|
|
55
|
-
};
|
|
56
|
-
|
|
57
|
-
function BannerLabel(props) {
|
|
58
|
-
const BannerLabelComponent = BannerLabelComponents[props.versionMetadata.banner];
|
|
59
|
-
return <BannerLabelComponent {...props} />;
|
|
60
|
-
}
|
|
61
|
-
|
|
62
|
-
function LatestVersionSuggestionLabel({
|
|
63
|
-
versionLabel,
|
|
64
|
-
to,
|
|
65
|
-
onClick
|
|
66
|
-
}) {
|
|
67
|
-
return <_Translate.default id="theme.docs.versions.latestVersionSuggestionLabel" description="The label used to tell the user to check the latest version" values={{
|
|
68
|
-
versionLabel,
|
|
69
|
-
latestVersionLink: <b>
|
|
70
|
-
<_Link.default to={to} onClick={onClick}>
|
|
71
|
-
<_Translate.default id="theme.docs.versions.latestVersionLinkLabel" description="The label used for the latest version suggestion link label">
|
|
72
|
-
latest version
|
|
73
|
-
</_Translate.default>
|
|
74
|
-
</_Link.default>
|
|
75
|
-
</b>
|
|
76
|
-
}}>
|
|
77
|
-
{'For up-to-date documentation, see the {latestVersionLink} ({versionLabel}).'}
|
|
78
|
-
</_Translate.default>;
|
|
79
|
-
}
|
|
80
|
-
|
|
81
|
-
function DocVersionBannerEnabled({
|
|
82
|
-
versionMetadata
|
|
83
|
-
}) {
|
|
84
|
-
const {
|
|
85
|
-
siteConfig: {
|
|
86
|
-
title: siteTitle
|
|
87
|
-
}
|
|
88
|
-
} = (0, _useDocusaurusContext.default)();
|
|
89
|
-
const {
|
|
90
|
-
pluginId
|
|
91
|
-
} = (0, _useDocs.useActivePlugin)({
|
|
92
|
-
failfast: true
|
|
93
|
-
});
|
|
94
|
-
|
|
95
|
-
const getVersionMainDoc = version => version.docs.find(doc => doc.id === version.mainDocId);
|
|
96
|
-
|
|
97
|
-
const {
|
|
98
|
-
savePreferredVersionName
|
|
99
|
-
} = (0, _themeCommon.useDocsPreferredVersion)(pluginId);
|
|
100
|
-
const {
|
|
101
|
-
latestDocSuggestion,
|
|
102
|
-
latestVersionSuggestion
|
|
103
|
-
} = (0, _useDocs.useDocVersionSuggestions)(pluginId); // try to link to same doc in latest version (not always possible)
|
|
104
|
-
// fallback to main doc of latest version
|
|
105
|
-
|
|
106
|
-
const latestVersionSuggestedDoc = latestDocSuggestion !== null && latestDocSuggestion !== void 0 ? latestDocSuggestion : getVersionMainDoc(latestVersionSuggestion);
|
|
107
|
-
return <div className="alert alert--warning margin-bottom--md" role="alert">
|
|
108
|
-
<div>
|
|
109
|
-
<BannerLabel siteTitle={siteTitle} versionMetadata={versionMetadata} />
|
|
110
|
-
</div>
|
|
111
|
-
<div className="margin-top--md">
|
|
112
|
-
<LatestVersionSuggestionLabel versionLabel={latestVersionSuggestion.label} to={latestVersionSuggestedDoc.path} onClick={() => savePreferredVersionName(latestVersionSuggestion.name)} />
|
|
113
|
-
</div>
|
|
114
|
-
</div>;
|
|
115
|
-
}
|
|
116
|
-
|
|
117
|
-
function DocVersionBanner({
|
|
118
|
-
versionMetadata
|
|
119
|
-
}) {
|
|
120
|
-
if (versionMetadata.banner === 'none') {
|
|
121
|
-
return <></>;
|
|
122
|
-
} else {
|
|
123
|
-
return <DocVersionBannerEnabled versionMetadata={versionMetadata} />;
|
|
124
|
-
}
|
|
125
|
-
}
|
|
126
|
-
|
|
127
|
-
var _default = DocVersionBanner;
|
|
128
|
-
exports.default = _default;
|