@redocly/theme 0.1.9 → 0.1.12

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 (259) hide show
  1. package/Button/index.d.ts +1 -1
  2. package/Button/index.js +1 -1
  3. package/CodeBlock/index.d.ts +1 -1
  4. package/CodeBlock/index.js +1 -1
  5. package/CopyButton/index.d.ts +2 -2
  6. package/CopyButton/index.js +2 -2
  7. package/Footer/Footer.d.ts +2 -2
  8. package/Footer/Footer.js +1 -1
  9. package/Footer/FooterColumn.js +6 -6
  10. package/Footer/FooterColumns.d.ts +3 -3
  11. package/Footer/FooterCopyright.d.ts +3 -3
  12. package/Footer/FooterCopyright.js +1 -1
  13. package/Footer/index.d.ts +4 -4
  14. package/Footer/index.js +4 -4
  15. package/Headings/index.d.ts +1 -1
  16. package/Headings/index.js +1 -1
  17. package/JsonViewer/index.d.ts +2 -2
  18. package/JsonViewer/index.js +2 -2
  19. package/Layout/index.d.ts +2 -2
  20. package/Layout/index.js +2 -2
  21. package/Markdown/Admonition.js +4 -4
  22. package/Markdown/CodeSample/index.d.ts +3 -3
  23. package/Markdown/CodeSample/index.js +3 -3
  24. package/Markdown/Heading.js +1 -1
  25. package/Markdown/MarkdownLayout.d.ts +2 -2
  26. package/Markdown/StyledMarkdown.js +2 -2
  27. package/Markdown/Tabs/index.d.ts +2 -2
  28. package/Markdown/Tabs/index.js +2 -2
  29. package/Markdown/index.d.ts +9 -9
  30. package/Markdown/index.js +9 -9
  31. package/Navbar/Navbar.d.ts +0 -1
  32. package/Navbar/Navbar.js +1 -1
  33. package/Navbar/NavbarItem.js +1 -1
  34. package/Navbar/NavbarMenu.js +1 -1
  35. package/Navbar/index.d.ts +3 -0
  36. package/Navbar/index.js +19 -0
  37. package/NavbarLogo/NavbarLogo.d.ts +6 -0
  38. package/{Logo/Logo.js → NavbarLogo/NavbarLogo.js} +8 -5
  39. package/NavbarLogo/index.d.ts +1 -0
  40. package/{Logo → NavbarLogo}/index.js +1 -1
  41. package/OperationBadge/index.d.ts +1 -1
  42. package/OperationBadge/index.js +1 -1
  43. package/PageNavigation/index.d.ts +3 -0
  44. package/PageNavigation/index.js +19 -0
  45. package/Panel/index.d.ts +8 -8
  46. package/Panel/index.js +8 -8
  47. package/REAMDE.md +1 -0
  48. package/SamplesPanelControls/index.d.ts +1 -1
  49. package/SamplesPanelControls/index.js +1 -1
  50. package/Search/Autocomplete.js +1 -1
  51. package/Search/ClearIcon.js +2 -2
  52. package/Search/Input.js +1 -1
  53. package/Search/Parameters.js +2 -2
  54. package/Search/Popover.js +1 -1
  55. package/Search/SearchIcon.js +2 -2
  56. package/Search/SearchItem.js +2 -2
  57. package/Search/index.d.ts +9 -9
  58. package/Search/index.js +9 -9
  59. package/Search/utils.js +1 -1
  60. package/Sidebar/ApiCallItem.js +1 -1
  61. package/Sidebar/BackButton.js +1 -1
  62. package/Sidebar/DrilldownMenuItem.js +3 -3
  63. package/Sidebar/Menu.js +1 -1
  64. package/Sidebar/MenuItemLabel.js +2 -2
  65. package/Sidebar/MenuLink.js +1 -1
  66. package/Sidebar/MobileSidebarButton.js +1 -1
  67. package/Sidebar/Sidebar.js +1 -1
  68. package/Sidebar/index.d.ts +19 -19
  69. package/Sidebar/index.js +19 -19
  70. package/Sidebar/types/index.d.ts +5 -5
  71. package/Sidebar/types/index.js +5 -5
  72. package/SidebarLogo/index.d.ts +1 -1
  73. package/SidebarLogo/index.js +1 -1
  74. package/SourceCode/index.d.ts +1 -1
  75. package/SourceCode/index.js +1 -1
  76. package/TableOfContent/TableOfContent.js +7 -8
  77. package/TableOfContent/index.d.ts +1 -1
  78. package/TableOfContent/index.js +1 -1
  79. package/Tooltip/index.d.ts +1 -1
  80. package/Tooltip/index.js +1 -1
  81. package/globalStyle.d.ts +1 -0
  82. package/globalStyle.js +25 -3
  83. package/hooks/index.d.ts +7 -7
  84. package/hooks/index.js +7 -7
  85. package/hooks/useActiveSectionId.d.ts +2 -2
  86. package/hooks/useActiveSectionId.js +1 -0
  87. package/icons/ShelfIcon/index.d.ts +2 -2
  88. package/icons/ShelfIcon/index.js +1 -1
  89. package/icons/index.d.ts +1 -1
  90. package/icons/index.js +1 -1
  91. package/mocks/Link.js +4 -1
  92. package/mocks/hooks/usePageData.js +4 -1
  93. package/package.json +1 -1
  94. package/src/Button/index.ts +1 -1
  95. package/src/CodeBlock/index.ts +1 -1
  96. package/src/CopyButton/index.ts +2 -2
  97. package/src/Footer/Footer.tsx +5 -8
  98. package/src/Footer/FooterColumn.tsx +7 -7
  99. package/src/Footer/FooterColumns.tsx +3 -1
  100. package/src/Footer/FooterCopyright.tsx +5 -3
  101. package/src/Footer/index.ts +4 -4
  102. package/src/Headings/index.ts +1 -1
  103. package/src/JsonViewer/index.ts +2 -2
  104. package/src/Layout/index.ts +2 -2
  105. package/src/Markdown/Admonition.tsx +15 -15
  106. package/src/Markdown/CodeSample/index.ts +3 -3
  107. package/src/Markdown/Heading.tsx +4 -1
  108. package/src/Markdown/MarkdownLayout.tsx +2 -2
  109. package/src/Markdown/StyledMarkdown.tsx +27 -27
  110. package/src/Markdown/Tabs/index.ts +2 -2
  111. package/src/Markdown/index.ts +9 -9
  112. package/src/Navbar/Navbar.tsx +2 -3
  113. package/src/Navbar/NavbarItem.tsx +1 -1
  114. package/src/Navbar/NavbarMenu.tsx +1 -1
  115. package/src/Navbar/index.ts +3 -0
  116. package/src/NavbarLogo/NavbarLogo.tsx +24 -0
  117. package/src/NavbarLogo/index.ts +1 -0
  118. package/src/OperationBadge/index.ts +1 -1
  119. package/src/PageNavigation/index.ts +3 -0
  120. package/src/Panel/index.ts +8 -8
  121. package/src/SamplesPanelControls/index.ts +1 -1
  122. package/src/Search/Autocomplete.tsx +1 -1
  123. package/src/Search/ClearIcon.tsx +12 -13
  124. package/src/Search/Input.tsx +7 -7
  125. package/src/Search/Parameters.tsx +2 -2
  126. package/src/Search/Popover.tsx +2 -2
  127. package/src/Search/SearchIcon.tsx +12 -13
  128. package/src/Search/SearchItem.tsx +2 -2
  129. package/src/Search/index.ts +9 -9
  130. package/src/Search/utils.tsx +1 -1
  131. package/src/Sidebar/ApiCallItem.tsx +1 -2
  132. package/src/Sidebar/BackButton.tsx +2 -2
  133. package/src/Sidebar/DrilldownMenuItem.tsx +4 -4
  134. package/src/Sidebar/Menu.tsx +1 -1
  135. package/src/Sidebar/MenuItemLabel.tsx +4 -4
  136. package/src/Sidebar/MenuLink.tsx +1 -1
  137. package/src/Sidebar/MobileSidebarButton.tsx +2 -2
  138. package/src/Sidebar/Sidebar.tsx +1 -1
  139. package/src/Sidebar/index.ts +19 -19
  140. package/src/Sidebar/types/index.ts +5 -5
  141. package/src/SidebarLogo/index.ts +1 -1
  142. package/src/SourceCode/index.ts +1 -1
  143. package/src/TableOfContent/TableOfContent.tsx +12 -10
  144. package/src/TableOfContent/index.ts +1 -1
  145. package/src/Tooltip/index.ts +1 -1
  146. package/src/globalStyle.ts +793 -441
  147. package/src/hooks/index.ts +7 -7
  148. package/src/hooks/useActiveSectionId.ts +3 -3
  149. package/src/icons/ShelfIcon/index.ts +2 -2
  150. package/src/icons/index.ts +1 -1
  151. package/src/mocks/Link.tsx +5 -2
  152. package/src/mocks/hooks/usePageData.ts +4 -1
  153. package/src/types/portal/index.d.ts +0 -1
  154. package/src/types/portal/src/client/app/Sidebar/types.d.ts +32 -41
  155. package/src/types/portal/src/client/app/media-css.d.ts +4 -4
  156. package/src/types/portal/src/client/styling/default.d.ts +585 -391
  157. package/src/types/portal/src/client/styling/index.d.ts +2 -6
  158. package/src/types/portal/src/server/constants.d.ts +5 -9
  159. package/src/types/portal/src/server/plugins/markdown/types.d.ts +14 -19
  160. package/src/types/portal/src/server/plugins/portal-config/types.d.ts +12 -12
  161. package/src/types/portal/src/server/plugins/types.d.ts +55 -0
  162. package/src/types/portal/src/server/store.d.ts +49 -97
  163. package/src/types/portal/src/server/utils/async.d.ts +1 -5
  164. package/src/types/portal/src/server/utils/content-provider.d.ts +51 -0
  165. package/src/types/portal/src/server/utils/index.d.ts +1 -1
  166. package/src/types/portal/src/server/utils/paths.d.ts +10 -13
  167. package/src/types/portal/src/server/utils/reporter/formatter.d.ts +8 -8
  168. package/src/types/portal/src/server/utils/reporter/reporter.d.ts +15 -15
  169. package/src/types/portal/src/server/version-store.d.ts +35 -0
  170. package/src/types/portal/src/shared/constants.d.ts +6 -6
  171. package/src/types/portal/src/shared/types.d.ts +97 -58
  172. package/src/types/portal/src/shared/urls.d.ts +2 -1
  173. package/src/ui/AlertIcon.tsx +8 -7
  174. package/src/ui/Background.tsx +3 -3
  175. package/src/ui/Dropdown.tsx +4 -4
  176. package/src/ui/Jumbotron.tsx +3 -3
  177. package/src/ui/Tiles/TileHeader.ts +1 -1
  178. package/src/ui/Tiles/TileText.tsx +2 -2
  179. package/src/ui/Tiles/index.ts +4 -4
  180. package/src/ui/Typography.tsx +27 -27
  181. package/src/ui/UniversalLink.tsx +3 -8
  182. package/src/utils/isUrl.ts +4 -4
  183. package/ui/AlertIcon.d.ts +3 -2
  184. package/ui/AlertIcon.js +2 -2
  185. package/ui/Background.js +1 -1
  186. package/ui/Dropdown.js +3 -3
  187. package/ui/Jumbotron.js +3 -3
  188. package/ui/Tiles/TileHeader.js +1 -1
  189. package/ui/Tiles/TileText.js +1 -1
  190. package/ui/Tiles/index.d.ts +4 -4
  191. package/ui/Tiles/index.js +4 -4
  192. package/ui/Typography.js +23 -23
  193. package/ui/UniversalLink.js +1 -5
  194. package/utils/isUrl.d.ts +2 -2
  195. package/utils/isUrl.js +4 -4
  196. package/Logo/Logo.d.ts +0 -5
  197. package/Logo/index.d.ts +0 -1
  198. package/src/Button/Button.stories.tsx +0 -74
  199. package/src/Button/__tests__/Button.test.tsx +0 -42
  200. package/src/Button/__tests__/__snapshots__/Button.test.tsx.snap +0 -274
  201. package/src/CodeBlock/__tests__/CodeBlock.test.tsx +0 -12
  202. package/src/CodeBlock/__tests__/__snapshots__/CodeBlock.test.tsx.snap +0 -140
  203. package/src/CopyButton/CopyButton.stories.tsx +0 -18
  204. package/src/CopyButton/__tests__/CopyButton.test.tsx +0 -35
  205. package/src/CopyButton/__tests__/CopyButtonWrapper.test.tsx +0 -17
  206. package/src/CopyButton/__tests__/__snapshots__/CopyButton.test.tsx.snap +0 -55
  207. package/src/CopyButton/__tests__/__snapshots__/CopyButtonWrapper.test.tsx.snap +0 -46
  208. package/src/Headings/Headings.stories.tsx +0 -36
  209. package/src/Headings/__tests__/Headings.test.tsx +0 -24
  210. package/src/Headings/__tests__/__snapshots__/Headings.test.tsx.snap +0 -57
  211. package/src/Introduction.stories.mdx +0 -7
  212. package/src/JsonViewer/JsonViewer.stories.tsx +0 -57
  213. package/src/JsonViewer/__tests__/JsonViewer.test.tsx +0 -83
  214. package/src/JsonViewer/__tests__/__snapshots__/JsonViewer.test.tsx.snap +0 -2728
  215. package/src/Logo/Logo.tsx +0 -17
  216. package/src/Logo/index.ts +0 -1
  217. package/src/Navbar/Navbar.stories.tsx +0 -28
  218. package/src/OperationBadge/OperationBadge.stories.tsx +0 -35
  219. package/src/OperationBadge/__tests__/OperationBadge.test.tsx +0 -59
  220. package/src/OperationBadge/__tests__/__snapshots__/OperationBadge.test.tsx.snap +0 -651
  221. package/src/Panel/CodePanel.stories.tsx +0 -26
  222. package/src/Panel/ContentPanel.stories.tsx +0 -26
  223. package/src/Panel/Panel.stories.tsx +0 -56
  224. package/src/Panel/__tests__/CodePanel.test.tsx +0 -26
  225. package/src/Panel/__tests__/ContentPanel.test.tsx +0 -26
  226. package/src/Panel/__tests__/Panel.test.tsx +0 -53
  227. package/src/Panel/__tests__/__snapshots__/CodePanel.test.tsx.snap +0 -258
  228. package/src/Panel/__tests__/__snapshots__/ContentPanel.test.tsx.snap +0 -278
  229. package/src/Panel/__tests__/__snapshots__/Panel.test.tsx.snap +0 -398
  230. package/src/SamplesPanelControls/SamplesControlButton.stories.tsx +0 -18
  231. package/src/SamplesPanelControls/__tests__/SamplesPanelControls.test.tsx +0 -36
  232. package/src/SamplesPanelControls/__tests__/__snapshots__/SamplesPanelControls.test.tsx.snap +0 -228
  233. package/src/SidebarLogo/SidebarLogo.stories.tsx +0 -21
  234. package/src/SidebarLogo/__tests__/SidebarLogo.test.tsx +0 -32
  235. package/src/SidebarLogo/__tests__/__snapshots__/SidebarLogo.test.tsx.snap +0 -62
  236. package/src/SourceCode/SourceCode.stories.tsx +0 -29
  237. package/src/SourceCode/__tests__/SourceCode.test.tsx +0 -48
  238. package/src/SourceCode/__tests__/__snapshots__/SourceCode.test.tsx.snap +0 -786
  239. package/src/TableOfContent/TableOfContent.stories.tsx +0 -39
  240. package/src/Tooltip/Tooltip.stories.tsx +0 -27
  241. package/src/Tooltip/__tests__/Tooltip.test.tsx +0 -41
  242. package/src/Tooltip/__tests__/__snapshots__/Tooltip.test.tsx.snap +0 -83
  243. package/src/icons/ShelfIcon/ShelfIcon.stories.tsx +0 -36
  244. package/src/icons/ShelfIcon/__tests__/ShelfIcon.test.tsx +0 -54
  245. package/src/icons/ShelfIcon/__tests__/__snapshots__/ShelfIcon.test.tsx.snap +0 -235
  246. package/src/types/portal/src/server/plugins/nav-utils.d.ts +0 -19
  247. package/src/types/portal/src/server/plugins/sidebars/index.d.ts +0 -16
  248. package/src/types/portal/src/server/plugins/versions/index.d.ts +0 -15
  249. package/src/types/portal/src/server/plugins/versions/types.d.ts +0 -23
  250. package/src/types/portal/src/server/plugins/versions/utils.d.ts +0 -10
  251. package/src/types/portal/src/server/utils/watcher.d.ts +0 -16
  252. package/src/utils/__tests__/ClipboardService.test.ts +0 -24
  253. package/src/utils/__tests__/__snapshots__/highlight.test.ts.snap +0 -5
  254. package/src/utils/__tests__/__snapshots__/jsonToHtml.test.ts.snap +0 -5
  255. package/src/utils/__tests__/css-variables.test.ts +0 -20
  256. package/src/utils/__tests__/highlight.test.ts +0 -51
  257. package/src/utils/__tests__/jsonToHtml.test.ts +0 -40
  258. package/src/utils/__tests__/media-css.test.ts +0 -20
  259. package/src/utils/__tests__/theme-helpers.test.ts +0 -25
