@jpmorganchase/mosaic-layouts 0.1.0-beta.10

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 (206) hide show
  1. package/.turbo/turbo-build.log +4 -0
  2. package/CHANGELOG.md +22 -0
  3. package/README.md +39 -0
  4. package/dist/Fade.d.ts +11 -0
  5. package/dist/Fade.js +1 -0
  6. package/dist/LayoutBase/index.css +1 -0
  7. package/dist/LayoutBase/index.d.ts +6 -0
  8. package/dist/LayoutBase/index.js +1 -0
  9. package/dist/LayoutBase/styles.css.css +1 -0
  10. package/dist/LayoutBase/styles.css.d.ts +8 -0
  11. package/dist/LayoutBase/styles.css.js +1 -0
  12. package/dist/LayoutColumns/index.css +1 -0
  13. package/dist/LayoutColumns/index.d.ts +7 -0
  14. package/dist/LayoutColumns/index.js +1 -0
  15. package/dist/LayoutColumns/styles.css.css +1 -0
  16. package/dist/LayoutColumns/styles.css.d.ts +9 -0
  17. package/dist/LayoutColumns/styles.css.js +1 -0
  18. package/dist/LayoutConfigProvider/index.d.ts +6 -0
  19. package/dist/LayoutConfigProvider/index.js +1 -0
  20. package/dist/LayoutFullWidth/index.css +1 -0
  21. package/dist/LayoutFullWidth/index.d.ts +7 -0
  22. package/dist/LayoutFullWidth/index.js +1 -0
  23. package/dist/LayoutFullWidth/styles.css.css +1 -0
  24. package/dist/LayoutFullWidth/styles.css.d.ts +4 -0
  25. package/dist/LayoutFullWidth/styles.css.js +1 -0
  26. package/dist/LayoutProvider.css +1 -0
  27. package/dist/LayoutProvider.d.ts +10 -0
  28. package/dist/LayoutProvider.js +1 -0
  29. package/dist/Sidebars/Drawer.css +1 -0
  30. package/dist/Sidebars/Drawer.d.ts +5 -0
  31. package/dist/Sidebars/Drawer.js +1 -0
  32. package/dist/Sidebars/SidebarLeft.css +1 -0
  33. package/dist/Sidebars/SidebarLeft.d.ts +5 -0
  34. package/dist/Sidebars/SidebarLeft.js +1 -0
  35. package/dist/Sidebars/SidebarRight.css +1 -0
  36. package/dist/Sidebars/SidebarRight.d.ts +5 -0
  37. package/dist/Sidebars/SidebarRight.js +1 -0
  38. package/dist/Sidebars/index.css +1 -0
  39. package/dist/Sidebars/index.d.ts +2 -0
  40. package/dist/Sidebars/index.js +1 -0
  41. package/dist/Sidebars/styles.css.css +1 -0
  42. package/dist/Sidebars/styles.css.d.ts +13 -0
  43. package/dist/Sidebars/styles.css.js +1 -0
  44. package/dist/chunk-25KPR4KC.js +1 -0
  45. package/dist/chunk-36VRRJYH.js +1 -0
  46. package/dist/chunk-475WQFFV.js +0 -0
  47. package/dist/chunk-4Z46UYNW.js +1 -0
  48. package/dist/chunk-53T3BYR6.js +1 -0
  49. package/dist/chunk-5HRFKBMO.js +1 -0
  50. package/dist/chunk-6TKQWZGT.js +1 -0
  51. package/dist/chunk-77TJQXKX.js +1 -0
  52. package/dist/chunk-ASVIILPC.js +1 -0
  53. package/dist/chunk-BKZGSG52.js +1 -0
  54. package/dist/chunk-DE36TWIF.js +1 -0
  55. package/dist/chunk-DTW4UURD.js +1 -0
  56. package/dist/chunk-E6MQWWR2.js +1 -0
  57. package/dist/chunk-FEIY7W7S.js +1 -0
  58. package/dist/chunk-FVHDTNGX.js +1 -0
  59. package/dist/chunk-G5JIKQRF.js +1 -0
  60. package/dist/chunk-GAMD2B7L.js +1 -0
  61. package/dist/chunk-GVN4L242.js +1 -0
  62. package/dist/chunk-HTHD7YMF.js +1 -0
  63. package/dist/chunk-JATFIZBE.js +1 -0
  64. package/dist/chunk-KER5XROW.js +1 -0
  65. package/dist/chunk-KZ6ZH4EY.js +1 -0
  66. package/dist/chunk-LAW2KABC.js +1 -0
  67. package/dist/chunk-NDZQ5OZP.js +0 -0
  68. package/dist/chunk-OMED577C.js +1 -0
  69. package/dist/chunk-OOBVDA2T.js +1 -0
  70. package/dist/chunk-PHW5SXKA.js +1 -0
  71. package/dist/chunk-PKAR7XZI.js +0 -0
  72. package/dist/chunk-Q3Z3PB5J.js +1 -0
  73. package/dist/chunk-RWWDUWAZ.js +1 -0
  74. package/dist/chunk-S2SS5ZQ2.js +1 -0
  75. package/dist/chunk-S7HNXMC4.js +1 -0
  76. package/dist/chunk-T5JOF44G.js +1 -0
  77. package/dist/chunk-WNZGJWRV.js +1 -0
  78. package/dist/chunk-X52NEVFW.js +1 -0
  79. package/dist/chunk-YA5BIJYR.js +1 -0
  80. package/dist/chunk-Z4UFTC3H.js +1 -0
  81. package/dist/chunk-ZUEPDUKR.js +1 -0
  82. package/dist/chunk-ZUHN4T3Z.js +1 -0
  83. package/dist/hooks/useIsLoading.d.ts +6 -0
  84. package/dist/hooks/useIsLoading.js +1 -0
  85. package/dist/index.css +1 -0
  86. package/dist/index.d.ts +8 -0
  87. package/dist/index.js +1 -0
  88. package/dist/layouts/App/index.css +1 -0
  89. package/dist/layouts/App/index.d.ts +3 -0
  90. package/dist/layouts/App/index.js +1 -0
  91. package/dist/layouts/App/styles.css.css +1 -0
  92. package/dist/layouts/App/styles.css.d.ts +4 -0
  93. package/dist/layouts/App/styles.css.js +1 -0
  94. package/dist/layouts/Detail/DetailContentOnly.css +1 -0
  95. package/dist/layouts/Detail/DetailContentOnly.d.ts +3 -0
  96. package/dist/layouts/Detail/DetailContentOnly.js +1 -0
  97. package/dist/layouts/Detail/DetailHighlight.css +1 -0
  98. package/dist/layouts/Detail/DetailHighlight.d.ts +3 -0
  99. package/dist/layouts/Detail/DetailHighlight.js +1 -0
  100. package/dist/layouts/Detail/DetailOverview.css +1 -0
  101. package/dist/layouts/Detail/DetailOverview.d.ts +3 -0
  102. package/dist/layouts/Detail/DetailOverview.js +1 -0
  103. package/dist/layouts/Detail/DetailTechnical.css +1 -0
  104. package/dist/layouts/Detail/DetailTechnical.d.ts +3 -0
  105. package/dist/layouts/Detail/DetailTechnical.js +1 -0
  106. package/dist/layouts/Detail/index.css +1 -0
  107. package/dist/layouts/Detail/index.d.ts +4 -0
  108. package/dist/layouts/Detail/index.js +1 -0
  109. package/dist/layouts/Detail/styles.css.css +1 -0
  110. package/dist/layouts/Detail/styles.css.d.ts +4 -0
  111. package/dist/layouts/Detail/styles.css.js +1 -0
  112. package/dist/layouts/Edit/index.css +1 -0
  113. package/dist/layouts/Edit/index.d.ts +3 -0
  114. package/dist/layouts/Edit/index.js +1 -0
  115. package/dist/layouts/Edit/styles.css.css +1 -0
  116. package/dist/layouts/Edit/styles.css.d.ts +5 -0
  117. package/dist/layouts/Edit/styles.css.js +1 -0
  118. package/dist/layouts/FullWidth/index.css +1 -0
  119. package/dist/layouts/FullWidth/index.d.ts +3 -0
  120. package/dist/layouts/FullWidth/index.js +1 -0
  121. package/dist/layouts/Landing/index.css +1 -0
  122. package/dist/layouts/Landing/index.d.ts +3 -0
  123. package/dist/layouts/Landing/index.js +1 -0
  124. package/dist/layouts/Newsletter/index.css +1 -0
  125. package/dist/layouts/Newsletter/index.d.ts +5 -0
  126. package/dist/layouts/Newsletter/index.js +1 -0
  127. package/dist/layouts/Product/ProductDiscover.css +1 -0
  128. package/dist/layouts/Product/ProductDiscover.d.ts +3 -0
  129. package/dist/layouts/Product/ProductDiscover.js +1 -0
  130. package/dist/layouts/Product/ProductPreview.css +1 -0
  131. package/dist/layouts/Product/ProductPreview.d.ts +3 -0
  132. package/dist/layouts/Product/ProductPreview.js +1 -0
  133. package/dist/layouts/Product/index.css +1 -0
  134. package/dist/layouts/Product/index.d.ts +2 -0
  135. package/dist/layouts/Product/index.js +1 -0
  136. package/dist/layouts/PythonDoc/index.css +1 -0
  137. package/dist/layouts/PythonDoc/index.d.ts +3 -0
  138. package/dist/layouts/PythonDoc/index.js +1 -0
  139. package/dist/layouts/PythonDoc/styles.css.css +1 -0
  140. package/dist/layouts/PythonDoc/styles.css.d.ts +12 -0
  141. package/dist/layouts/PythonDoc/styles.css.js +1 -0
  142. package/dist/layouts/TypeDoc/ExportsSidebar/index.css +1 -0
  143. package/dist/layouts/TypeDoc/ExportsSidebar/index.d.ts +9 -0
  144. package/dist/layouts/TypeDoc/ExportsSidebar/index.js +1 -0
  145. package/dist/layouts/TypeDoc/ExportsSidebar/styles.css.css +1 -0
  146. package/dist/layouts/TypeDoc/ExportsSidebar/styles.css.d.ts +6 -0
  147. package/dist/layouts/TypeDoc/ExportsSidebar/styles.css.js +1 -0
  148. package/dist/layouts/TypeDoc/index.css +1 -0
  149. package/dist/layouts/TypeDoc/index.d.ts +3 -0
  150. package/dist/layouts/TypeDoc/index.js +1 -0
  151. package/dist/layouts/TypeDoc/styles.css.css +1 -0
  152. package/dist/layouts/TypeDoc/styles.css.d.ts +7 -0
  153. package/dist/layouts/TypeDoc/styles.css.js +1 -0
  154. package/dist/layouts/index.css +1 -0
  155. package/dist/layouts/index.d.ts +9 -0
  156. package/dist/layouts/index.js +1 -0
  157. package/dist/types/index.d.ts +34 -0
  158. package/dist/types/index.js +0 -0
  159. package/package.json +42 -0
  160. package/src/Fade.tsx +48 -0
  161. package/src/LayoutBase/index.tsx +35 -0
  162. package/src/LayoutBase/styles.css.ts +73 -0
  163. package/src/LayoutColumns/index.tsx +36 -0
  164. package/src/LayoutColumns/styles.css.ts +64 -0
  165. package/src/LayoutConfigProvider/index.tsx +22 -0
  166. package/src/LayoutFullWidth/index.tsx +21 -0
  167. package/src/LayoutFullWidth/styles.css.ts +17 -0
  168. package/src/LayoutProvider.tsx +35 -0
  169. package/src/Sidebars/Drawer.tsx +66 -0
  170. package/src/Sidebars/SidebarLeft.tsx +15 -0
  171. package/src/Sidebars/SidebarRight.tsx +13 -0
  172. package/src/Sidebars/index.tsx +2 -0
  173. package/src/Sidebars/styles.css.ts +101 -0
  174. package/src/hooks/useIsLoading.ts +75 -0
  175. package/src/index.ts +9 -0
  176. package/src/layouts/App/index.tsx +12 -0
  177. package/src/layouts/App/styles.css.ts +23 -0
  178. package/src/layouts/Detail/DetailContentOnly.tsx +15 -0
  179. package/src/layouts/Detail/DetailHighlight.tsx +24 -0
  180. package/src/layouts/Detail/DetailOverview.tsx +47 -0
  181. package/src/layouts/Detail/DetailTechnical.tsx +53 -0
  182. package/src/layouts/Detail/index.tsx +4 -0
  183. package/src/layouts/Detail/styles.css.ts +5 -0
  184. package/src/layouts/Edit/index.tsx +35 -0
  185. package/src/layouts/Edit/styles.css.ts +23 -0
  186. package/src/layouts/FullWidth/index.tsx +12 -0
  187. package/src/layouts/Landing/index.tsx +12 -0
  188. package/src/layouts/Newsletter/index.tsx +29 -0
  189. package/src/layouts/Product/ProductDiscover.tsx +15 -0
  190. package/src/layouts/Product/ProductPreview.tsx +12 -0
  191. package/src/layouts/Product/index.tsx +2 -0
  192. package/src/layouts/PythonDoc/index.tsx +86 -0
  193. package/src/layouts/PythonDoc/styles.css.ts +67 -0
  194. package/src/layouts/TypeDoc/ExportsSidebar/index.tsx +36 -0
  195. package/src/layouts/TypeDoc/ExportsSidebar/styles.css.ts +44 -0
  196. package/src/layouts/TypeDoc/icons.css +944 -0
  197. package/src/layouts/TypeDoc/icons.png +0 -0
  198. package/src/layouts/TypeDoc/icons@2x.png +0 -0
  199. package/src/layouts/TypeDoc/index.tsx +80 -0
  200. package/src/layouts/TypeDoc/style.css +689 -0
  201. package/src/layouts/TypeDoc/styles.css.ts +41 -0
  202. package/src/layouts/TypeDoc/widgets.png +0 -0
  203. package/src/layouts/TypeDoc/widgets@2x.png +0 -0
  204. package/src/layouts/index.ts +9 -0
  205. package/src/types/index.tsx +28 -0
  206. package/tsconfig.json +8 -0
