@docusaurus/theme-classic 0.0.0-4277 → 0.0.0-4285

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (152) hide show
  1. package/lib/theme-classic.d.ts +3 -13
  2. package/lib-next/theme/NavbarItem/DropdownNavbarItem.js +1 -2
  3. package/package.json +12 -12
  4. package/src/index.ts +2 -5
  5. package/src/theme/NavbarItem/DropdownNavbarItem.tsx +1 -2
  6. package/src/theme-classic.d.ts +3 -13
  7. package/babel.config.js +0 -35
  8. package/lib/__tests__/__snapshots__/translations.test.ts.snap +0 -116
  9. package/lib/__tests__/translations.test.js +0 -112
  10. package/lib/__tests__/validateThemeConfig.test.js +0 -607
  11. package/lib/theme/AnnouncementBar/index.js +0 -68
  12. package/lib/theme/AnnouncementBar/styles.module.css +0 -63
  13. package/lib/theme/BackToTopButton/index.js +0 -140
  14. package/lib/theme/BackToTopButton/styles.module.css +0 -42
  15. package/lib/theme/BlogArchivePage/index.js +0 -89
  16. package/lib/theme/BlogLayout/index.js +0 -51
  17. package/lib/theme/BlogListPage/index.js +0 -60
  18. package/lib/theme/BlogListPaginator/index.js +0 -63
  19. package/lib/theme/BlogPostAuthor/index.js +0 -51
  20. package/lib/theme/BlogPostAuthor/styles.module.css +0 -12
  21. package/lib/theme/BlogPostAuthors/index.js +0 -47
  22. package/lib/theme/BlogPostAuthors/styles.module.css +0 -11
  23. package/lib/theme/BlogPostItem/index.js +0 -152
  24. package/lib/theme/BlogPostItem/styles.module.css +0 -18
  25. package/lib/theme/BlogPostPage/index.js +0 -82
  26. package/lib/theme/BlogPostPaginator/index.js +0 -64
  27. package/lib/theme/BlogSidebar/index.js +0 -49
  28. package/lib/theme/BlogSidebar/styles.module.css +0 -44
  29. package/lib/theme/BlogTagsListPage/index.js +0 -40
  30. package/lib/theme/BlogTagsPostsPage/index.js +0 -86
  31. package/lib/theme/CodeBlock/index.js +0 -133
  32. package/lib/theme/CodeBlock/styles.module.css +0 -65
  33. package/lib/theme/Details/index.js +0 -30
  34. package/lib/theme/Details/styles.module.css +0 -13
  35. package/lib/theme/DocCard/index.js +0 -84
  36. package/lib/theme/DocCard/styles.module.css +0 -43
  37. package/lib/theme/DocCardList/index.js +0 -28
  38. package/lib/theme/DocCategoryGeneratedIndexPage/index.js +0 -57
  39. package/lib/theme/DocCategoryGeneratedIndexPage/styles.module.css +0 -18
  40. package/lib/theme/DocItem/index.js +0 -112
  41. package/lib/theme/DocItem/styles.module.css +0 -22
  42. package/lib/theme/DocItemFooter/index.js +0 -79
  43. package/lib/theme/DocItemFooter/styles.module.css +0 -18
  44. package/lib/theme/DocPage/index.js +0 -154
  45. package/lib/theme/DocPage/styles.module.css +0 -85
  46. package/lib/theme/DocPaginator/index.js +0 -62
  47. package/lib/theme/DocSidebar/index.js +0 -134
  48. package/lib/theme/DocSidebar/styles.module.css +0 -106
  49. package/lib/theme/DocSidebarItem/index.js +0 -209
  50. package/lib/theme/DocSidebarItem/styles.module.css +0 -19
  51. package/lib/theme/DocTagDocListPage/index.js +0 -89
  52. package/lib/theme/DocTagsListPage/index.js +0 -44
  53. package/lib/theme/DocVersionBadge/index.js +0 -34
  54. package/lib/theme/DocVersionBanner/index.js +0 -130
  55. package/lib/theme/EditThisPage/index.js +0 -33
  56. package/lib/theme/ErrorPageContent.js +0 -43
  57. package/lib/theme/Footer/index.js +0 -119
  58. package/lib/theme/Footer/styles.module.css +0 -15
  59. package/lib/theme/Heading/index.js +0 -71
  60. package/lib/theme/Heading/styles.css +0 -22
  61. package/lib/theme/Heading/styles.module.css +0 -19
  62. package/lib/theme/IconArrow/index.js +0 -28
  63. package/lib/theme/IconClose/index.js +0 -31
  64. package/lib/theme/IconEdit/index.js +0 -34
  65. package/lib/theme/IconEdit/styles.module.css +0 -11
  66. package/lib/theme/IconExternalLink/index.js +0 -30
  67. package/lib/theme/IconExternalLink/styles.module.css +0 -12
  68. package/lib/theme/IconLanguage/index.js +0 -29
  69. package/lib/theme/IconMenu/index.js +0 -30
  70. package/lib/theme/LastUpdated/index.js +0 -63
  71. package/lib/theme/Layout/index.js +0 -68
  72. package/lib/theme/Layout/styles.css +0 -27
  73. package/lib/theme/LayoutHead/index.js +0 -149
  74. package/lib/theme/LayoutProviders/index.js +0 -40
  75. package/lib/theme/Logo/index.js +0 -62
  76. package/lib/theme/MDXComponents/index.js +0 -106
  77. package/lib/theme/MDXComponents/styles.css +0 -11
  78. package/lib/theme/MDXPage/index.js +0 -67
  79. package/lib/theme/MDXPage/styles.module.css +0 -10
  80. package/lib/theme/Navbar/index.js +0 -267
  81. package/lib/theme/Navbar/styles.module.css +0 -27
  82. package/lib/theme/NavbarItem/DefaultNavbarItem.js +0 -113
  83. package/lib/theme/NavbarItem/DocNavbarItem.js +0 -62
  84. package/lib/theme/NavbarItem/DocsVersionDropdownNavbarItem.js +0 -83
  85. package/lib/theme/NavbarItem/DocsVersionNavbarItem.js +0 -43
  86. package/lib/theme/NavbarItem/DropdownNavbarItem.js +0 -155
  87. package/lib/theme/NavbarItem/LocaleDropdownNavbarItem/index.js +0 -68
  88. package/lib/theme/NavbarItem/LocaleDropdownNavbarItem/styles.module.css +0 -11
  89. package/lib/theme/NavbarItem/SearchNavbarItem.js +0 -28
  90. package/lib/theme/NavbarItem/index.js +0 -74
  91. package/lib/theme/NotFound.js +0 -57
  92. package/lib/theme/SearchBar.js +0 -15
  93. package/lib/theme/SearchMetadata/index.js +0 -33
  94. package/lib/theme/Seo/index.js +0 -52
  95. package/lib/theme/SkipToContent/index.js +0 -71
  96. package/lib/theme/SkipToContent/styles.module.css +0 -14
  97. package/lib/theme/TOC/index.js +0 -39
  98. package/lib/theme/TOC/styles.module.css +0 -23
  99. package/lib/theme/TOCCollapsible/index.js +0 -53
  100. package/lib/theme/TOCCollapsible/styles.module.css +0 -50
  101. package/lib/theme/TOCInline/index.js +0 -33
  102. package/lib/theme/TOCInline/styles.module.css +0 -12
  103. package/lib/theme/TOCItems/index.js +0 -78
  104. package/lib/theme/TabItem/index.js +0 -32
  105. package/lib/theme/Tabs/__tests__/index.test.js +0 -123
  106. package/lib/theme/Tabs/index.js +0 -173
  107. package/lib/theme/Tabs/styles.module.css +0 -10
  108. package/lib/theme/Tag/index.js +0 -40
  109. package/lib/theme/Tag/styles.module.css +0 -70
  110. package/lib/theme/TagsListByLetter/index.js +0 -48
  111. package/lib/theme/TagsListByLetter/styles.module.css +0 -11
  112. package/lib/theme/TagsListInline/index.js +0 -44
  113. package/lib/theme/TagsListInline/styles.module.css +0 -15
  114. package/lib/theme/ThemeContext.js +0 -21
  115. package/lib/theme/ThemeProvider/index.js +0 -43
  116. package/lib/theme/ThemedImage/index.js +0 -47
  117. package/lib/theme/ThemedImage/styles.module.css +0 -18
  118. package/lib/theme/Toggle/index.js +0 -91
  119. package/lib/theme/Toggle/styles.module.css +0 -105
  120. package/lib/theme/UserPreferencesContext.js +0 -18
  121. package/lib/theme/UserPreferencesProvider/index.js +0 -41
  122. package/lib/theme/hooks/styles.css +0 -10
  123. package/lib/theme/hooks/useDocs.js +0 -18
  124. package/lib/theme/hooks/useHideableNavbar.js +0 -74
  125. package/lib/theme/hooks/useKeyboardNavigation.js +0 -45
  126. package/lib/theme/hooks/useLocationHash.js +0 -28
  127. package/lib/theme/hooks/useLockBodyScroll.js +0 -26
  128. package/lib/theme/hooks/usePrismTheme.js +0 -36
  129. package/lib/theme/hooks/useTabGroupChoice.js +0 -51
  130. package/lib/theme/hooks/useTheme.js +0 -97
  131. package/lib/theme/hooks/useThemeContext.js +0 -31
  132. package/lib/theme/hooks/useUserPreferencesContext.js +0 -31
  133. package/lib/theme/hooks/useWindowSize.js +0 -68
  134. package/lib/theme/prism-include-languages.js +0 -40
  135. package/lib-next/__tests__/__snapshots__/translations.test.ts.snap +0 -116
  136. package/lib-next/__tests__/translations.test.js +0 -128
  137. package/lib-next/__tests__/validateThemeConfig.test.js +0 -607
  138. package/lib-next/admonitions.css +0 -35
  139. package/lib-next/deps.d.ts +0 -13
  140. package/lib-next/index.js +0 -227
  141. package/lib-next/prism-include-languages.js +0 -9
  142. package/lib-next/theme/hooks/useLocationHash.js +0 -20
  143. package/lib-next/theme-classic.d.ts +0 -806
  144. package/lib-next/translations.js +0 -141
  145. package/lib-next/types.d.ts +0 -11
  146. package/lib-next/validateThemeConfig.js +0 -344
  147. package/src/__tests__/__snapshots__/translations.test.ts.snap +0 -116
  148. package/src/__tests__/translations.test.ts +0 -116
  149. package/src/__tests__/validateThemeConfig.test.js +0 -607
  150. package/src/theme/Tabs/__tests__/index.test.tsx +0 -129
  151. package/src/theme/hooks/useLocationHash.ts +0 -25
  152. package/tsconfig.json +0 -11