@@ -1,7 +1,7 @@
1
- export * from './useControl';
2
- export * from './useMount';
3
- export * from './useUnmount';
4
- export * from './useActiveHeading';
5
- export * from './useActiveSectionId';
6
- export * from './useFullHeight';
7
- export * from './useNavbarHeight';
1
+ export * from '@theme/hooks/useControl';
2
+ export * from '@theme/hooks/useMount';
3
+ export * from '@theme/hooks/useUnmount';
4
+ export * from '@theme/hooks/useActiveHeading';
5
+ export * from '@theme/hooks/useActiveSectionId';
6
+ export * from '@theme/hooks/useFullHeight';
7
+ export * from '@theme/hooks/useNavbarHeight';
@@ -1,14 +1,14 @@
1
+ import { Location } from 'history';
1
2
  import { useEffect, useState, useMemo } from 'react';
2
3
  import throttle from 'lodash.throttle';
3
4
 
4
5
  import { useNavbarHeight } from '@theme/hooks/useNavbarHeight';
5
- import type { MenuProps } from '@theme/types/portal';
6
6
 
7
7
  export type UseActiveSectionIdReturnType = string;
8
8
 
9
9
  export function useActiveSectionId(
10
- location: MenuProps['location'],
11
- hasOverviewPage: boolean,
10
+ location: Location,
11
+ hasOverviewPage = false,
12
12
  ): UseActiveSectionIdReturnType {
13
13
  const [itemId, setItemId] = useState<string>('');
14
14
  const navbarHeight = useNavbarHeight(location);
@@ -1,2 +1,2 @@
1
- export { ShelfIcon } from './ShelfIcon';
2
- export type { ShelfIconProps } from './ShelfIcon';
1
+ export { ShelfIcon } from '@theme/icons/ShelfIcon/ShelfIcon';
2
+ export type { ShelfIconProps } from '@theme/icons/ShelfIcon/ShelfIcon';
@@ -1 +1 @@
1
- export * from './ShelfIcon';
1
+ export * from '@theme/icons/ShelfIcon';
@@ -1,7 +1,10 @@
1
- import * as React from 'react';
1
+ import React from 'react';
2
+ import { omit } from 'lodash';
2
3
 
3
4
  // TODO: use real typings here
4
5
  // eslint-disable-next-line @typescript-eslint/explicit-module-boundary-types
5
6
  export function Link(props: any): JSX.Element {
6
- return <a href={props.to} {...props} />;
7
+ // We omit "active" property to avoid "Warning: Received `false` for a non-boolean attribute `active`."
8
+ const filteredProps = omit(props, ['active', 'httpVerb', 'hasActiveSubItem']);
9
+ return <a href={filteredProps.to} {...filteredProps} />;
7
10
  }
@@ -4,5 +4,8 @@ export function usePageData(): {
4
4
  prevPage: ResolvedNavLinkItem | null;
5
5
  nextPage: ResolvedNavLinkItem | null;
6
6
  } {
7
- return { prevPage: null, nextPage: null };
7
+ return {
8
+ prevPage: { label: 'Intro', type: 'link', link: '#prev' },
9
+ nextPage: { label: 'FAQ', type: 'link', link: '#next' },
10
+ };
8
11
  }
@@ -2,5 +2,4 @@ export * from './src/client/styling';
2
2
  export * from './src/client/app/Sidebar/types';
3
3
  export * from './src/server/plugins/portal-config/types';
4
4
  export * from './src/shared/types';
5
- export * from './src/server/plugins/versions/types';
6
5
  export type { MdHeading } from './src/server/plugins/markdown/types';
@@ -1,50 +1,41 @@
1
- import { Location } from 'history';
2
1
  import { MenuStyle } from '../../../shared/types';
3
- import type { Version } from '../../../server/plugins/versions/types';
4
2
  export interface SidebarNavItem {
5
- label?: string;
6
- sublabel?: string;
7
- icon?: string;
8
- link?: string;
9
- type?: string;
10
- httpVerb?: string;
11
- expanded?: string;
12
- selectFirstItemOnExpand?: boolean;
13
- pageId?: string;
14
- redocPrevLink?: string;
15
- redocPrevLabel?: string;
16
- redocNextLink?: string;
17
- redocNextLabel?: string;
18
- redocFakePage?: boolean;
19
- redocInfoPageId?: string;
20
- target?: string;
21
- external?: boolean;
22
- items?: SidebarNavItem[];
23
- permission?: string;
24
- menuStyle?: MenuStyle;
25
- separatorLine?: boolean;
26
- version?: string;
27
- default?: boolean;
3
+ label?: string;
4
+ sublabel?: string;
5
+ icon?: string;
6
+ link?: string;
7
+ type?: string;
8
+ httpVerb?: string;
9
+ expanded?: string;
10
+ selectFirstItemOnExpand?: boolean;
11
+ pageId?: string;
12
+ redocPrevLink?: string;
13
+ redocPrevLabel?: string;
14
+ redocNextLink?: string;
15
+ redocNextLabel?: string;
16
+ redocFakePage?: boolean;
17
+ redocInfoPageId?: string;
18
+ target?: string;
19
+ external?: boolean;
20
+ items?: SidebarNavItem[];
21
+ permission?: string;
22
+ menuStyle?: MenuStyle;
23
+ separatorLine?: boolean;
24
+ version?: string;
28
25
  }
29
26
  export interface ItemState extends SidebarNavItem {
30
- items: ItemState[];
31
- active: boolean;
32
- hasActiveSubItem: boolean;
33
- menuStyle?: MenuStyle | null;
34
- }
35
- export interface MenuProps {
36
- items: SidebarNavItem[];
37
- location: Location;
38
- pageId: string;
39
- versions?: Version[];
27
+ items: ItemState[];
28
+ active: boolean;
29
+ hasActiveSubItem: boolean;
30
+ menuStyle?: MenuStyle | null;
40
31
  }
41
32
  export declare enum MenuType {
42
- Separator = 'separator',
43
- DrillDown = 'drilldown',
44
- Group = 'group',
45
- Operation = 'operation',
33
+ Separator = "separator",
34
+ DrillDown = "drilldown",
35
+ Group = "group",
36
+ Operation = "operation"
46
37
  }
47
38
  export interface MenuItemProps {
48
- item: ItemState;
49
- activeItem?: ItemState;
39
+ item: ItemState;
40
+ activeItem?: ItemState;
50
41
  }
@@ -1,7 +1,7 @@
1
1
  export declare const breakpoints: {
2
- small: string;
3
- medium: string;
4
- large: string;
2
+ small: string;
3
+ medium: string;
4
+ large: string;
5
5
  };
6
- export declare const mediaQueries: import('@theme/utils/media-css').MediaQueries;
6
+ export declare const mediaQueries: import("@theme/utils/media-css").MediaQueries;
7
7
  export type { MediaQueries } from '@theme/utils/media-css';