@docusaurus/theme-classic 2.0.0-beta.15a2b59f9 → 2.0.0-beta.17
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 +2 -2
- package/lib/admonitions.css +35 -0
- package/{lib-next/theme/Toggle/styles.module.css → lib/deps.d.ts} +5 -9
- package/lib/getSwizzleConfig.js +125 -0
- package/lib/index.js +36 -41
- package/lib/prism-include-languages.js +9 -5
- package/lib/theme-classic.d.ts +771 -0
- package/lib/translations.js +40 -34
- package/lib/types.d.ts +0 -587
- package/lib/validateThemeConfig.js +242 -250
- package/lib-next/theme/Admonition/index.js +101 -0
- package/lib-next/theme/AnnouncementBar/index.js +8 -16
- 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 +44 -0
- package/lib-next/theme/BlogArchivePage/index.js +80 -0
- package/lib-next/theme/BlogLayout/index.js +37 -0
- package/lib-next/theme/BlogListPage/index.js +18 -29
- package/lib-next/theme/BlogListPaginator/index.js +13 -16
- package/lib-next/theme/BlogPostAuthor/index.js +52 -0
- package/{lib/theme/IconEdit → lib-next/theme/BlogPostAuthor}/styles.module.css +4 -3
- package/lib-next/theme/BlogPostAuthors/index.js +44 -0
- package/{src/theme/Toggle → lib-next/theme/BlogPostAuthors}/styles.module.css +11 -7
- package/lib-next/theme/BlogPostItem/index.js +94 -96
- package/lib-next/theme/BlogPostPage/index.js +75 -39
- package/lib-next/theme/BlogPostPaginator/index.js +12 -19
- package/lib-next/theme/BlogSidebar/index.js +11 -13
- package/lib-next/theme/BlogSidebar/styles.module.css +4 -2
- package/lib-next/theme/BlogTagsListPage/index.js +15 -59
- package/lib-next/theme/BlogTagsPostsPage/index.js +33 -41
- package/lib-next/theme/CodeBlock/index.js +64 -154
- package/lib-next/theme/CodeBlock/styles.module.css +17 -9
- package/lib-next/theme/ColorModeToggle/index.js +83 -0
- package/lib-next/theme/ColorModeToggle/styles.module.css +51 -0
- package/lib-next/theme/Details/index.js +21 -0
- package/lib-next/theme/Details/styles.module.css +13 -0
- package/lib-next/theme/DocBreadcrumbs/index.js +76 -0
- package/lib-next/theme/DocBreadcrumbs/styles.module.css +26 -0
- package/lib-next/theme/DocCard/index.js +91 -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 +54 -0
- package/lib-next/theme/DocCategoryGeneratedIndexPage/styles.module.css +18 -0
- package/lib-next/theme/DocItem/index.js +53 -58
- package/lib-next/theme/DocItem/styles.module.css +6 -10
- package/lib-next/theme/DocItemFooter/index.js +79 -0
- package/{lib/theme/DocItem → lib-next/theme/DocItemFooter}/styles.module.css +1 -9
- package/lib-next/theme/DocPage/index.js +54 -55
- package/lib-next/theme/DocPage/styles.module.css +9 -3
- package/lib-next/theme/DocPaginator/index.js +15 -24
- package/lib-next/theme/DocSidebar/index.js +65 -286
- package/lib-next/theme/DocSidebar/styles.module.css +5 -22
- package/lib-next/theme/DocSidebarItem/index.js +264 -0
- package/{lib/theme/BlogPostItem → lib-next/theme/DocSidebarItem}/styles.module.css +5 -10
- package/lib-next/theme/DocSidebarItems/index.js +28 -0
- package/lib-next/theme/DocTagDocListPage/index.js +89 -0
- package/lib-next/theme/DocTagsListPage/index.js +35 -0
- package/lib-next/theme/DocVersionBadge/index.js +34 -0
- package/lib-next/theme/DocVersionBanner/index.js +32 -15
- package/lib-next/theme/EditThisPage/index.js +6 -1
- package/lib-next/theme/ErrorPageContent.js +35 -0
- package/lib-next/theme/Footer/index.js +95 -40
- package/lib-next/theme/Footer/styles.module.css +2 -1
- package/lib-next/theme/Heading/index.js +39 -48
- package/lib-next/theme/Heading/styles.module.css +25 -5
- package/lib-next/theme/IconArrow/index.js +2 -5
- package/lib-next/theme/IconClose/index.js +23 -0
- package/lib-next/theme/IconDarkMode/index.js +17 -0
- package/lib-next/theme/IconEdit/index.js +2 -5
- package/lib-next/theme/IconExternalLink/index.js +2 -5
- package/lib-next/theme/IconLanguage/index.js +5 -8
- package/lib-next/theme/IconLightMode/index.js +17 -0
- package/lib-next/theme/IconMenu/index.js +7 -5
- package/lib-next/theme/LastUpdated/index.js +3 -2
- package/lib-next/theme/Layout/index.js +5 -7
- package/lib-next/theme/LayoutHead/index.js +27 -32
- package/lib-next/theme/LayoutProviders/index.js +15 -9
- package/lib-next/theme/Logo/index.js +25 -24
- package/lib-next/theme/MDXComponents/index.js +59 -30
- package/{src/theme/hooks → lib-next/theme/MDXComponents}/styles.css +7 -2
- package/lib-next/theme/MDXPage/index.js +10 -12
- package/lib-next/theme/Navbar/index.js +199 -64
- package/lib-next/theme/Navbar/styles.module.css +10 -3
- package/lib-next/theme/NavbarItem/DefaultNavbarItem.js +35 -201
- package/lib-next/theme/NavbarItem/DocNavbarItem.js +11 -8
- package/lib-next/theme/NavbarItem/DocSidebarNavbarItem.js +73 -0
- package/lib-next/theme/NavbarItem/DocsVersionDropdownNavbarItem.js +34 -20
- package/lib-next/theme/NavbarItem/DocsVersionNavbarItem.js +4 -1
- package/lib-next/theme/NavbarItem/DropdownNavbarItem.js +156 -0
- package/lib-next/theme/NavbarItem/{LocaleDropdownNavbarItem.js → LocaleDropdownNavbarItem/index.js} +12 -13
- package/{lib/theme/hooks/styles.css → lib-next/theme/NavbarItem/LocaleDropdownNavbarItem/styles.module.css} +3 -2
- package/lib-next/theme/NavbarItem/NavbarNavLink.js +70 -0
- package/lib-next/theme/NavbarItem/index.js +26 -14
- package/lib-next/theme/{UserPreferencesContext.js → NavbarItem/utils.js} +3 -3
- package/lib-next/theme/NotFound.js +1 -4
- package/lib-next/theme/PaginatorNavLink/index.js +17 -0
- package/lib-next/theme/SearchBar.js +1 -1
- package/lib-next/theme/SearchMetadata/index.js +34 -0
- package/lib-next/theme/Seo/index.js +11 -7
- package/lib-next/theme/SkipToContent/index.js +3 -5
- package/lib-next/theme/SkipToContent/styles.module.css +7 -0
- package/lib-next/theme/TOC/index.js +12 -39
- package/lib-next/theme/TOC/styles.module.css +1 -1
- package/lib-next/theme/TOCCollapsible/index.js +54 -0
- package/lib-next/theme/TOCCollapsible/styles.module.css +50 -0
- package/lib-next/theme/TOCInline/index.js +10 -31
- package/lib-next/theme/TOCItems/index.js +85 -0
- package/lib-next/theme/TabItem/index.js +1 -4
- package/lib-next/theme/Tabs/__tests__/index.test.js +146 -0
- package/lib-next/theme/Tabs/index.js +108 -50
- package/lib-next/theme/Tabs/styles.module.css +0 -13
- package/lib-next/theme/Tag/index.js +24 -0
- package/lib-next/theme/Tag/styles.module.css +70 -0
- package/lib-next/theme/TagsListByLetter/index.js +40 -0
- package/lib-next/theme/{hooks/styles.css → TagsListByLetter/styles.module.css} +3 -2
- package/lib-next/theme/TagsListInline/index.js +31 -0
- package/lib-next/theme/TagsListInline/styles.module.css +15 -0
- package/lib-next/theme/ThemedImage/index.js +7 -10
- package/lib-next/theme/ThemedImage/styles.module.css +2 -2
- package/lib-next/theme/prism-include-languages.js +17 -15
- package/package.json +31 -31
- package/src/admonitions.css +35 -0
- package/src/deps.d.ts +13 -0
- package/src/getSwizzleConfig.ts +123 -0
- package/src/index.ts +39 -61
- 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 +9 -15
- package/src/theme/AnnouncementBar/styles.module.css +23 -32
- package/src/theme/BackToTopButton/index.tsx +143 -0
- package/src/theme/BackToTopButton/styles.module.css +44 -0
- package/src/theme/BlogArchivePage/index.tsx +91 -0
- package/src/theme/BlogLayout/index.tsx +42 -0
- package/src/theme/BlogListPage/index.tsx +19 -28
- package/src/theme/BlogListPaginator/index.tsx +13 -15
- package/src/theme/BlogPostAuthor/index.tsx +54 -0
- package/{lib/theme/MDXPage → src/theme/BlogPostAuthor}/styles.module.css +4 -2
- package/src/theme/BlogPostAuthors/index.tsx +49 -0
- package/src/theme/BlogPostAuthors/styles.module.css +21 -0
- package/src/theme/BlogPostItem/index.tsx +84 -90
- package/src/theme/BlogPostPage/index.tsx +77 -38
- package/src/theme/BlogPostPaginator/index.tsx +12 -18
- package/src/theme/BlogSidebar/index.tsx +11 -13
- package/src/theme/BlogSidebar/styles.module.css +4 -2
- package/src/theme/BlogTagsListPage/index.tsx +15 -60
- package/src/theme/BlogTagsPostsPage/index.tsx +32 -40
- package/src/theme/CodeBlock/index.tsx +68 -156
- package/src/theme/CodeBlock/styles.module.css +17 -9
- package/src/theme/ColorModeToggle/index.tsx +92 -0
- package/src/theme/ColorModeToggle/styles.module.css +51 -0
- package/src/theme/Details/index.tsx +25 -0
- package/src/theme/Details/styles.module.css +13 -0
- package/src/theme/DocBreadcrumbs/index.tsx +91 -0
- package/src/theme/DocBreadcrumbs/styles.module.css +26 -0
- package/src/theme/DocCard/index.tsx +109 -0
- package/src/theme/DocCard/styles.module.css +43 -0
- package/src/theme/DocCardList/index.tsx +27 -0
- package/src/theme/DocCategoryGeneratedIndexPage/index.tsx +59 -0
- package/src/theme/DocCategoryGeneratedIndexPage/styles.module.css +18 -0
- package/src/theme/DocItem/index.tsx +56 -58
- package/src/theme/DocItem/styles.module.css +6 -10
- package/src/theme/DocItemFooter/index.tsx +91 -0
- package/{lib/theme/Toggle → src/theme/DocItemFooter}/styles.module.css +9 -8
- package/src/theme/DocPage/index.tsx +53 -49
- package/src/theme/DocPage/styles.module.css +9 -3
- package/src/theme/DocPaginator/index.tsx +15 -23
- package/src/theme/DocSidebar/index.tsx +76 -298
- package/src/theme/DocSidebar/styles.module.css +5 -22
- package/src/theme/DocSidebarItem/index.tsx +283 -0
- package/src/theme/DocSidebarItem/styles.module.css +13 -0
- package/src/theme/DocSidebarItems/index.tsx +32 -0
- package/src/theme/DocTagDocListPage/index.tsx +89 -0
- package/src/theme/DocTagsListPage/index.tsx +39 -0
- package/src/theme/DocVersionBadge/index.tsx +35 -0
- package/src/theme/DocVersionBanner/index.tsx +49 -22
- package/src/theme/EditThisPage/index.tsx +6 -1
- package/src/theme/ErrorPageContent.tsx +41 -0
- package/src/theme/Footer/index.tsx +109 -44
- package/src/theme/Footer/styles.module.css +2 -1
- package/src/theme/Heading/index.tsx +38 -53
- package/src/theme/Heading/styles.module.css +25 -5
- package/src/theme/IconArrow/index.tsx +2 -4
- package/src/theme/IconClose/index.tsx +26 -0
- package/src/theme/IconDarkMode/index.tsx +20 -0
- package/src/theme/IconEdit/index.tsx +5 -4
- package/src/theme/IconExternalLink/index.tsx +3 -5
- package/src/theme/IconLanguage/index.tsx +6 -8
- package/src/theme/IconLightMode/index.tsx +20 -0
- package/src/theme/IconMenu/index.tsx +3 -5
- package/src/theme/LastUpdated/index.tsx +3 -2
- package/src/theme/Layout/index.tsx +5 -6
- package/src/theme/LayoutHead/index.tsx +26 -25
- package/src/theme/LayoutProviders/index.tsx +15 -9
- package/src/theme/Logo/index.tsx +21 -19
- package/src/theme/MDXComponents/index.tsx +70 -32
- package/{lib/theme/IconExternalLink/styles.module.css → src/theme/MDXComponents/styles.css} +7 -4
- package/src/theme/MDXPage/index.tsx +10 -12
- package/src/theme/Navbar/index.tsx +208 -68
- package/src/theme/Navbar/styles.module.css +10 -3
- package/src/theme/NavbarItem/DefaultNavbarItem.tsx +37 -207
- package/src/theme/NavbarItem/DocNavbarItem.tsx +17 -18
- package/src/theme/NavbarItem/DocSidebarNavbarItem.tsx +84 -0
- package/src/theme/NavbarItem/DocsVersionDropdownNavbarItem.tsx +39 -24
- 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} +16 -10
- package/src/theme/NavbarItem/LocaleDropdownNavbarItem/styles.module.css +11 -0
- package/src/theme/NavbarItem/NavbarNavLink.tsx +68 -0
- package/src/theme/NavbarItem/index.tsx +41 -18
- package/src/theme/NavbarItem/utils.ts +10 -0
- package/src/theme/NotFound.tsx +1 -3
- package/src/theme/PaginatorNavLink/index.tsx +20 -0
- package/src/theme/SearchBar.tsx +2 -1
- package/src/theme/SearchMetadata/index.tsx +43 -0
- package/src/theme/Seo/index.tsx +7 -4
- package/src/theme/SkipToContent/index.tsx +3 -5
- package/src/theme/SkipToContent/styles.module.css +7 -0
- package/src/theme/TOC/index.tsx +13 -44
- package/src/theme/TOC/styles.module.css +1 -1
- package/src/theme/TOCCollapsible/index.tsx +58 -0
- package/src/theme/TOCCollapsible/styles.module.css +50 -0
- package/src/theme/TOCInline/index.tsx +14 -35
- package/src/theme/TOCItems/index.tsx +100 -0
- package/src/theme/TabItem/index.tsx +5 -3
- package/src/theme/Tabs/index.tsx +115 -56
- package/src/theme/Tabs/styles.module.css +0 -13
- package/src/theme/Tag/index.tsx +29 -0
- package/src/theme/Tag/styles.module.css +70 -0
- package/src/theme/TagsListByLetter/index.tsx +43 -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/ThemedImage/index.tsx +7 -9
- package/src/theme/ThemedImage/styles.module.css +2 -2
- package/src/theme/prism-include-languages.ts +20 -15
- package/src/theme-classic.d.ts +771 -0
- package/src/translations.ts +74 -54
- package/src/types.d.ts +0 -587
- package/src/validateThemeConfig.ts +381 -0
- package/babel.config.js +0 -35
- package/codeTranslations/README.md +0 -20
- package/codeTranslations/ar.json +0 -57
- package/codeTranslations/base.json +0 -112
- package/codeTranslations/bn.json +0 -56
- package/codeTranslations/da.json +0 -57
- package/codeTranslations/de.json +0 -57
- package/codeTranslations/es.json +0 -57
- package/codeTranslations/fa.json +0 -57
- package/codeTranslations/fil.json +0 -57
- package/codeTranslations/fr.json +0 -57
- package/codeTranslations/he.json +0 -57
- package/codeTranslations/hi.json +0 -57
- package/codeTranslations/ja.json +0 -57
- package/codeTranslations/ko.json +0 -57
- package/codeTranslations/pl.json +0 -57
- package/codeTranslations/pt-BR.json +0 -57
- package/codeTranslations/pt-PT.json +0 -57
- package/codeTranslations/ru.json +0 -57
- package/codeTranslations/tr.json +0 -57
- package/codeTranslations/vi.json +0 -57
- package/codeTranslations/zh-Hans.json +0 -57
- package/codeTranslations/zh-Hant.json +0 -57
- 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 -129
- package/lib/theme/DocPage/index.js +0 -173
- package/lib/theme/DocPage/styles.module.css +0 -80
- package/lib/theme/DocPaginator/index.js +0 -63
- package/lib/theme/DocSidebar/index.js +0 -309
- package/lib/theme/DocSidebar/styles.module.css +0 -124
- 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 -36
- 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 -147
- package/lib/theme/Navbar/styles.module.css +0 -20
- package/lib/theme/NavbarItem/DefaultNavbarItem.js +0 -209
- 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 -59
- package/lib/theme/TOC/styles.module.css +0 -23
- 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/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 -55
- 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/Heading/styles.css +0 -23
- package/lib-next/theme/SearchMetadatas/index.js +0 -20
- package/lib-next/theme/ThemeContext.js +0 -9
- package/lib-next/theme/ThemeProvider/index.js +0 -25
- package/lib-next/theme/Toggle/index.js +0 -80
- package/lib-next/theme/Toggle/styles.css +0 -103
- package/lib-next/theme/UserPreferencesProvider/index.js +0 -24
- package/lib-next/theme/hooks/useContextualSearchFilters.js +0 -41
- package/lib-next/theme/hooks/useDocs.js +0 -10
- package/lib-next/theme/hooks/useHideableNavbar.js +0 -79
- package/lib-next/theme/hooks/useKeyboardNavigation.js +0 -35
- package/lib-next/theme/hooks/useLocationHash.js +0 -20
- package/lib-next/theme/hooks/useLockBodyScroll.js +0 -18
- package/lib-next/theme/hooks/usePrismTheme.js +0 -20
- package/lib-next/theme/hooks/useScrollPosition.js +0 -38
- package/lib-next/theme/hooks/useTOCHighlight.js +0 -84
- package/lib-next/theme/hooks/useTabGroupChoice.js +0 -39
- package/lib-next/theme/hooks/useTheme.js +0 -82
- package/lib-next/theme/hooks/useThemeContext.js +0 -22
- package/lib-next/theme/hooks/useUserPreferencesContext.js +0 -22
- package/lib-next/theme/hooks/useWindowSize.js +0 -45
- package/lib-next/translations.js +0 -145
- package/lib-next/types.d.ts +0 -598
- package/lib-next/validateThemeConfig.js +0 -317
- 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/Heading/styles.css +0 -23
- package/src/theme/SearchMetadatas/index.tsx +0 -28
- package/src/theme/ThemeContext.ts +0 -15
- package/src/theme/ThemeProvider/index.tsx +0 -24
- package/src/theme/Toggle/index.tsx +0 -100
- package/src/theme/Toggle/styles.css +0 -103
- package/src/theme/UserPreferencesContext.ts +0 -12
- package/src/theme/UserPreferencesProvider/index.tsx +0 -27
- package/src/theme/hooks/useContextualSearchFilters.ts +0 -52
- package/src/theme/hooks/useDocs.ts +0 -11
- package/src/theme/hooks/useHideableNavbar.ts +0 -85
- package/src/theme/hooks/useKeyboardNavigation.ts +0 -39
- package/src/theme/hooks/useLocationHash.ts +0 -25
- package/src/theme/hooks/useLockBodyScroll.ts +0 -20
- package/src/theme/hooks/usePrismTheme.ts +0 -22
- package/src/theme/hooks/useScrollPosition.ts +0 -45
- package/src/theme/hooks/useTOCHighlight.ts +0 -98
- package/src/theme/hooks/useTabGroupChoice.ts +0 -46
- package/src/theme/hooks/useTheme.ts +0 -92
- package/src/theme/hooks/useThemeContext.ts +0 -23
- package/src/theme/hooks/useUserPreferencesContext.ts +0 -25
- package/src/theme/hooks/useWindowSize.ts +0 -51
- package/src/validateThemeConfig.js +0 -317
- package/tsconfig.json +0 -12
- package/update-code-translations.js +0 -240
- package/update-code-translations.test.js +0 -33
|
@@ -1,80 +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
|
-
@media (min-width: 997px) {
|
|
24
|
-
.docMainContainer {
|
|
25
|
-
flex-grow: 1;
|
|
26
|
-
max-width: calc(100% - var(--doc-sidebar-width));
|
|
27
|
-
}
|
|
28
|
-
|
|
29
|
-
.docMainContainerEnhanced {
|
|
30
|
-
max-width: calc(100% - var(--doc-sidebar-hidden-width));
|
|
31
|
-
}
|
|
32
|
-
|
|
33
|
-
.docSidebarContainer {
|
|
34
|
-
width: var(--doc-sidebar-width);
|
|
35
|
-
margin-top: calc(-1 * var(--ifm-navbar-height));
|
|
36
|
-
border-right: 1px solid var(--ifm-toc-border-color);
|
|
37
|
-
will-change: width;
|
|
38
|
-
transition: width var(--ifm-transition-fast) ease;
|
|
39
|
-
clip-path: inset(0);
|
|
40
|
-
}
|
|
41
|
-
|
|
42
|
-
.docSidebarContainerHidden {
|
|
43
|
-
width: var(--doc-sidebar-hidden-width);
|
|
44
|
-
cursor: pointer;
|
|
45
|
-
}
|
|
46
|
-
|
|
47
|
-
.collapsedDocSidebar {
|
|
48
|
-
position: sticky;
|
|
49
|
-
top: 0;
|
|
50
|
-
height: 100%;
|
|
51
|
-
max-height: 100vh;
|
|
52
|
-
display: flex;
|
|
53
|
-
align-items: center;
|
|
54
|
-
justify-content: center;
|
|
55
|
-
transition: background-color var(--ifm-transition-fast) ease;
|
|
56
|
-
}
|
|
57
|
-
|
|
58
|
-
.collapsedDocSidebar:hover,
|
|
59
|
-
.collapsedDocSidebar:focus {
|
|
60
|
-
background-color: var(--ifm-color-emphasis-200);
|
|
61
|
-
}
|
|
62
|
-
|
|
63
|
-
.expandSidebarButtonIcon {
|
|
64
|
-
transform: rotate(0);
|
|
65
|
-
}
|
|
66
|
-
html[dir='rtl'] .expandSidebarButtonIcon {
|
|
67
|
-
transform: rotate(180deg);
|
|
68
|
-
}
|
|
69
|
-
|
|
70
|
-
html[data-theme='dark'] .collapsedDocSidebar:hover,
|
|
71
|
-
html[data-theme='dark'] .collapsedDocSidebar:focus {
|
|
72
|
-
background-color: var(--collapse-button-bg-color-dark);
|
|
73
|
-
}
|
|
74
|
-
|
|
75
|
-
.docItemWrapperEnhanced {
|
|
76
|
-
max-width: calc(
|
|
77
|
-
var(--ifm-container-width) + var(--doc-sidebar-width)
|
|
78
|
-
) !important;
|
|
79
|
-
}
|
|
80
|
-
}
|
|
@@ -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,309 +0,0 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
|
|
3
|
-
Object.defineProperty(exports, "__esModule", {
|
|
4
|
-
value: true
|
|
5
|
-
});
|
|
6
|
-
exports.default = void 0;
|
|
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 _useLockBodyScroll = _interopRequireDefault(require("@theme/hooks/useLockBodyScroll"));
|
|
15
|
-
|
|
16
|
-
var _useWindowSize = _interopRequireWildcard(require("@theme/hooks/useWindowSize"));
|
|
17
|
-
|
|
18
|
-
var _useScrollPosition = _interopRequireDefault(require("@theme/hooks/useScrollPosition"));
|
|
19
|
-
|
|
20
|
-
var _Link = _interopRequireDefault(require("@docusaurus/Link"));
|
|
21
|
-
|
|
22
|
-
var _isInternalUrl = _interopRequireDefault(require("@docusaurus/isInternalUrl"));
|
|
23
|
-
|
|
24
|
-
var _Logo = _interopRequireDefault(require("@theme/Logo"));
|
|
25
|
-
|
|
26
|
-
var _IconArrow = _interopRequireDefault(require("@theme/IconArrow"));
|
|
27
|
-
|
|
28
|
-
var _IconMenu = _interopRequireDefault(require("@theme/IconMenu"));
|
|
29
|
-
|
|
30
|
-
var _IconExternalLink = _interopRequireDefault(require("@theme/IconExternalLink"));
|
|
31
|
-
|
|
32
|
-
var _Translate = require("@docusaurus/Translate");
|
|
33
|
-
|
|
34
|
-
var _stylesModule = _interopRequireDefault(require("./styles.module.css"));
|
|
35
|
-
|
|
36
|
-
function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
|
|
37
|
-
|
|
38
|
-
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); }
|
|
39
|
-
|
|
40
|
-
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; }
|
|
41
|
-
|
|
42
|
-
/**
|
|
43
|
-
* Copyright (c) Facebook, Inc. and its affiliates.
|
|
44
|
-
*
|
|
45
|
-
* This source code is licensed under the MIT license found in the
|
|
46
|
-
* LICENSE file in the root directory of this source tree.
|
|
47
|
-
*/
|
|
48
|
-
const MOBILE_TOGGLE_SIZE = 24;
|
|
49
|
-
|
|
50
|
-
const isActiveSidebarItem = (item, activePath) => {
|
|
51
|
-
if (item.type === 'link') {
|
|
52
|
-
return (0, _themeCommon.isSamePath)(item.href, activePath);
|
|
53
|
-
}
|
|
54
|
-
|
|
55
|
-
if (item.type === 'category') {
|
|
56
|
-
return item.items.some(subItem => isActiveSidebarItem(subItem, activePath));
|
|
57
|
-
}
|
|
58
|
-
|
|
59
|
-
return false;
|
|
60
|
-
}; // Optimize sidebar at each "level"
|
|
61
|
-
// TODO this item should probably not receive the "activePath" props
|
|
62
|
-
// TODO this triggers whole sidebar re-renders on navigation
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
const DocSidebarItems = (0, _react.memo)(function DocSidebarItems({
|
|
66
|
-
items,
|
|
67
|
-
...props
|
|
68
|
-
}) {
|
|
69
|
-
return items.map((item, index) => <DocSidebarItem key={index} // sidebar is static, the index does not change
|
|
70
|
-
item={item} {...props} />);
|
|
71
|
-
});
|
|
72
|
-
|
|
73
|
-
function DocSidebarItem(props) {
|
|
74
|
-
switch (props.item.type) {
|
|
75
|
-
case 'category':
|
|
76
|
-
return <DocSidebarItemCategory {...props} />;
|
|
77
|
-
|
|
78
|
-
case 'link':
|
|
79
|
-
default:
|
|
80
|
-
return <DocSidebarItemLink {...props} />;
|
|
81
|
-
}
|
|
82
|
-
}
|
|
83
|
-
|
|
84
|
-
function DocSidebarItemCategory({
|
|
85
|
-
item,
|
|
86
|
-
onItemClick,
|
|
87
|
-
collapsible,
|
|
88
|
-
activePath,
|
|
89
|
-
...props
|
|
90
|
-
}) {
|
|
91
|
-
const {
|
|
92
|
-
items,
|
|
93
|
-
label
|
|
94
|
-
} = item;
|
|
95
|
-
const isActive = isActiveSidebarItem(item, activePath);
|
|
96
|
-
const wasActive = (0, _themeCommon.usePrevious)(isActive); // active categories are always initialized as expanded
|
|
97
|
-
// the default (item.collapsed) is only used for non-active categories
|
|
98
|
-
|
|
99
|
-
const [collapsed, setCollapsed] = (0, _react.useState)(() => {
|
|
100
|
-
if (!collapsible) {
|
|
101
|
-
return false;
|
|
102
|
-
}
|
|
103
|
-
|
|
104
|
-
return isActive ? false : item.collapsed;
|
|
105
|
-
});
|
|
106
|
-
const menuListRef = (0, _react.useRef)(null);
|
|
107
|
-
const [menuListHeight, setMenuListHeight] = (0, _react.useState)(undefined);
|
|
108
|
-
|
|
109
|
-
const handleMenuListHeight = (calc = true) => {
|
|
110
|
-
var _menuListRef$current;
|
|
111
|
-
|
|
112
|
-
setMenuListHeight(calc ? `${(_menuListRef$current = menuListRef.current) === null || _menuListRef$current === void 0 ? void 0 : _menuListRef$current.scrollHeight}px` : undefined);
|
|
113
|
-
}; // If we navigate to a category, it should automatically expand itself
|
|
114
|
-
|
|
115
|
-
|
|
116
|
-
(0, _react.useEffect)(() => {
|
|
117
|
-
const justBecameActive = isActive && !wasActive;
|
|
118
|
-
|
|
119
|
-
if (justBecameActive && collapsed) {
|
|
120
|
-
setCollapsed(false);
|
|
121
|
-
}
|
|
122
|
-
}, [isActive, wasActive, collapsed]);
|
|
123
|
-
const handleItemClick = (0, _react.useCallback)(e => {
|
|
124
|
-
e.preventDefault();
|
|
125
|
-
|
|
126
|
-
if (!menuListHeight) {
|
|
127
|
-
handleMenuListHeight();
|
|
128
|
-
}
|
|
129
|
-
|
|
130
|
-
setTimeout(() => setCollapsed(state => !state), 100);
|
|
131
|
-
}, [menuListHeight]);
|
|
132
|
-
|
|
133
|
-
if (items.length === 0) {
|
|
134
|
-
return null;
|
|
135
|
-
}
|
|
136
|
-
|
|
137
|
-
return <li className={(0, _clsx.default)('menu__list-item', {
|
|
138
|
-
'menu__list-item--collapsed': collapsed
|
|
139
|
-
})}>
|
|
140
|
-
{
|
|
141
|
-
/* eslint-disable-next-line jsx-a11y/anchor-is-valid */
|
|
142
|
-
}
|
|
143
|
-
<a className={(0, _clsx.default)('menu__link', {
|
|
144
|
-
'menu__link--sublist': collapsible,
|
|
145
|
-
'menu__link--active': collapsible && isActive,
|
|
146
|
-
[_stylesModule.default.menuLinkText]: !collapsible
|
|
147
|
-
})} onClick={collapsible ? handleItemClick : undefined} href={collapsible ? '#' : undefined} {...props}>
|
|
148
|
-
{label}
|
|
149
|
-
</a>
|
|
150
|
-
<ul className="menu__list" ref={menuListRef} style={{
|
|
151
|
-
height: menuListHeight
|
|
152
|
-
}} onTransitionEnd={() => {
|
|
153
|
-
if (!collapsed) {
|
|
154
|
-
handleMenuListHeight(false);
|
|
155
|
-
}
|
|
156
|
-
}}>
|
|
157
|
-
<DocSidebarItems items={items} tabIndex={collapsed ? '-1' : '0'} onItemClick={onItemClick} collapsible={collapsible} activePath={activePath} />
|
|
158
|
-
</ul>
|
|
159
|
-
</li>;
|
|
160
|
-
}
|
|
161
|
-
|
|
162
|
-
function DocSidebarItemLink({
|
|
163
|
-
item,
|
|
164
|
-
onItemClick,
|
|
165
|
-
activePath,
|
|
166
|
-
collapsible: _collapsible,
|
|
167
|
-
...props
|
|
168
|
-
}) {
|
|
169
|
-
const {
|
|
170
|
-
href,
|
|
171
|
-
label
|
|
172
|
-
} = item;
|
|
173
|
-
const isActive = isActiveSidebarItem(item, activePath);
|
|
174
|
-
return <li className="menu__list-item" key={label}>
|
|
175
|
-
<_Link.default className={(0, _clsx.default)('menu__link', {
|
|
176
|
-
'menu__link--active': isActive
|
|
177
|
-
})} to={href} {...(0, _isInternalUrl.default)(href) && {
|
|
178
|
-
isNavLink: true,
|
|
179
|
-
exact: true,
|
|
180
|
-
onClick: onItemClick
|
|
181
|
-
}} {...props}>
|
|
182
|
-
{(0, _isInternalUrl.default)(href) ? label : <span>
|
|
183
|
-
{label}
|
|
184
|
-
<_IconExternalLink.default />
|
|
185
|
-
</span>}
|
|
186
|
-
</_Link.default>
|
|
187
|
-
</li>;
|
|
188
|
-
}
|
|
189
|
-
|
|
190
|
-
function useShowAnnouncementBar() {
|
|
191
|
-
const {
|
|
192
|
-
isClosed
|
|
193
|
-
} = (0, _themeCommon.useAnnouncementBar)();
|
|
194
|
-
const [showAnnouncementBar, setShowAnnouncementBar] = (0, _react.useState)(!isClosed);
|
|
195
|
-
(0, _useScrollPosition.default)(({
|
|
196
|
-
scrollY
|
|
197
|
-
}) => {
|
|
198
|
-
if (!isClosed) {
|
|
199
|
-
setShowAnnouncementBar(scrollY === 0);
|
|
200
|
-
}
|
|
201
|
-
});
|
|
202
|
-
return showAnnouncementBar;
|
|
203
|
-
}
|
|
204
|
-
|
|
205
|
-
function useResponsiveSidebar() {
|
|
206
|
-
const [showResponsiveSidebar, setShowResponsiveSidebar] = (0, _react.useState)(false);
|
|
207
|
-
(0, _useLockBodyScroll.default)(showResponsiveSidebar);
|
|
208
|
-
const windowSize = (0, _useWindowSize.default)();
|
|
209
|
-
(0, _react.useEffect)(() => {
|
|
210
|
-
if (windowSize === _useWindowSize.windowSizes.desktop) {
|
|
211
|
-
setShowResponsiveSidebar(false);
|
|
212
|
-
}
|
|
213
|
-
}, [windowSize]);
|
|
214
|
-
const closeResponsiveSidebar = (0, _react.useCallback)(e => {
|
|
215
|
-
e.target.blur();
|
|
216
|
-
setShowResponsiveSidebar(false);
|
|
217
|
-
}, [setShowResponsiveSidebar]);
|
|
218
|
-
const toggleResponsiveSidebar = (0, _react.useCallback)(() => {
|
|
219
|
-
setShowResponsiveSidebar(value => !value);
|
|
220
|
-
}, [setShowResponsiveSidebar]);
|
|
221
|
-
return {
|
|
222
|
-
showResponsiveSidebar,
|
|
223
|
-
closeResponsiveSidebar,
|
|
224
|
-
toggleResponsiveSidebar
|
|
225
|
-
};
|
|
226
|
-
}
|
|
227
|
-
|
|
228
|
-
function HideableSidebarButton({
|
|
229
|
-
onClick
|
|
230
|
-
}) {
|
|
231
|
-
return <button type="button" title={(0, _Translate.translate)({
|
|
232
|
-
id: 'theme.docs.sidebar.collapseButtonTitle',
|
|
233
|
-
message: 'Collapse sidebar',
|
|
234
|
-
description: 'The title attribute for collapse button of doc sidebar'
|
|
235
|
-
})} aria-label={(0, _Translate.translate)({
|
|
236
|
-
id: 'theme.docs.sidebar.collapseButtonAriaLabel',
|
|
237
|
-
message: 'Collapse sidebar',
|
|
238
|
-
description: 'The title attribute for collapse button of doc sidebar'
|
|
239
|
-
})} className={(0, _clsx.default)('button button--secondary button--outline', _stylesModule.default.collapseSidebarButton)} onClick={onClick}>
|
|
240
|
-
<_IconArrow.default className={_stylesModule.default.collapseSidebarButtonIcon} />
|
|
241
|
-
</button>;
|
|
242
|
-
}
|
|
243
|
-
|
|
244
|
-
function ResponsiveSidebarButton({
|
|
245
|
-
responsiveSidebarOpened,
|
|
246
|
-
onClick
|
|
247
|
-
}) {
|
|
248
|
-
return <button aria-label={responsiveSidebarOpened ? (0, _Translate.translate)({
|
|
249
|
-
id: 'theme.docs.sidebar.responsiveCloseButtonLabel',
|
|
250
|
-
message: 'Close menu',
|
|
251
|
-
description: 'The ARIA label for close button of mobile doc sidebar'
|
|
252
|
-
}) : (0, _Translate.translate)({
|
|
253
|
-
id: 'theme.docs.sidebar.responsiveOpenButtonLabel',
|
|
254
|
-
message: 'Open menu',
|
|
255
|
-
description: 'The ARIA label for open button of mobile doc sidebar'
|
|
256
|
-
})} aria-haspopup="true" className="button button--secondary button--sm menu__button" type="button" onClick={onClick}>
|
|
257
|
-
{responsiveSidebarOpened ? <span className={(0, _clsx.default)(_stylesModule.default.sidebarMenuIcon, _stylesModule.default.sidebarMenuCloseIcon)}>
|
|
258
|
-
×
|
|
259
|
-
</span> : <_IconMenu.default className={_stylesModule.default.sidebarMenuIcon} height={MOBILE_TOGGLE_SIZE} width={MOBILE_TOGGLE_SIZE} />}
|
|
260
|
-
</button>;
|
|
261
|
-
}
|
|
262
|
-
|
|
263
|
-
function DocSidebar({
|
|
264
|
-
path,
|
|
265
|
-
sidebar,
|
|
266
|
-
sidebarCollapsible = true,
|
|
267
|
-
onCollapse,
|
|
268
|
-
isHidden
|
|
269
|
-
}) {
|
|
270
|
-
const showAnnouncementBar = useShowAnnouncementBar();
|
|
271
|
-
const {
|
|
272
|
-
navbar: {
|
|
273
|
-
hideOnScroll
|
|
274
|
-
},
|
|
275
|
-
hideableSidebar
|
|
276
|
-
} = (0, _themeCommon.useThemeConfig)();
|
|
277
|
-
const {
|
|
278
|
-
isClosed: isAnnouncementBarClosed
|
|
279
|
-
} = (0, _themeCommon.useAnnouncementBar)();
|
|
280
|
-
const {
|
|
281
|
-
showResponsiveSidebar,
|
|
282
|
-
closeResponsiveSidebar,
|
|
283
|
-
toggleResponsiveSidebar
|
|
284
|
-
} = useResponsiveSidebar();
|
|
285
|
-
return <div className={(0, _clsx.default)(_stylesModule.default.sidebar, {
|
|
286
|
-
[_stylesModule.default.sidebarWithHideableNavbar]: hideOnScroll,
|
|
287
|
-
[_stylesModule.default.sidebarHidden]: isHidden
|
|
288
|
-
})}>
|
|
289
|
-
{hideOnScroll && <_Logo.default tabIndex={-1} className={_stylesModule.default.sidebarLogo} />}
|
|
290
|
-
<nav className={(0, _clsx.default)('menu', 'menu--responsive', 'thin-scrollbar', _stylesModule.default.menu, {
|
|
291
|
-
'menu--show': showResponsiveSidebar,
|
|
292
|
-
[_stylesModule.default.menuWithAnnouncementBar]: !isAnnouncementBarClosed && showAnnouncementBar
|
|
293
|
-
})} aria-label={(0, _Translate.translate)({
|
|
294
|
-
id: 'theme.docs.sidebar.navAriaLabel',
|
|
295
|
-
message: 'Sidebar navigation',
|
|
296
|
-
description: 'The ARIA label for documentation menu'
|
|
297
|
-
})}>
|
|
298
|
-
<ResponsiveSidebarButton responsiveSidebarOpened={showResponsiveSidebar} onClick={toggleResponsiveSidebar} />
|
|
299
|
-
|
|
300
|
-
<ul className="menu__list">
|
|
301
|
-
<DocSidebarItems items={sidebar} onItemClick={closeResponsiveSidebar} collapsible={sidebarCollapsible} activePath={path} />
|
|
302
|
-
</ul>
|
|
303
|
-
</nav>
|
|
304
|
-
{hideableSidebar && <HideableSidebarButton onClick={onCollapse} />}
|
|
305
|
-
</div>;
|
|
306
|
-
}
|
|
307
|
-
|
|
308
|
-
var _default = DocSidebar;
|
|
309
|
-
exports.default = _default;
|
|
@@ -1,124 +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
|
-
.menuLinkText {
|
|
57
|
-
cursor: initial;
|
|
58
|
-
}
|
|
59
|
-
|
|
60
|
-
.menuLinkText:hover {
|
|
61
|
-
background: none;
|
|
62
|
-
}
|
|
63
|
-
|
|
64
|
-
.menuWithAnnouncementBar {
|
|
65
|
-
margin-bottom: var(--docusaurus-announcement-bar-height);
|
|
66
|
-
}
|
|
67
|
-
|
|
68
|
-
.collapseSidebarButton {
|
|
69
|
-
display: block !important;
|
|
70
|
-
background-color: var(--ifm-button-background-color);
|
|
71
|
-
height: 40px;
|
|
72
|
-
position: sticky;
|
|
73
|
-
bottom: 0;
|
|
74
|
-
border-radius: 0;
|
|
75
|
-
border: 1px solid var(--ifm-toc-border-color);
|
|
76
|
-
}
|
|
77
|
-
|
|
78
|
-
.collapseSidebarButtonIcon {
|
|
79
|
-
transform: rotate(180deg);
|
|
80
|
-
margin-top: 4px;
|
|
81
|
-
}
|
|
82
|
-
html[dir='rtl'] .collapseSidebarButtonIcon {
|
|
83
|
-
transform: rotate(0);
|
|
84
|
-
}
|
|
85
|
-
|
|
86
|
-
html[data-theme='dark'] .collapseSidebarButton {
|
|
87
|
-
background-color: var(--collapse-button-bg-color-dark);
|
|
88
|
-
}
|
|
89
|
-
|
|
90
|
-
html[data-theme='dark'] .collapseSidebarButton:hover,
|
|
91
|
-
html[data-theme='dark'] .collapseSidebarButton:focus {
|
|
92
|
-
background-color: var(--ifm-color-emphasis-200);
|
|
93
|
-
}
|
|
94
|
-
}
|
|
95
|
-
|
|
96
|
-
.sidebarLogo,
|
|
97
|
-
.collapseSidebarButton {
|
|
98
|
-
display: none;
|
|
99
|
-
}
|
|
100
|
-
|
|
101
|
-
.sidebarMenuIcon {
|
|
102
|
-
vertical-align: middle;
|
|
103
|
-
}
|
|
104
|
-
|
|
105
|
-
.sidebarMenuCloseIcon {
|
|
106
|
-
display: inline-flex;
|
|
107
|
-
justify-content: center;
|
|
108
|
-
align-items: center;
|
|
109
|
-
height: 24px;
|
|
110
|
-
font-size: 1.5rem;
|
|
111
|
-
font-weight: var(--ifm-font-weight-bold);
|
|
112
|
-
line-height: 0.9;
|
|
113
|
-
width: 24px;
|
|
114
|
-
}
|
|
115
|
-
|
|
116
|
-
:global(.menu__list) :global(.menu__list) {
|
|
117
|
-
overflow-y: hidden;
|
|
118
|
-
will-change: height;
|
|
119
|
-
transition: height var(--ifm-transition-fast) linear;
|
|
120
|
-
}
|
|
121
|
-
|
|
122
|
-
:global(.menu__list-item--collapsed) :global(.menu__list) {
|
|
123
|
-
height: 0 !important;
|
|
124
|
-
}
|
|
@@ -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;
|