Binary file
Binary file
@@ -0,0 +1,80 @@
1
+ import React from 'react';
2
+ import classnames from 'classnames';
3
+ import { HelpLinks, Hero } from '@jpmorganchase/mosaic-components';
4
+ import {
5
+ AppHeader,
6
+ BackLink,
7
+ Breadcrumbs,
8
+ Footer,
9
+ VerticalNavigation
10
+ } from '@jpmorganchase/mosaic-site-components';
11
+
12
+ import { LayoutBase } from '../../LayoutBase';
13
+ import { LayoutColumns } from '../../LayoutColumns';
14
+ import type { LayoutProps } from '../../types';
15
+ import styles from './styles.css';
16
+ import { ExportsSidebar } from './ExportsSidebar';
17
+
18
+ const APIHero = ({ description, name, pageType, releaseDate, title, version }) => (
19
+ <Hero
20
+ datestamp={releaseDate}
21
+ datestampLabel="Release Date"
22
+ description={description}
23
+ eyebrow={pageType === 'root' ? `Version ${version}` : `${name} - v${version}`}
24
+ title={pageType === 'root' ? name : title}
25
+ />
26
+ );
27
+
28
+ export const TypeDoc: React.FC<LayoutProps> = ({
29
+ BackLinkProps,
30
+ SidebarProps,
31
+ FooterProps,
32
+ meta,
33
+ children
34
+ }) => {
35
+ const Sidebar = (
36
+ <>
37
+ {BackLinkProps && (
38
+ <header className={styles.sidebarHeader}>
39
+ <BackLink {...BackLinkProps} />
40
+ </header>
41
+ )}
42
+ <VerticalNavigation />
43
+ {SidebarProps?.helpLinks && <HelpLinks subTitle="Need help?" {...SidebarProps.helpLinks} />}
44
+ </>
45
+ );
46
+ const showHero = meta?.data?.pageType === 'root' || meta?.data?.pageType === 'index';
47
+ const SecondarySidebar = meta?.data?.sidebarNavOptions ? (
48
+ <ExportsSidebar items={meta.data.sidebarNavOptions} />
49
+ ) : null;
50
+ return (
51
+ <LayoutBase Header={<AppHeader />}>
52
+ <LayoutColumns
53
+ PrimarySidebar={Sidebar}
54
+ SecondarySidebar={SecondarySidebar}
55
+ Footer={<Footer {...FooterProps} />}
56
+ >
57
+ <div
58
+ className={classnames('typedoc', {
59
+ 'typedoc-index': showHero
60
+ })}
61
+ >
62
+ <Breadcrumbs />
63
+ {showHero && meta?.data ? (
64
+ <APIHero
65
+ description={
66
+ meta.data.api?.description ? `Changelog: ${meta.data.api.description}` : undefined
67
+ }
68
+ name={meta.data.api?.name}
69
+ pageType={meta.data.pageType}
70
+ releaseDate={meta.data.api?.releaseDate}
71
+ title={meta.data.title}
72
+ version={meta.data.api?.version}
73
+ />
74
+ ) : null}
75
+ {children}
76
+ </div>
77
+ </LayoutColumns>
78
+ </LayoutBase>
79
+ );
80
+ };