@@ -1,154 +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 _react2 = require("@mdx-js/react");
11
-
12
- var _renderRoutes = _interopRequireDefault(require("@docusaurus/renderRoutes"));
13
-
14
- var _Layout = _interopRequireDefault(require("@theme/Layout"));
15
-
16
- var _DocSidebar = _interopRequireDefault(require("@theme/DocSidebar"));
17
-
18
- var _MDXComponents = _interopRequireDefault(require("@theme/MDXComponents"));
19
-
20
- var _NotFound = _interopRequireDefault(require("@theme/NotFound"));
21
-
22
- var _IconArrow = _interopRequireDefault(require("@theme/IconArrow"));
23
-
24
- var _BackToTopButton = _interopRequireDefault(require("@theme/BackToTopButton"));
25
-
26
- var _router = require("@docusaurus/router");
27
-
28
- var _Translate = require("@docusaurus/Translate");
29
-
30
- var _clsx = _interopRequireDefault(require("clsx"));
31
-
32
- var _stylesModule = _interopRequireDefault(require("./styles.module.css"));
33
-
34
- var _themeCommon = require("@docusaurus/theme-common");
35
-
36
- var _Head = _interopRequireDefault(require("@docusaurus/Head"));
37
-
38
- function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
39
-
40
- 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); }
41
-
42
- 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; }
43
-
44
- /**
45
- * Copyright (c) Facebook, Inc. and its affiliates.
46
- *
47
- * This source code is licensed under the MIT license found in the
48
- * LICENSE file in the root directory of this source tree.
49
- */
50
- function DocPageContent({
51
- currentDocRoute,
52
- versionMetadata,
53
- children,
54
- sidebarName
55
- }) {
56
- const sidebar = (0, _themeCommon.useDocsSidebar)();
57
- const {
58
- pluginId,
59
- version
60
- } = versionMetadata;
61
- const [hiddenSidebarContainer, setHiddenSidebarContainer] = (0, _react.useState)(false);
62
- const [hiddenSidebar, setHiddenSidebar] = (0, _react.useState)(false);
63
- const toggleSidebar = (0, _react.useCallback)(() => {
64
- if (hiddenSidebar) {
65
- setHiddenSidebar(false);
66
- }
67
-
68
- setHiddenSidebarContainer(value => !value);
69
- }, [hiddenSidebar]);
70
- return <_Layout.default wrapperClassName={_themeCommon.ThemeClassNames.wrapper.docsPages} pageClassName={_themeCommon.ThemeClassNames.page.docsDocPage} searchMetadata={{
71
- version,
72
- tag: (0, _themeCommon.docVersionSearchTag)(pluginId, version)
73
- }}>
74
- <div className={_stylesModule.default.docPage}>
75
- <_BackToTopButton.default />
76
-
77
- {sidebar && <aside className={(0, _clsx.default)(_stylesModule.default.docSidebarContainer, {
78
- [_stylesModule.default.docSidebarContainerHidden]: hiddenSidebarContainer
79
- })} onTransitionEnd={e => {
80
- if (!e.currentTarget.classList.contains(_stylesModule.default.docSidebarContainer)) {
81
- return;
82
- }
83
-
84
- if (hiddenSidebarContainer) {
85
- setHiddenSidebar(true);
86
- }
87
- }}>
88
- <_DocSidebar.default key={// Reset sidebar state on sidebar changes
89
- // See https://github.com/facebook/docusaurus/issues/3414
90
- sidebarName} sidebar={sidebar} path={currentDocRoute.path} onCollapse={toggleSidebar} isHidden={hiddenSidebar} />
91
-
92
- {hiddenSidebar && <div className={_stylesModule.default.collapsedDocSidebar} title={(0, _Translate.translate)({
93
- id: 'theme.docs.sidebar.expandButtonTitle',
94
- message: 'Expand sidebar',
95
- description: 'The ARIA label and title attribute for expand button of doc sidebar'
96
- })} aria-label={(0, _Translate.translate)({
97
- id: 'theme.docs.sidebar.expandButtonAriaLabel',
98
- message: 'Expand sidebar',
99
- description: 'The ARIA label and title attribute for expand button of doc sidebar'
100
- })} tabIndex={0} role="button" onKeyDown={toggleSidebar} onClick={toggleSidebar}>
101
- <_IconArrow.default className={_stylesModule.default.expandSidebarButtonIcon} />
102
- </div>}
103
- </aside>}
104
- <main className={(0, _clsx.default)(_stylesModule.default.docMainContainer, {
105
- [_stylesModule.default.docMainContainerEnhanced]: hiddenSidebarContainer || !sidebar
106
- })}>
107
- <div className={(0, _clsx.default)('container padding-top--md padding-bottom--lg', _stylesModule.default.docItemWrapper, {
108
- [_stylesModule.default.docItemWrapperEnhanced]: hiddenSidebarContainer
109
- })}>
110
- <_react2.MDXProvider components={_MDXComponents.default}>{children}</_react2.MDXProvider>
111
- </div>
112
- </main>
113
- </div>
114
- </_Layout.default>;
115
- }
116
-
117
- function DocPage(props) {
118
- const {
119
- route: {
120
- routes: docRoutes
121
- },
122
- versionMetadata,
123
- location
124
- } = props;
125
- const currentDocRoute = docRoutes.find(docRoute => (0, _router.matchPath)(location.pathname, docRoute));
126
-
127
- if (!currentDocRoute) {
128
- return <_NotFound.default />;
129
- } // For now, the sidebarName is added as route config: not ideal!
130
-
131
-
132
- const sidebarName = currentDocRoute.sidebar;
133
- const sidebar = sidebarName ? versionMetadata.docsSidebars[sidebarName] : null;
134
- return <>
135
- <_Head.default>
136
- {
137
- /* TODO we should add a core addRoute({htmlClassName}) generic plugin option */
138
- }
139
- <html className={versionMetadata.className} />
140
- </_Head.default>
141
- <_themeCommon.DocsVersionProvider version={versionMetadata}>
142
- <_themeCommon.DocsSidebarProvider sidebar={sidebar}>
143
- <DocPageContent currentDocRoute={currentDocRoute} versionMetadata={versionMetadata} sidebarName={sidebarName}>
144
- {(0, _renderRoutes.default)(docRoutes, {
145
- versionMetadata
146
- })}
147
- </DocPageContent>
148
- </_themeCommon.DocsSidebarProvider>
149
- </_themeCommon.DocsVersionProvider>
150
- </>;
151
- }
152
-
153
- var _default = DocPage;
154
- exports.default = _default;
@@ -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,62 +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
- previous,
29
- next
30
- } = props;
31
- return <nav className="pagination-nav docusaurus-mt-lg" aria-label={(0, _Translate.translate)({
32
- id: 'theme.docs.paginator.navAriaLabel',
33
- message: 'Docs pages navigation',
34
- description: 'The ARIA label for the docs pagination'
35
- })}>
36
- <div className="pagination-nav__item">
37
- {previous && <_Link.default className="pagination-nav__link" to={previous.permalink}>
38
- <div className="pagination-nav__sublabel">
39
- <_Translate.default id="theme.docs.paginator.previous" description="The label used to navigate to the previous doc">
40
- Previous
41
- </_Translate.default>
42
- </div>
43
- <div className="pagination-nav__label">
44
- &laquo; {previous.title}
45
- </div>
46
- </_Link.default>}
47
- </div>
48
- <div className="pagination-nav__item pagination-nav__item--next">
49
- {next && <_Link.default className="pagination-nav__link" to={next.permalink}>
50
- <div className="pagination-nav__sublabel">
51
- <_Translate.default id="theme.docs.paginator.next" description="The label used to navigate to the next doc">
52
- Next
53
- </_Translate.default>
54
- </div>
55
- <div className="pagination-nav__label">{next.title} &raquo;</div>
56
- </_Link.default>}
57
- </div>
58
- </nav>;
59
- }
60
-
61
- var _default = DocPaginator;
62
- exports.default = _default;
@@ -1,134 +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 _Logo = _interopRequireDefault(require("@theme/Logo"));
17
-
18
- var _IconArrow = _interopRequireDefault(require("@theme/IconArrow"));
19
-
20
- var _Translate = require("@docusaurus/Translate");
21
-
22
- var _DocSidebarItem = require("@theme/DocSidebarItem");
23
-
24
- var _stylesModule = _interopRequireDefault(require("./styles.module.css"));
25
-
26
- function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
27
-
28
- 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); }
29
-
30
- 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; }
31
-
32
- /**
33
- * Copyright (c) Facebook, Inc. and its affiliates.
34
- *
35
- * This source code is licensed under the MIT license found in the
36
- * LICENSE file in the root directory of this source tree.
37
- */
38
- function useShowAnnouncementBar() {
39
- const {
40
- isActive
41
- } = (0, _themeCommon.useAnnouncementBar)();
42
- const [showAnnouncementBar, setShowAnnouncementBar] = (0, _react.useState)(isActive);
43
- (0, _themeCommon.useScrollPosition)(({
44
- scrollY
45
- }) => {
46
- if (isActive) {
47
- setShowAnnouncementBar(scrollY === 0);
48
- }
49
- }, [isActive]);
50
- return isActive && showAnnouncementBar;
51
- }
52
-
53
- function HideableSidebarButton({
54
- onClick
55
- }) {
56
- return <button type="button" title={(0, _Translate.translate)({
57
- id: 'theme.docs.sidebar.collapseButtonTitle',
58
- message: 'Collapse sidebar',
59
- description: 'The title attribute for collapse button of doc sidebar'
60
- })} aria-label={(0, _Translate.translate)({
61
- id: 'theme.docs.sidebar.collapseButtonAriaLabel',
62
- message: 'Collapse sidebar',
63
- description: 'The title attribute for collapse button of doc sidebar'
64
- })} className={(0, _clsx.default)('button button--secondary button--outline', _stylesModule.default.collapseSidebarButton)} onClick={onClick}>
65
- <_IconArrow.default className={_stylesModule.default.collapseSidebarButtonIcon} />
66
- </button>;
67
- }
68
-
69
- function DocSidebarDesktop({
70
- path,
71
- sidebar,
72
- onCollapse,
73
- isHidden
74
- }) {
75
- const showAnnouncementBar = useShowAnnouncementBar();
76
- const {
77
- navbar: {
78
- hideOnScroll
79
- },
80
- hideableSidebar
81
- } = (0, _themeCommon.useThemeConfig)();
82
- return <div className={(0, _clsx.default)(_stylesModule.default.sidebar, {
83
- [_stylesModule.default.sidebarWithHideableNavbar]: hideOnScroll,
84
- [_stylesModule.default.sidebarHidden]: isHidden
85
- })}>
86
- {hideOnScroll && <_Logo.default tabIndex={-1} className={_stylesModule.default.sidebarLogo} />}
87
- <nav className={(0, _clsx.default)('menu thin-scrollbar', _stylesModule.default.menu, {
88
- [_stylesModule.default.menuWithAnnouncementBar]: showAnnouncementBar
89
- })}>
90
- <ul className={(0, _clsx.default)(_themeCommon.ThemeClassNames.docs.docSidebarMenu, 'menu__list')}>
91
- <_DocSidebarItem.DocSidebarItems items={sidebar} activePath={path} level={1} />
92
- </ul>
93
- </nav>
94
- {hideableSidebar && <HideableSidebarButton onClick={onCollapse} />}
95
- </div>;
96
- } // eslint-disable-next-line react/function-component-definition
97
-
98
-
99
- const DocSidebarMobileSecondaryMenu = ({
100
- toggleSidebar,
101
- sidebar,
102
- path
103
- }) => <ul className={(0, _clsx.default)(_themeCommon.ThemeClassNames.docs.docSidebarMenu, 'menu__list')}>
104
- <_DocSidebarItem.DocSidebarItems items={sidebar} activePath={path} onItemClick={item => {
105
- // Mobile sidebar should only be closed if the category has a link
106
- if (item.type === 'category' && item.href) {
107
- toggleSidebar();
108
- }
109
-
110
- if (item.type === 'link') {
111
- toggleSidebar();
112
- }
113
- }} level={1} />
114
- </ul>;
115
-
116
- function DocSidebarMobile(props) {
117
- return <_themeCommon.MobileSecondaryMenuFiller component={DocSidebarMobileSecondaryMenu} props={props} />;
118
- }
119
-
120
- const DocSidebarDesktopMemo = _react.default.memo(DocSidebarDesktop);
121
-
122
- const DocSidebarMobileMemo = _react.default.memo(DocSidebarMobile);
123
-
124
- function DocSidebar(props) {
125
- const windowSize = (0, _useWindowSize.default)(); // Desktop sidebar visible on hydration: need SSR rendering
126
-
127
- const shouldRenderSidebarDesktop = windowSize === 'desktop' || windowSize === 'ssr'; // Mobile sidebar not visible on hydration: can avoid SSR rendering
128
-
129
- const shouldRenderSidebarMobile = windowSize === 'mobile';
130
- return <>
131
- {shouldRenderSidebarDesktop && <DocSidebarDesktopMemo {...props} />}
132
- {shouldRenderSidebarMobile && <DocSidebarMobileMemo {...props} />}
133
- </>;
134
- }
@@ -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
- }