@stoplight/elements-core 9.0.15-beta-0.3 → 9.0.16-beta-0.1

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 (416) hide show
  1. package/.storybook/main.js +6 -0
  2. package/.storybook/manager.js +1 -0
  3. package/.storybook/preview.jsx +50 -0
  4. package/dist/LICENSE +190 -0
  5. package/dist/README.md +1 -0
  6. package/{index.esm.js → dist/index.esm.js} +7 -13
  7. package/{index.js → dist/index.js} +7 -13
  8. package/{index.mjs → dist/index.mjs} +7 -13
  9. package/dist/package.json +64 -0
  10. package/dist/styles.min.css +1 -0
  11. package/jest.config.js +10 -0
  12. package/package.json +74 -14
  13. package/src/__fixtures__/articles/basic.md +10 -0
  14. package/src/__fixtures__/articles/kitchen-sink.md +318 -0
  15. package/src/__fixtures__/articles/long-page-heading.md +955 -0
  16. package/src/__fixtures__/articles/multiple-try-its.md +54 -0
  17. package/src/__fixtures__/articles/schema-with-refs.ts +82 -0
  18. package/src/__fixtures__/http-request.json +11 -0
  19. package/src/__fixtures__/models/model-with-no-examples.json +15 -0
  20. package/src/__fixtures__/models/model-with-one-example.json +23 -0
  21. package/src/__fixtures__/models/model-with-three-examples.json +35 -0
  22. package/src/__fixtures__/operations/application-octet-stream-post.ts +39 -0
  23. package/src/__fixtures__/operations/base64-file-upload.ts +43 -0
  24. package/src/__fixtures__/operations/big-response.ts +4690 -0
  25. package/src/__fixtures__/operations/bundled-parameter.ts +128 -0
  26. package/src/__fixtures__/operations/empty-response.ts +15 -0
  27. package/src/__fixtures__/operations/examples-request-body.ts +135 -0
  28. package/src/__fixtures__/operations/head-todos.ts +49 -0
  29. package/src/__fixtures__/operations/invalid-response-example.ts +45 -0
  30. package/src/__fixtures__/operations/multipart-formdata-post.ts +61 -0
  31. package/src/__fixtures__/operations/operation-minimal.ts +11 -0
  32. package/src/__fixtures__/operations/operation-parameters.ts +337 -0
  33. package/src/__fixtures__/operations/operation-with-examples.ts +113 -0
  34. package/src/__fixtures__/operations/operation-without-servers.ts +16 -0
  35. package/src/__fixtures__/operations/patch-todos.ts +49 -0
  36. package/src/__fixtures__/operations/put-todos.ts +862 -0
  37. package/src/__fixtures__/operations/referenced-body.ts +62 -0
  38. package/src/__fixtures__/operations/request-body-empty-schema.ts +35 -0
  39. package/src/__fixtures__/operations/request-body.ts +62 -0
  40. package/src/__fixtures__/operations/securedOperation.ts +118 -0
  41. package/src/__fixtures__/operations/security-basic.ts +24 -0
  42. package/src/__fixtures__/operations/security-bearer.ts +25 -0
  43. package/src/__fixtures__/operations/simple-get.ts +17 -0
  44. package/src/__fixtures__/operations/simple.ts +103 -0
  45. package/src/__fixtures__/operations/string-numeric-enums.ts +32 -0
  46. package/src/__fixtures__/operations/urlencoded-post-oneof.ts +81 -0
  47. package/src/__fixtures__/operations/urlencoded-post.ts +54 -0
  48. package/src/__fixtures__/operations/vendor-extensions.ts +337 -0
  49. package/src/__fixtures__/operations/with-url-variables.ts +47 -0
  50. package/src/__fixtures__/operations/x-code-samples.ts +348 -0
  51. package/src/__fixtures__/schemas/circular.ts +1906 -0
  52. package/src/__fixtures__/schemas/contact.json +293 -0
  53. package/src/__fixtures__/schemas/media-entry.json +69 -0
  54. package/src/__fixtures__/schemas/simple.json +27 -0
  55. package/src/__fixtures__/schemas/todo-full.v1.json +35 -0
  56. package/src/__fixtures__/schemas/todo-partial.v1.json +14 -0
  57. package/src/__fixtures__/schemas/user.v1.json +17 -0
  58. package/src/__fixtures__/security-schemes/index.ts +38 -0
  59. package/src/__fixtures__/services/petstore.ts +167 -0
  60. package/src/__fixtures__/services/with-unnamed-servers.ts +38 -0
  61. package/src/__fixtures__/services/with-url-variables.ts +83 -0
  62. package/src/__fixtures__/services/without-origin.ts +20 -0
  63. package/src/__fixtures__/table-of-contents/nested.ts +44 -0
  64. package/src/__fixtures__/table-of-contents/studio-template.ts +100 -0
  65. package/src/__fixtures__/table-of-contents/studio.ts +559 -0
  66. package/src/components/Docs/Article/Article.spec.tsx +38 -0
  67. package/src/components/Docs/Article/Article.stories.tsx +17 -0
  68. package/src/components/Docs/Article/index.tsx +38 -0
  69. package/src/components/Docs/Docs.stories.tsx +33 -0
  70. package/src/components/Docs/Docs.tsx +233 -0
  71. package/src/components/Docs/HttpOperation/Badges.tsx +49 -0
  72. package/src/components/Docs/HttpOperation/Body.tsx +79 -0
  73. package/src/components/Docs/HttpOperation/Callbacks.tsx +89 -0
  74. package/src/components/Docs/HttpOperation/HttpOperation.spec.tsx +787 -0
  75. package/src/components/Docs/HttpOperation/HttpOperation.stories.ts +14 -0
  76. package/src/components/Docs/HttpOperation/HttpOperation.tsx +255 -0
  77. package/src/components/Docs/HttpOperation/Parameters.spec.tsx +101 -0
  78. package/src/components/Docs/HttpOperation/Parameters.tsx +118 -0
  79. package/src/components/Docs/HttpOperation/Request.tsx +140 -0
  80. package/src/components/Docs/HttpOperation/Responses.tsx +247 -0
  81. package/src/components/Docs/HttpOperation/index.ts +1 -0
  82. package/src/components/Docs/HttpService/AdditionalInfo.stories.ts +48 -0
  83. package/src/components/Docs/HttpService/AdditionalInfo.tsx +61 -0
  84. package/src/components/Docs/HttpService/ExportButton.tsx +35 -0
  85. package/src/components/Docs/HttpService/HttpService.spec.tsx +429 -0
  86. package/src/components/Docs/HttpService/HttpService.stories.ts +14 -0
  87. package/src/components/Docs/HttpService/HttpService.tsx +99 -0
  88. package/src/components/Docs/HttpService/SecuritySchemes.tsx +82 -0
  89. package/src/components/Docs/HttpService/ServerInfo.tsx +196 -0
  90. package/src/components/Docs/HttpService/index.ts +1 -0
  91. package/src/components/Docs/Model/Model.spec.tsx +241 -0
  92. package/src/components/Docs/Model/Model.stories.tsx +16 -0
  93. package/src/components/Docs/Model/Model.tsx +160 -0
  94. package/src/components/Docs/Model/index.ts +1 -0
  95. package/src/components/Docs/NodeVendorExtensions.tsx +55 -0
  96. package/src/components/Docs/Sections.tsx +54 -0
  97. package/src/components/Docs/Security/PanelContent.tsx +38 -0
  98. package/src/components/Docs/Security/index.ts +1 -0
  99. package/src/components/Docs/Skeleton.tsx +12 -0
  100. package/src/components/Docs/TwoColumnLayout.tsx +28 -0
  101. package/src/components/Docs/index.ts +1 -0
  102. package/src/components/Docs/story-helper.ts +46 -0
  103. package/src/components/Docs/story-renderer-helper.tsx +56 -0
  104. package/src/components/Layout/MobileTopNav.tsx +78 -0
  105. package/src/components/Layout/ResponsiveSidebarLayout.tsx +175 -0
  106. package/src/components/Layout/SidebarLayout.tsx +107 -0
  107. package/src/components/LinkHeading.tsx +21 -0
  108. package/src/components/LoadMore.tsx +20 -0
  109. package/src/components/Loading/Loading.tsx +9 -0
  110. package/src/components/Logo.tsx +25 -0
  111. package/src/components/MarkdownViewer/CustomComponents/CodeComponent.spec.ts +90 -0
  112. package/src/components/MarkdownViewer/CustomComponents/CodeComponent.tsx +164 -0
  113. package/src/components/MarkdownViewer/CustomComponents/Provider.tsx +20 -0
  114. package/src/components/MarkdownViewer/CustomComponents/ReactRouterLink.tsx +27 -0
  115. package/src/components/MarkdownViewer/CustomComponents/ResolvedImage.tsx +86 -0
  116. package/src/components/MarkdownViewer/CustomComponents/ScrollToHashElement.tsx +96 -0
  117. package/src/components/MarkdownViewer/MarkdownViewer.spec.tsx +170 -0
  118. package/src/components/MarkdownViewer/index.tsx +10 -0
  119. package/src/components/NonIdealState.tsx +20 -0
  120. package/src/components/PoweredByLink.tsx +30 -0
  121. package/src/components/RequestSamples/RequestSamples.stories.tsx +67 -0
  122. package/src/components/RequestSamples/RequestSamples.tsx +246 -0
  123. package/src/components/RequestSamples/__tests__/RequestSamples.test.tsx +131 -0
  124. package/src/components/RequestSamples/__tests__/__snapshots__/convertRequestToSample.spec.ts.snap +746 -0
  125. package/src/components/RequestSamples/__tests__/convertRequestToSample.spec.ts +118 -0
  126. package/src/components/RequestSamples/convertRequestToSample.ts +56 -0
  127. package/src/components/RequestSamples/extractCodeSamples.ts +50 -0
  128. package/src/components/RequestSamples/index.ts +2 -0
  129. package/src/components/RequestSamples/requestSampleConfigs.ts +182 -0
  130. package/src/components/ResponseExamples/ResponseExamples.spec.tsx +121 -0
  131. package/src/components/ResponseExamples/ResponseExamples.stories.tsx +21 -0
  132. package/src/components/ResponseExamples/ResponseExamples.tsx +79 -0
  133. package/src/components/TableOfContents/TableOfContents.spec.tsx +316 -0
  134. package/src/components/TableOfContents/TableOfContents.stories.tsx +136 -0
  135. package/src/components/TableOfContents/TableOfContents.tsx +530 -0
  136. package/src/components/TableOfContents/constants.ts +45 -0
  137. package/src/components/TableOfContents/index.ts +2 -0
  138. package/src/components/TableOfContents/types.ts +59 -0
  139. package/src/components/TableOfContents/utils.ts +84 -0
  140. package/src/components/TryIt/Auth/APIKeyAuth.tsx +19 -0
  141. package/src/components/TryIt/Auth/Auth.tsx +169 -0
  142. package/src/components/TryIt/Auth/AuthTokenInput.tsx +37 -0
  143. package/src/components/TryIt/Auth/BasicAuth.tsx +62 -0
  144. package/src/components/TryIt/Auth/BearerAuth.tsx +19 -0
  145. package/src/components/TryIt/Auth/DigestAuth.tsx +35 -0
  146. package/src/components/TryIt/Auth/OAuth2Auth.tsx +19 -0
  147. package/src/components/TryIt/Auth/authentication-utils.ts +113 -0
  148. package/src/components/TryIt/Body/BinaryBody.tsx +52 -0
  149. package/src/components/TryIt/Body/FormDataBody.tsx +145 -0
  150. package/src/components/TryIt/Body/RequestBody.tsx +71 -0
  151. package/src/components/TryIt/Body/__tests__/BinaryBody.test.tsx +29 -0
  152. package/src/components/TryIt/Body/__tests__/FormDataBody.test.tsx +94 -0
  153. package/src/components/TryIt/Body/request-body-utils.ts +127 -0
  154. package/src/components/TryIt/Body/useTextRequestBodyState.ts +27 -0
  155. package/src/components/TryIt/Mocking/MockingButton.tsx +98 -0
  156. package/src/components/TryIt/Mocking/mocking-utils.ts +56 -0
  157. package/src/components/TryIt/Mocking/useMockingOptions.ts +6 -0
  158. package/src/components/TryIt/Parameters/FileUploadParameterEditors.tsx +62 -0
  159. package/src/components/TryIt/Parameters/OperationParameters.tsx +39 -0
  160. package/src/components/TryIt/Parameters/ParameterEditor.tsx +135 -0
  161. package/src/components/TryIt/Parameters/__tests__/parameter-utils.spec.ts +60 -0
  162. package/src/components/TryIt/Parameters/parameter-utils.spec.ts +118 -0
  163. package/src/components/TryIt/Parameters/parameter-utils.ts +245 -0
  164. package/src/components/TryIt/Parameters/useOperationParameters.ts +60 -0
  165. package/src/components/TryIt/Response/ReponseCodeViewer.tsx +28 -0
  166. package/src/components/TryIt/Response/Response.spec.tsx +174 -0
  167. package/src/components/TryIt/Response/Response.tsx +172 -0
  168. package/src/components/TryIt/Response/hooks/useLineCount.ts +7 -0
  169. package/src/components/TryIt/Servers/ServerVariables.tsx +33 -0
  170. package/src/components/TryIt/Servers/ServersDropdown.tsx +53 -0
  171. package/src/components/TryIt/Servers/VariableEditor.tsx +64 -0
  172. package/src/components/TryIt/Servers/useServerVariables.ts +19 -0
  173. package/src/components/TryIt/TryIt.spec.tsx +1511 -0
  174. package/src/components/TryIt/TryIt.stories.tsx +77 -0
  175. package/src/components/TryIt/TryIt.tsx +384 -0
  176. package/src/components/TryIt/TryItWithRequestSamples.spec.tsx +143 -0
  177. package/src/components/TryIt/TryItWithRequestSamples.stories.tsx +32 -0
  178. package/src/components/TryIt/TryItWithRequestSamples.tsx +42 -0
  179. package/src/components/TryIt/build-request.spec.ts +261 -0
  180. package/src/components/TryIt/build-request.ts +357 -0
  181. package/src/components/TryIt/chosenServer.ts +5 -0
  182. package/src/components/TryIt/index.ts +3 -0
  183. package/src/components/__tests__/LinkHeading.spec.tsx +125 -0
  184. package/src/constants.ts +176 -0
  185. package/src/containers/MockingProvider.tsx +23 -0
  186. package/src/context/InlineRefResolver.spec.tsx +183 -0
  187. package/src/context/InlineRefResolver.tsx +94 -0
  188. package/src/context/Options.tsx +27 -0
  189. package/src/context/Persistence.tsx +24 -0
  190. package/src/context/RouterType.tsx +9 -0
  191. package/src/core.css +97 -0
  192. package/src/hoc/utils.ts +5 -0
  193. package/src/hoc/withMosaicProvider.spec.tsx +48 -0
  194. package/src/hoc/withMosaicProvider.tsx +28 -0
  195. package/src/hoc/withQueryClientProvider.spec.tsx +38 -0
  196. package/src/hoc/withQueryClientProvider.tsx +35 -0
  197. package/src/hoc/withRouter.tsx +71 -0
  198. package/src/hooks/useBundleRefsIntoDocument.ts +60 -0
  199. package/src/hooks/useFirstRender.ts +8 -0
  200. package/src/hooks/useIsCompact.ts +26 -0
  201. package/src/hooks/useParsedData.ts +99 -0
  202. package/src/hooks/useParsedValue.ts +19 -0
  203. package/src/hooks/useResponsiveLayout.tsx +51 -0
  204. package/src/hooks/useRouter.tsx +31 -0
  205. package/src/hooks/useUniqueId.ts +4 -0
  206. package/src/index.ts +48 -0
  207. package/src/styled.tsx +22 -0
  208. package/src/styles.css +4 -0
  209. package/src/types.ts +170 -0
  210. package/src/utils/__tests__/securitySchemes.spec.ts +137 -0
  211. package/src/utils/exampleGeneration/exampleGeneration.spec.tsx +18 -0
  212. package/src/utils/exampleGeneration/exampleGeneration.ts +110 -0
  213. package/src/utils/fileToBase64.ts +11 -0
  214. package/src/utils/guards.ts +48 -0
  215. package/src/utils/headers.ts +316 -0
  216. package/src/utils/http-spec/IServer.ts +100 -0
  217. package/src/utils/http-spec/__tests__/IServer.spec.ts +51 -0
  218. package/src/utils/http-spec/examples.ts +5 -0
  219. package/src/utils/http.ts +9 -0
  220. package/src/utils/jotai/persistAtom.ts +31 -0
  221. package/src/utils/node.ts +19 -0
  222. package/src/utils/oas/__tests__/security.spec.ts +18 -0
  223. package/src/utils/oas/security.ts +76 -0
  224. package/src/utils/ref-resolving/ReferenceResolver.ts +29 -0
  225. package/src/utils/ref-resolving/resolvedObject.test.ts +415 -0
  226. package/src/utils/ref-resolving/resolvedObject.ts +107 -0
  227. package/src/utils/securitySchemes.ts +117 -0
  228. package/src/utils/string.ts +15 -0
  229. package/src/utils/tests/chooseOption.ts +7 -0
  230. package/src/web-components/createElementClass.ts +154 -0
  231. package/tsconfig.build.json +14 -0
  232. package/tsconfig.json +7 -0
  233. package/styles.min.css +0 -1
  234. /package/{__fixtures__ → dist/__fixtures__}/articles/schema-with-refs.d.ts +0 -0
  235. /package/{__fixtures__ → dist/__fixtures__}/operations/application-octet-stream-post.d.ts +0 -0
  236. /package/{__fixtures__ → dist/__fixtures__}/operations/base64-file-upload.d.ts +0 -0
  237. /package/{__fixtures__ → dist/__fixtures__}/operations/big-response.d.ts +0 -0
  238. /package/{__fixtures__ → dist/__fixtures__}/operations/examples-request-body.d.ts +0 -0
  239. /package/{__fixtures__ → dist/__fixtures__}/operations/head-todos.d.ts +0 -0
  240. /package/{__fixtures__ → dist/__fixtures__}/operations/multipart-formdata-post.d.ts +0 -0
  241. /package/{__fixtures__ → dist/__fixtures__}/operations/operation-minimal.d.ts +0 -0
  242. /package/{__fixtures__ → dist/__fixtures__}/operations/operation-parameters.d.ts +0 -0
  243. /package/{__fixtures__ → dist/__fixtures__}/operations/operation-with-examples.d.ts +0 -0
  244. /package/{__fixtures__ → dist/__fixtures__}/operations/operation-without-servers.d.ts +0 -0
  245. /package/{__fixtures__ → dist/__fixtures__}/operations/patch-todos.d.ts +0 -0
  246. /package/{__fixtures__ → dist/__fixtures__}/operations/put-todos.d.ts +0 -0
  247. /package/{__fixtures__ → dist/__fixtures__}/operations/referenced-body.d.ts +0 -0
  248. /package/{__fixtures__ → dist/__fixtures__}/operations/request-body-empty-schema.d.ts +0 -0
  249. /package/{__fixtures__ → dist/__fixtures__}/operations/request-body.d.ts +0 -0
  250. /package/{__fixtures__ → dist/__fixtures__}/operations/securedOperation.d.ts +0 -0
  251. /package/{__fixtures__ → dist/__fixtures__}/operations/security-basic.d.ts +0 -0
  252. /package/{__fixtures__ → dist/__fixtures__}/operations/security-bearer.d.ts +0 -0
  253. /package/{__fixtures__ → dist/__fixtures__}/operations/simple-get.d.ts +0 -0
  254. /package/{__fixtures__ → dist/__fixtures__}/operations/string-numeric-enums.d.ts +0 -0
  255. /package/{__fixtures__ → dist/__fixtures__}/operations/urlencoded-post-oneof.d.ts +0 -0
  256. /package/{__fixtures__ → dist/__fixtures__}/operations/urlencoded-post.d.ts +0 -0
  257. /package/{__fixtures__ → dist/__fixtures__}/operations/with-url-variables.d.ts +0 -0
  258. /package/{__fixtures__ → dist/__fixtures__}/security-schemes/index.d.ts +0 -0
  259. /package/{__fixtures__ → dist/__fixtures__}/services/petstore.d.ts +0 -0
  260. /package/{__fixtures__ → dist/__fixtures__}/services/with-unnamed-servers.d.ts +0 -0
  261. /package/{__fixtures__ → dist/__fixtures__}/services/with-url-variables.d.ts +0 -0
  262. /package/{__fixtures__ → dist/__fixtures__}/services/without-origin.d.ts +0 -0
  263. /package/{components → dist/components}/Docs/Article/Article.spec.d.ts +0 -0
  264. /package/{components → dist/components}/Docs/Article/Article.stories.d.ts +0 -0
  265. /package/{components → dist/components}/Docs/Article/index.d.ts +0 -0
  266. /package/{components → dist/components}/Docs/Docs.d.ts +0 -0
  267. /package/{components → dist/components}/Docs/Docs.stories.d.ts +0 -0
  268. /package/{components → dist/components}/Docs/HttpOperation/Badges.d.ts +0 -0
  269. /package/{components → dist/components}/Docs/HttpOperation/Body.d.ts +0 -0
  270. /package/{components → dist/components}/Docs/HttpOperation/Callbacks.d.ts +0 -0
  271. /package/{components → dist/components}/Docs/HttpOperation/HttpOperation.d.ts +0 -0
  272. /package/{components → dist/components}/Docs/HttpOperation/HttpOperation.spec.d.ts +0 -0
  273. /package/{components → dist/components}/Docs/HttpOperation/HttpOperation.stories.d.ts +0 -0
  274. /package/{components → dist/components}/Docs/HttpOperation/Parameters.d.ts +0 -0
  275. /package/{components → dist/components}/Docs/HttpOperation/Parameters.spec.d.ts +0 -0
  276. /package/{components → dist/components}/Docs/HttpOperation/Request.d.ts +0 -0
  277. /package/{components → dist/components}/Docs/HttpOperation/Responses.d.ts +0 -0
  278. /package/{components → dist/components}/Docs/HttpOperation/index.d.ts +0 -0
  279. /package/{components → dist/components}/Docs/HttpService/AdditionalInfo.d.ts +0 -0
  280. /package/{components → dist/components}/Docs/HttpService/AdditionalInfo.stories.d.ts +0 -0
  281. /package/{components → dist/components}/Docs/HttpService/ExportButton.d.ts +0 -0
  282. /package/{components → dist/components}/Docs/HttpService/HttpService.d.ts +0 -0
  283. /package/{components → dist/components}/Docs/HttpService/HttpService.spec.d.ts +0 -0
  284. /package/{components → dist/components}/Docs/HttpService/HttpService.stories.d.ts +0 -0
  285. /package/{components → dist/components}/Docs/HttpService/SecuritySchemes.d.ts +0 -0
  286. /package/{components → dist/components}/Docs/HttpService/ServerInfo.d.ts +0 -0
  287. /package/{components → dist/components}/Docs/HttpService/index.d.ts +0 -0
  288. /package/{components → dist/components}/Docs/Model/Model.d.ts +0 -0
  289. /package/{components → dist/components}/Docs/Model/Model.spec.d.ts +0 -0
  290. /package/{components → dist/components}/Docs/Model/Model.stories.d.ts +0 -0
  291. /package/{components → dist/components}/Docs/Model/index.d.ts +0 -0
  292. /package/{components → dist/components}/Docs/NodeVendorExtensions.d.ts +0 -0
  293. /package/{components → dist/components}/Docs/Sections.d.ts +0 -0
  294. /package/{components → dist/components}/Docs/Security/PanelContent.d.ts +0 -0
  295. /package/{components → dist/components}/Docs/Security/index.d.ts +0 -0
  296. /package/{components → dist/components}/Docs/Skeleton.d.ts +0 -0
  297. /package/{components → dist/components}/Docs/TwoColumnLayout.d.ts +0 -0
  298. /package/{components → dist/components}/Docs/index.d.ts +0 -0
  299. /package/{components → dist/components}/Docs/story-helper.d.ts +0 -0
  300. /package/{components → dist/components}/Docs/story-renderer-helper.d.ts +0 -0
  301. /package/{components → dist/components}/Layout/MobileTopNav.d.ts +0 -0
  302. /package/{components → dist/components}/Layout/ResponsiveSidebarLayout.d.ts +0 -0
  303. /package/{components → dist/components}/Layout/SidebarLayout.d.ts +0 -0
  304. /package/{components → dist/components}/LinkHeading.d.ts +0 -0
  305. /package/{components → dist/components}/LoadMore.d.ts +0 -0
  306. /package/{components → dist/components}/Loading/Loading.d.ts +0 -0
  307. /package/{components → dist/components}/Logo.d.ts +0 -0
  308. /package/{components → dist/components}/MarkdownViewer/CustomComponents/CodeComponent.d.ts +0 -0
  309. /package/{components → dist/components}/MarkdownViewer/CustomComponents/CodeComponent.spec.d.ts +0 -0
  310. /package/{components → dist/components}/MarkdownViewer/CustomComponents/Provider.d.ts +0 -0
  311. /package/{components → dist/components}/MarkdownViewer/CustomComponents/ReactRouterLink.d.ts +0 -0
  312. /package/{components → dist/components}/MarkdownViewer/CustomComponents/ResolvedImage.d.ts +0 -0
  313. /package/{components → dist/components}/MarkdownViewer/CustomComponents/ScrollToHashElement.d.ts +0 -0
  314. /package/{components → dist/components}/MarkdownViewer/MarkdownViewer.spec.d.ts +0 -0
  315. /package/{components → dist/components}/MarkdownViewer/index.d.ts +0 -0
  316. /package/{components → dist/components}/NonIdealState.d.ts +0 -0
  317. /package/{components → dist/components}/PoweredByLink.d.ts +0 -0
  318. /package/{components → dist/components}/RequestSamples/RequestSamples.d.ts +0 -0
  319. /package/{components → dist/components}/RequestSamples/RequestSamples.stories.d.ts +0 -0
  320. /package/{components → dist/components}/RequestSamples/convertRequestToSample.d.ts +0 -0
  321. /package/{components → dist/components}/RequestSamples/extractCodeSamples.d.ts +0 -0
  322. /package/{components → dist/components}/RequestSamples/index.d.ts +0 -0
  323. /package/{components → dist/components}/RequestSamples/requestSampleConfigs.d.ts +0 -0
  324. /package/{components → dist/components}/ResponseExamples/ResponseExamples.d.ts +0 -0
  325. /package/{components → dist/components}/ResponseExamples/ResponseExamples.spec.d.ts +0 -0
  326. /package/{components → dist/components}/ResponseExamples/ResponseExamples.stories.d.ts +0 -0
  327. /package/{components → dist/components}/TableOfContents/TableOfContents.d.ts +0 -0
  328. /package/{components → dist/components}/TableOfContents/TableOfContents.spec.d.ts +0 -0
  329. /package/{components → dist/components}/TableOfContents/TableOfContents.stories.d.ts +0 -0
  330. /package/{components → dist/components}/TableOfContents/constants.d.ts +0 -0
  331. /package/{components → dist/components}/TableOfContents/index.d.ts +0 -0
  332. /package/{components → dist/components}/TableOfContents/types.d.ts +0 -0
  333. /package/{components → dist/components}/TableOfContents/utils.d.ts +0 -0
  334. /package/{components → dist/components}/TryIt/Auth/APIKeyAuth.d.ts +0 -0
  335. /package/{components → dist/components}/TryIt/Auth/Auth.d.ts +0 -0
  336. /package/{components → dist/components}/TryIt/Auth/AuthTokenInput.d.ts +0 -0
  337. /package/{components → dist/components}/TryIt/Auth/BasicAuth.d.ts +0 -0
  338. /package/{components → dist/components}/TryIt/Auth/BearerAuth.d.ts +0 -0
  339. /package/{components → dist/components}/TryIt/Auth/DigestAuth.d.ts +0 -0
  340. /package/{components → dist/components}/TryIt/Auth/OAuth2Auth.d.ts +0 -0
  341. /package/{components → dist/components}/TryIt/Auth/authentication-utils.d.ts +0 -0
  342. /package/{components → dist/components}/TryIt/Body/BinaryBody.d.ts +0 -0
  343. /package/{components → dist/components}/TryIt/Body/FormDataBody.d.ts +0 -0
  344. /package/{components → dist/components}/TryIt/Body/RequestBody.d.ts +0 -0
  345. /package/{components → dist/components}/TryIt/Body/request-body-utils.d.ts +0 -0
  346. /package/{components → dist/components}/TryIt/Body/useTextRequestBodyState.d.ts +0 -0
  347. /package/{components → dist/components}/TryIt/Mocking/MockingButton.d.ts +0 -0
  348. /package/{components → dist/components}/TryIt/Mocking/mocking-utils.d.ts +0 -0
  349. /package/{components → dist/components}/TryIt/Mocking/useMockingOptions.d.ts +0 -0
  350. /package/{components → dist/components}/TryIt/Parameters/FileUploadParameterEditors.d.ts +0 -0
  351. /package/{components → dist/components}/TryIt/Parameters/OperationParameters.d.ts +0 -0
  352. /package/{components → dist/components}/TryIt/Parameters/ParameterEditor.d.ts +0 -0
  353. /package/{components → dist/components}/TryIt/Parameters/parameter-utils.d.ts +0 -0
  354. /package/{components → dist/components}/TryIt/Parameters/parameter-utils.spec.d.ts +0 -0
  355. /package/{components → dist/components}/TryIt/Parameters/useOperationParameters.d.ts +0 -0
  356. /package/{components → dist/components}/TryIt/Response/ReponseCodeViewer.d.ts +0 -0
  357. /package/{components → dist/components}/TryIt/Response/Response.d.ts +0 -0
  358. /package/{components → dist/components}/TryIt/Response/Response.spec.d.ts +0 -0
  359. /package/{components → dist/components}/TryIt/Response/hooks/useLineCount.d.ts +0 -0
  360. /package/{components → dist/components}/TryIt/Servers/ServerVariables.d.ts +0 -0
  361. /package/{components → dist/components}/TryIt/Servers/ServersDropdown.d.ts +0 -0
  362. /package/{components → dist/components}/TryIt/Servers/VariableEditor.d.ts +0 -0
  363. /package/{components → dist/components}/TryIt/Servers/useServerVariables.d.ts +0 -0
  364. /package/{components → dist/components}/TryIt/TryIt.d.ts +0 -0
  365. /package/{components → dist/components}/TryIt/TryIt.spec.d.ts +0 -0
  366. /package/{components → dist/components}/TryIt/TryIt.stories.d.ts +0 -0
  367. /package/{components → dist/components}/TryIt/TryItWithRequestSamples.d.ts +0 -0
  368. /package/{components → dist/components}/TryIt/TryItWithRequestSamples.spec.d.ts +0 -0
  369. /package/{components → dist/components}/TryIt/TryItWithRequestSamples.stories.d.ts +0 -0
  370. /package/{components → dist/components}/TryIt/build-request.d.ts +0 -0
  371. /package/{components → dist/components}/TryIt/build-request.spec.d.ts +0 -0
  372. /package/{components → dist/components}/TryIt/chosenServer.d.ts +0 -0
  373. /package/{components → dist/components}/TryIt/index.d.ts +0 -0
  374. /package/{constants.d.ts → dist/constants.d.ts} +0 -0
  375. /package/{containers → dist/containers}/MockingProvider.d.ts +0 -0
  376. /package/{context → dist/context}/InlineRefResolver.d.ts +0 -0
  377. /package/{context → dist/context}/InlineRefResolver.spec.d.ts +0 -0
  378. /package/{context → dist/context}/Options.d.ts +0 -0
  379. /package/{context → dist/context}/Persistence.d.ts +0 -0
  380. /package/{context → dist/context}/RouterType.d.ts +0 -0
  381. /package/{core.css → dist/core.css} +0 -0
  382. /package/{hoc → dist/hoc}/utils.d.ts +0 -0
  383. /package/{hoc → dist/hoc}/withMosaicProvider.d.ts +0 -0
  384. /package/{hoc → dist/hoc}/withMosaicProvider.spec.d.ts +0 -0
  385. /package/{hoc → dist/hoc}/withQueryClientProvider.d.ts +0 -0
  386. /package/{hoc → dist/hoc}/withQueryClientProvider.spec.d.ts +0 -0
  387. /package/{hoc → dist/hoc}/withRouter.d.ts +0 -0
  388. /package/{hooks → dist/hooks}/useBundleRefsIntoDocument.d.ts +0 -0
  389. /package/{hooks → dist/hooks}/useFirstRender.d.ts +0 -0
  390. /package/{hooks → dist/hooks}/useIsCompact.d.ts +0 -0
  391. /package/{hooks → dist/hooks}/useParsedData.d.ts +0 -0
  392. /package/{hooks → dist/hooks}/useParsedValue.d.ts +0 -0
  393. /package/{hooks → dist/hooks}/useResponsiveLayout.d.ts +0 -0
  394. /package/{hooks → dist/hooks}/useRouter.d.ts +0 -0
  395. /package/{hooks → dist/hooks}/useUniqueId.d.ts +0 -0
  396. /package/{index.d.ts → dist/index.d.ts} +0 -0
  397. /package/{styled.d.ts → dist/styled.d.ts} +0 -0
  398. /package/{types.d.ts → dist/types.d.ts} +0 -0
  399. /package/{utils → dist/utils}/exampleGeneration/exampleGeneration.d.ts +0 -0
  400. /package/{utils → dist/utils}/exampleGeneration/exampleGeneration.spec.d.ts +0 -0
  401. /package/{utils → dist/utils}/fileToBase64.d.ts +0 -0
  402. /package/{utils → dist/utils}/guards.d.ts +0 -0
  403. /package/{utils → dist/utils}/headers.d.ts +0 -0
  404. /package/{utils → dist/utils}/http-spec/IServer.d.ts +0 -0
  405. /package/{utils → dist/utils}/http-spec/examples.d.ts +0 -0
  406. /package/{utils → dist/utils}/http.d.ts +0 -0
  407. /package/{utils → dist/utils}/jotai/persistAtom.d.ts +0 -0
  408. /package/{utils → dist/utils}/node.d.ts +0 -0
  409. /package/{utils → dist/utils}/oas/security.d.ts +0 -0
  410. /package/{utils → dist/utils}/ref-resolving/ReferenceResolver.d.ts +0 -0
  411. /package/{utils → dist/utils}/ref-resolving/resolvedObject.d.ts +0 -0
  412. /package/{utils → dist/utils}/ref-resolving/resolvedObject.test.d.ts +0 -0
  413. /package/{utils → dist/utils}/securitySchemes.d.ts +0 -0
  414. /package/{utils → dist/utils}/string.d.ts +0 -0
  415. /package/{utils → dist/utils}/tests/chooseOption.d.ts +0 -0
  416. /package/{web-components → dist/web-components}/createElementClass.d.ts +0 -0
@@ -0,0 +1,54 @@
1
+ import { Box, Flex, HeadingProps, Panel, PanelProps } from '@stoplight/mosaic';
2
+ import * as React from 'react';
3
+
4
+ import { slugify } from '../../utils/string';
5
+ import { LinkHeading } from '../LinkHeading';
6
+
7
+ export interface ISectionTitle {
8
+ title: string;
9
+ id?: string;
10
+ size?: HeadingProps['size'];
11
+ isCompact?: boolean;
12
+ }
13
+
14
+ export const SectionTitle: React.FC<ISectionTitle> = ({ title, id, size = 2, isCompact = false, children }) => {
15
+ return (
16
+ <Flex w="full">
17
+ <Box py={1} pr={6} as={LinkHeading} size={size} aria-label={title} id={id || slugify(title)}>
18
+ {title}
19
+ </Box>
20
+ <Flex alignSelf={'center'} py={1} flexGrow style={{ minWidth: 0 }} justify={isCompact ? 'end' : undefined}>
21
+ {children}
22
+ </Flex>
23
+ </Flex>
24
+ );
25
+ };
26
+
27
+ export const SectionSubtitle: React.FC<ISectionTitle> = props => {
28
+ return <SectionTitle {...props} size={3} />;
29
+ };
30
+
31
+ type SubSectionPanelProps = {
32
+ title: React.ReactNode;
33
+ hasContent?: boolean;
34
+ rightComponent?: React.ReactNode;
35
+ };
36
+
37
+ export const SubSectionPanel: React.FC<SubSectionPanelProps & Pick<PanelProps, 'defaultIsOpen' | 'onChange'>> = ({
38
+ title,
39
+ children,
40
+ hasContent,
41
+ rightComponent,
42
+ defaultIsOpen = true,
43
+ onChange,
44
+ }) => {
45
+ return (
46
+ <Panel isCollapsible={hasContent} defaultIsOpen={defaultIsOpen} onChange={onChange} appearance="outlined">
47
+ <Panel.Titlebar fontWeight="medium" rightComponent={rightComponent}>
48
+ <div role="heading">{title}</div>
49
+ </Panel.Titlebar>
50
+
51
+ {hasContent !== false && <Panel.Content>{children}</Panel.Content>}
52
+ </Panel>
53
+ );
54
+ };
@@ -0,0 +1,38 @@
1
+ import { MarkdownViewer } from '@stoplight/markdown-viewer';
2
+ import { Box, NodeAnnotation } from '@stoplight/mosaic';
3
+ import { HttpSecurityScheme } from '@stoplight/types';
4
+ import * as React from 'react';
5
+
6
+ import { useOptionsCtx } from '../../../context/Options';
7
+ import { getReadableSecurityName, shouldIncludeKey } from '../../../utils/oas/security';
8
+ import { getDefaultDescription } from '../../../utils/securitySchemes';
9
+
10
+ export const PanelContent: React.FC<{ schemes: HttpSecurityScheme[] }> = ({ schemes }) => {
11
+ const { nodeHasChanged } = useOptionsCtx();
12
+
13
+ if (!schemes || !schemes.length) {
14
+ return null;
15
+ }
16
+
17
+ const collection = schemes.length > 1;
18
+
19
+ return (
20
+ <Box>
21
+ {schemes.map(scheme => (
22
+ <Box key={scheme.key} p={2} m={2} border>
23
+ {collection && (
24
+ <MarkdownViewer
25
+ style={{ fontWeight: 'bold', fontSize: 12, marginBottom: 10 }}
26
+ markdown={getReadableSecurityName(scheme, shouldIncludeKey(schemes, scheme.type))}
27
+ />
28
+ )}
29
+ <MarkdownViewer
30
+ style={{ fontSize: 12 }}
31
+ markdown={`${scheme.description ?? ''}\n\n` + getDefaultDescription(scheme)}
32
+ />
33
+ <NodeAnnotation change={nodeHasChanged?.({ nodeId: scheme.id })} />
34
+ </Box>
35
+ ))}
36
+ </Box>
37
+ );
38
+ };
@@ -0,0 +1 @@
1
+ export * from './PanelContent';
@@ -0,0 +1,12 @@
1
+ import cn from 'classnames';
2
+ import * as React from 'react';
3
+
4
+ export const DocsSkeleton = ({ className, padding = '12' }: { className?: string; padding?: string }) => {
5
+ return (
6
+ <div className={cn('PageSkeleton', className, `sl-p-${padding}`, 'sl-flex sl-flex-col sl-h-full')}>
7
+ <div className={cn('DocsSkeleton sl-h-12 sl-w-1/5')} />
8
+ <div className={cn('DocsSkeleton sl-h-12 sl-my-6')} />
9
+ <div className={cn('DocsSkeleton sl-flex-1 sl-my-6')} />
10
+ </div>
11
+ );
12
+ };
@@ -0,0 +1,28 @@
1
+ import { Box, Flex, VStack } from '@stoplight/mosaic';
2
+ import React from 'react';
3
+
4
+ export interface TwoColumnLayoutProps {
5
+ header: React.ReactNode;
6
+ right: React.ReactNode;
7
+ left: React.ReactNode;
8
+ className?: string;
9
+ }
10
+
11
+ export const TwoColumnLayout = React.forwardRef<HTMLDivElement, TwoColumnLayoutProps>(
12
+ ({ header, right, left, className }, ref) => (
13
+ <VStack ref={ref} w="full" className={className} spacing={8}>
14
+ {header}
15
+ <Flex>
16
+ <Box data-testid="two-column-left" w={0} flex={1}>
17
+ {left}
18
+ </Box>
19
+
20
+ {right && (
21
+ <Box data-testid="two-column-right" ml={16} pos="relative" w="2/5" style={{ maxWidth: 500 }}>
22
+ {right}
23
+ </Box>
24
+ )}
25
+ </Flex>
26
+ </VStack>
27
+ ),
28
+ );
@@ -0,0 +1 @@
1
+ export * from './Docs';
@@ -0,0 +1,46 @@
1
+ import type { ErrorBoundaryProps } from '@stoplight/react-error-boundary';
2
+ import type { Meta, StoryFn } from '@storybook/react';
3
+ import * as React from 'react';
4
+
5
+ import { ExtensionAddonRenderer } from './Docs';
6
+ import { wrapOptionsContext } from './story-renderer-helper';
7
+
8
+ type DocsProps = { data: any; renderExtensionAddon?: ExtensionAddonRenderer } & ErrorBoundaryProps;
9
+
10
+ type storyOptions = DocsProps & { layoutOptions?: object };
11
+
12
+ interface HelperReturn<P extends DocsProps> {
13
+ meta: Meta<DocsProps>;
14
+ createStory(name: string, input: storyOptions): StoryFn<P>;
15
+ createHoistedStory(input: storyOptions): StoryFn<P>;
16
+ }
17
+
18
+ export const createStoriesForDocsComponent = (
19
+ Component: React.ComponentType<DocsProps>,
20
+ title?: string,
21
+ ): HelperReturn<DocsProps> => {
22
+ const createStory = (name: string, input: storyOptions) => {
23
+ const story: StoryFn<DocsProps> = (args: any) => {
24
+ const component = React.createElement(Component, args);
25
+ return wrapOptionsContext(component);
26
+ };
27
+ story.args = input;
28
+ story.storyName = name;
29
+ return story;
30
+ };
31
+ return {
32
+ meta: {
33
+ title: `Internal/Docs/${title || Component.displayName}`,
34
+ component: Component,
35
+ argTypes: <HelperReturn<DocsProps>['meta']['argTypes']>{
36
+ data: {
37
+ control: { type: 'object' },
38
+ },
39
+ FallbackComponent: { table: { disable: true } },
40
+ recoverableProps: { table: { disable: true } },
41
+ },
42
+ },
43
+ createStory: createStory,
44
+ createHoistedStory: input => createStory(title ?? Component.displayName ?? Component.name ?? '_unknown_', input),
45
+ };
46
+ };
@@ -0,0 +1,56 @@
1
+ import { isPlainObject } from '@stoplight/json';
2
+ import { isRegularNode } from '@stoplight/json-schema-tree';
3
+ import { MarkdownViewer } from '@stoplight/markdown-viewer';
4
+ import { Box } from '@stoplight/mosaic';
5
+ import * as React from 'react';
6
+
7
+ import { ElementsOptionsProvider } from '../../context/Options';
8
+ import { ExtensionAddonRenderer, ExtensionRowProps } from './Docs';
9
+
10
+ /**
11
+ * Renders the known x-enum-Description vendor extension
12
+ * @returns React.ReactElement
13
+ */
14
+ // eslint-disable-next-line storybook/prefer-pascal-case
15
+ export const renderExtensionRenderer: ExtensionAddonRenderer = (props: ExtensionRowProps) => {
16
+ const { nestingLevel, schemaNode, vendorExtensions } = props;
17
+ const { 'x-enum-descriptions': enumDescriptions = {} } = vendorExtensions;
18
+
19
+ // If the nesting level is 0, we are at the root of the schema and should not render anything
20
+ if (nestingLevel === 0) {
21
+ return null;
22
+ }
23
+
24
+ // This implementation of the extension renderer only supports the `x-enum-descriptions`-extension
25
+ if ('x-enum-descriptions' in vendorExtensions && isRegularNode(schemaNode) && isPlainObject(enumDescriptions)) {
26
+ let value = `| Enum value | Description |\n|---|---|\n`;
27
+
28
+ for (const enumValue of schemaNode.enum ?? []) {
29
+ const description = enumDescriptions[String(enumValue)];
30
+ value += `| ${enumValue} | ${description} |\n`;
31
+ }
32
+
33
+ return (
34
+ <Box mb={2}>
35
+ <Box
36
+ mt={2}
37
+ as={MarkdownViewer}
38
+ markdown={value}
39
+ style={{
40
+ fontSize: 12,
41
+ }}
42
+ />
43
+ </Box>
44
+ );
45
+ }
46
+
47
+ return null;
48
+ };
49
+
50
+ /**
51
+ * @private
52
+ * Helper function to wrap the options context for the Docs subcomponents
53
+ */
54
+ export const wrapOptionsContext = (story: any) => {
55
+ return <ElementsOptionsProvider renderExtensionAddon={renderExtensionRenderer}>{story}</ElementsOptionsProvider>;
56
+ };
@@ -0,0 +1,78 @@
1
+ import { faBars, faX } from '@fortawesome/free-solid-svg-icons';
2
+ import { Box, Button, Drawer, Flex, Icon } from '@stoplight/mosaic';
3
+ import * as React from 'react';
4
+
5
+ import { LogoProps } from '../../types';
6
+ import type { TableOfContentsItem } from '../TableOfContents';
7
+ import { Sidebar } from './ResponsiveSidebarLayout';
8
+
9
+ export const MobileTopNav = ({
10
+ name,
11
+ logo,
12
+ tree,
13
+ pathname,
14
+ onTocClick,
15
+ }: {
16
+ name: string;
17
+ logo?: string | LogoProps;
18
+ tree: TableOfContentsItem[];
19
+ pathname: string;
20
+ onTocClick(): void;
21
+ }): JSX.Element => {
22
+ const [isSidebarOpen, setIsSidebarOpen] = React.useState<boolean>(false);
23
+
24
+ const handleTocClick = () => {
25
+ onTocClick();
26
+ setIsSidebarOpen(false);
27
+ };
28
+ return (
29
+ <Flex className="TopNav--mosaic" alignItems="center" h="3xl" pl={4} pr={4} bg="canvas" borderB pos="fixed" w="full">
30
+ <Flex data-test="mobile-top-nav" w="full" alignItems="center" justifyContent="between">
31
+ <Button data-test="show-left-sidebar-btn" onPress={() => setIsSidebarOpen(true)} appearance="minimal">
32
+ <Icon size="lg" icon={faBars} />
33
+ </Button>
34
+ <NavHeading heading={name} />
35
+ </Flex>
36
+
37
+ <Drawer isOpen={isSidebarOpen} position="left" onClose={() => setIsSidebarOpen(false)} w="5/6">
38
+ <Flex justifyContent="end">
39
+ <Button
40
+ className="sl-mr-4 sl-mt-2"
41
+ onPress={() => setIsSidebarOpen(false)}
42
+ appearance="minimal"
43
+ justifySelf="end"
44
+ >
45
+ <Icon size="lg" icon={faX} />
46
+ </Button>
47
+ </Flex>
48
+ <Box tabIndex={-1}>
49
+ <Sidebar
50
+ name={name}
51
+ logo={logo}
52
+ tree={tree}
53
+ pathname={pathname}
54
+ onTocClick={handleTocClick}
55
+ isInResponsiveMode={true}
56
+ />
57
+ </Box>
58
+ </Drawer>
59
+ </Flex>
60
+ );
61
+ };
62
+
63
+ const NavHeading = ({ heading }: { heading?: string }): JSX.Element => (
64
+ <Flex flex={1} data-test="mobile-project-top-nav" style={{ minWidth: 0 }}>
65
+ <Box
66
+ fontSize="xl"
67
+ fontWeight="semibold"
68
+ whitespace="nowrap"
69
+ textOverflow="overflow-ellipsis"
70
+ overflowX="hidden"
71
+ overflowY="hidden"
72
+ w="full"
73
+ textAlign="center"
74
+ >
75
+ {heading}
76
+ </Box>
77
+ </Flex>
78
+ );
@@ -0,0 +1,175 @@
1
+ import { Box, Flex, Heading } from '@stoplight/mosaic';
2
+ import * as React from 'react';
3
+ import { Link, useLocation } from 'react-router-dom';
4
+
5
+ import { useResponsiveLayout } from '../../hooks/useResponsiveLayout';
6
+ import { LogoProps } from '../../types';
7
+ import { Logo } from '../Logo';
8
+ import { PoweredByLink } from '../PoweredByLink';
9
+ import type { CustomLinkComponent, TableOfContentsItem } from '../TableOfContents';
10
+ import { TableOfContents } from '../TableOfContents';
11
+ import { MobileTopNav } from './MobileTopNav';
12
+
13
+ type ResponsiveSidebarLayoutProps = {
14
+ maxContentWidth?: number;
15
+ sidebarWidth?: number;
16
+ children?: React.ReactNode;
17
+ name: string;
18
+ logo?: string | LogoProps;
19
+ tree?: TableOfContentsItem[];
20
+ onTocClick?(): void;
21
+ };
22
+
23
+ const MAX_CONTENT_WIDTH = 1800;
24
+ const SIDEBAR_MIN_WIDTH = 300;
25
+ const SIDEBAR_MAX_WIDTH = 1.5 * SIDEBAR_MIN_WIDTH;
26
+
27
+ export const ResponsiveSidebarLayout = React.forwardRef<HTMLDivElement, ResponsiveSidebarLayoutProps>(
28
+ (
29
+ { children, name, logo, tree, onTocClick, maxContentWidth = MAX_CONTENT_WIDTH, sidebarWidth = SIDEBAR_MIN_WIDTH },
30
+ ref,
31
+ ) => {
32
+ const scrollRef = React.useRef<HTMLDivElement | null>(null);
33
+ const [sidebarRef, currentSidebarWidth, startResizing] = useResizer(sidebarWidth);
34
+ const { pathname } = useLocation();
35
+
36
+ React.useEffect(() => {
37
+ // Scroll to top on page change
38
+ scrollRef.current?.scrollTo(0, 0);
39
+ }, [pathname]);
40
+
41
+ const { isResponsiveLayoutEnabled } = useResponsiveLayout();
42
+
43
+ return (
44
+ <Flex ref={ref} className="sl-elements-api" pin h="full">
45
+ {!isResponsiveLayoutEnabled && (
46
+ <Flex
47
+ ref={sidebarRef}
48
+ onMouseDown={(e: React.MouseEvent<HTMLElement>) => e.preventDefault()}
49
+ style={{ maxWidth: `${SIDEBAR_MAX_WIDTH}px` }}
50
+ >
51
+ <Flex
52
+ direction="col"
53
+ bg="canvas-100"
54
+ borderR
55
+ pt={8}
56
+ pos="sticky"
57
+ pinY
58
+ overflowY="auto"
59
+ style={{
60
+ paddingLeft: `calc((100% - ${maxContentWidth}px) / 2)`,
61
+ width: `${currentSidebarWidth}px`,
62
+ minWidth: `${SIDEBAR_MIN_WIDTH}px`,
63
+ }}
64
+ >
65
+ <Sidebar
66
+ name={name}
67
+ logo={logo}
68
+ tree={tree!}
69
+ pathname={pathname}
70
+ onTocClick={onTocClick}
71
+ isInResponsiveMode={false}
72
+ />
73
+ </Flex>
74
+ <Flex
75
+ justifySelf="end"
76
+ flexGrow={0}
77
+ flexShrink={0}
78
+ resize="x"
79
+ onMouseDown={startResizing}
80
+ style={{ width: '1em', flexBasis: '6px', cursor: 'ew-resize' }}
81
+ />
82
+ </Flex>
83
+ )}
84
+
85
+ <Box ref={scrollRef} bg="canvas" px={!isResponsiveLayoutEnabled ? 24 : 6} flex={1} w="full" overflowY="auto">
86
+ <Box style={{ maxWidth: `${maxContentWidth - currentSidebarWidth}px` }} py={16}>
87
+ {children}
88
+ </Box>
89
+ </Box>
90
+
91
+ {isResponsiveLayoutEnabled && (
92
+ <MobileTopNav onTocClick={onTocClick!} name={name} logo={logo} tree={tree!} pathname={pathname} />
93
+ )}
94
+ </Flex>
95
+ );
96
+ },
97
+ );
98
+
99
+ type SidebarRef = React.Ref<HTMLDivElement>;
100
+ type SidebarWidth = number;
101
+ type StartResizingFn = () => void;
102
+
103
+ export const Sidebar = ({
104
+ name,
105
+ logo,
106
+ tree,
107
+ pathname,
108
+ onTocClick,
109
+ isInResponsiveMode,
110
+ }: {
111
+ name: string;
112
+ logo?: string | LogoProps;
113
+ tree: TableOfContentsItem[];
114
+ pathname: string;
115
+ onTocClick?(): void;
116
+ isInResponsiveMode: boolean;
117
+ }) => {
118
+ return (
119
+ <>
120
+ <Flex ml={4} mb={5} alignItems="center">
121
+ {typeof logo === 'string' ? (
122
+ <Logo logo={{ url: logo, altText: 'logo' }} />
123
+ ) : (
124
+ typeof logo === 'object' && <Logo logo={logo} />
125
+ )}
126
+ <Heading size={4}>{name}</Heading>
127
+ </Flex>
128
+ <Flex flexGrow flexShrink overflowY="auto" direction="col">
129
+ <TableOfContents
130
+ tree={tree}
131
+ activeId={pathname}
132
+ Link={Link as CustomLinkComponent}
133
+ onLinkClick={onTocClick}
134
+ isInResponsiveMode={isInResponsiveMode}
135
+ />
136
+ </Flex>
137
+ <PoweredByLink source={name} pathname={pathname} packageType="elements" />
138
+ </>
139
+ );
140
+ };
141
+
142
+ function useResizer(sidebarWidth: number): [SidebarRef, SidebarWidth, StartResizingFn] {
143
+ const sidebarRef = React.useRef<HTMLDivElement | null>(null);
144
+ const [isResizing, setIsResizing] = React.useState(false);
145
+ const [currentSidebarWidth, setCurrentSidebarWidth] = React.useState(sidebarWidth);
146
+
147
+ const startResizing = React.useCallback(() => {
148
+ setIsResizing(true);
149
+ }, []);
150
+
151
+ const stopResizing = React.useCallback(() => {
152
+ setIsResizing(false);
153
+ }, []);
154
+
155
+ const resize = React.useCallback(
156
+ mouseMoveEvent => {
157
+ if (isResizing) {
158
+ const value = mouseMoveEvent.clientX - sidebarRef.current!.getBoundingClientRect().left;
159
+ setCurrentSidebarWidth(Math.min(Math.max(SIDEBAR_MIN_WIDTH, value), SIDEBAR_MAX_WIDTH));
160
+ }
161
+ },
162
+ [isResizing],
163
+ );
164
+
165
+ React.useEffect(() => {
166
+ window?.addEventListener('mousemove', resize);
167
+ window?.addEventListener('mouseup', stopResizing, { passive: true });
168
+ return () => {
169
+ window?.removeEventListener('mousemove', resize);
170
+ window?.removeEventListener('mouseup', stopResizing);
171
+ };
172
+ }, [resize, stopResizing]);
173
+
174
+ return [sidebarRef, currentSidebarWidth, startResizing];
175
+ }
@@ -0,0 +1,107 @@
1
+ import { Box, Flex } from '@stoplight/mosaic';
2
+ import * as React from 'react';
3
+ import { useLocation } from 'react-router-dom';
4
+
5
+ type SidebarLayoutProps = {
6
+ sidebar: React.ReactNode;
7
+ maxContentWidth?: number;
8
+ sidebarWidth?: number;
9
+ children?: React.ReactNode;
10
+ };
11
+
12
+ const MAX_CONTENT_WIDTH = 1800;
13
+ const SIDEBAR_MIN_WIDTH = 300;
14
+ const SIDEBAR_MAX_WIDTH = 1.5 * SIDEBAR_MIN_WIDTH;
15
+
16
+ export const SidebarLayout = React.forwardRef<HTMLDivElement, SidebarLayoutProps>(
17
+ ({ sidebar, children, maxContentWidth = MAX_CONTENT_WIDTH, sidebarWidth = SIDEBAR_MIN_WIDTH }, ref) => {
18
+ const scrollRef = React.useRef<HTMLDivElement | null>(null);
19
+ const [sidebarRef, currentSidebarWidth, startResizing] = useResizer(sidebarWidth);
20
+ const { pathname } = useLocation();
21
+
22
+ React.useEffect(() => {
23
+ // Scroll to top on page change
24
+ scrollRef.current?.scrollTo(0, 0);
25
+ }, [pathname]);
26
+
27
+ return (
28
+ <Flex ref={ref} className="sl-elements-api" pin h="full">
29
+ <Flex
30
+ ref={sidebarRef}
31
+ onMouseDown={(e: React.MouseEvent<HTMLElement>) => e.preventDefault()}
32
+ style={{ maxWidth: `${SIDEBAR_MAX_WIDTH}px` }}
33
+ >
34
+ <Flex
35
+ direction="col"
36
+ bg="canvas-100"
37
+ borderR
38
+ pt={8}
39
+ pos="sticky"
40
+ pinY
41
+ overflowY="auto"
42
+ style={{
43
+ paddingLeft: `calc((100% - ${maxContentWidth}px) / 2)`,
44
+ width: `${currentSidebarWidth}px`,
45
+ minWidth: `${SIDEBAR_MIN_WIDTH}px`,
46
+ }}
47
+ >
48
+ {sidebar}
49
+ </Flex>
50
+ <Flex
51
+ justifySelf="end"
52
+ flexGrow={0}
53
+ flexShrink={0}
54
+ resize="x"
55
+ onMouseDown={startResizing}
56
+ style={{ width: '1em', flexBasis: '6px', cursor: 'ew-resize' }}
57
+ />
58
+ </Flex>
59
+
60
+ <Box ref={scrollRef} bg="canvas" px={24} flex={1} w="full" overflowY="auto">
61
+ <Box style={{ maxWidth: `${maxContentWidth - currentSidebarWidth}px` }} py={16}>
62
+ {children}
63
+ </Box>
64
+ </Box>
65
+ </Flex>
66
+ );
67
+ },
68
+ );
69
+
70
+ type SidebarRef = React.Ref<HTMLDivElement>;
71
+ type SidebarWidth = number;
72
+ type StartResizingFn = () => void;
73
+
74
+ function useResizer(sidebarWidth: number): [SidebarRef, SidebarWidth, StartResizingFn] {
75
+ const sidebarRef = React.useRef<HTMLDivElement | null>(null);
76
+ const [isResizing, setIsResizing] = React.useState(false);
77
+ const [currentSidebarWidth, setCurrentSidebarWidth] = React.useState(sidebarWidth);
78
+
79
+ const startResizing = React.useCallback(() => {
80
+ setIsResizing(true);
81
+ }, []);
82
+
83
+ const stopResizing = React.useCallback(() => {
84
+ setIsResizing(false);
85
+ }, []);
86
+
87
+ const resize = React.useCallback(
88
+ mouseMoveEvent => {
89
+ if (isResizing) {
90
+ const value = mouseMoveEvent.clientX - sidebarRef.current!.getBoundingClientRect().left;
91
+ setCurrentSidebarWidth(Math.min(Math.max(SIDEBAR_MIN_WIDTH, value), SIDEBAR_MAX_WIDTH));
92
+ }
93
+ },
94
+ [isResizing],
95
+ );
96
+
97
+ React.useEffect(() => {
98
+ window.addEventListener('mousemove', resize);
99
+ window.addEventListener('mouseup', stopResizing, { passive: true });
100
+ return () => {
101
+ window.removeEventListener('mousemove', resize);
102
+ window.removeEventListener('mouseup', stopResizing);
103
+ };
104
+ }, [resize, stopResizing]);
105
+
106
+ return [sidebarRef, currentSidebarWidth, startResizing];
107
+ }
@@ -0,0 +1,21 @@
1
+ import { LinkHeading as MosaicLinkHeading, LinkHeadingProps } from '@stoplight/mosaic';
2
+ import * as React from 'react';
3
+ import { useLocation } from 'react-router-dom';
4
+
5
+ import { RouterTypeContext, useRouterType } from '../context/RouterType';
6
+
7
+ export const LinkHeading = React.memo<LinkHeadingProps>(function LinkHeading(props) {
8
+ const isUsingRouter = !!useRouterType();
9
+ const Comp = isUsingRouter ? CustomLinkHeading : MosaicLinkHeading;
10
+
11
+ return <Comp {...props} />;
12
+ });
13
+
14
+ const CustomLinkHeading = React.memo<LinkHeadingProps>(function LinkHeading({ id: _id, ...props }) {
15
+ const { pathname } = useLocation();
16
+ const routerKind = React.useContext(RouterTypeContext);
17
+ const route = pathname.split('#')[0];
18
+ const id = routerKind === 'hash' ? `${route}#${_id}` : _id;
19
+
20
+ return <MosaicLinkHeading id={id} {...props} />;
21
+ });
@@ -0,0 +1,20 @@
1
+ import { Button, Flex, Text } from '@stoplight/mosaic';
2
+ import * as React from 'react';
3
+
4
+ interface LoadMoreProps {
5
+ loading: boolean;
6
+ onClick: () => void;
7
+ }
8
+
9
+ export const LoadMore: React.FC<LoadMoreProps> = ({ loading, onClick }) => {
10
+ return (
11
+ <Flex flexDirection="col" justifyContent="center" alignItems="center" style={{ height: '400px' }}>
12
+ <Button aria-label="load-example" onPress={onClick} appearance="minimal" loading={loading} disabled={loading}>
13
+ {loading ? 'Loading...' : 'Load examples'}
14
+ </Button>
15
+ <Text fontSize="base" textAlign="center">
16
+ Large examples are not rendered by default.
17
+ </Text>
18
+ </Flex>
19
+ );
20
+ };
@@ -0,0 +1,9 @@
1
+ import { faCircleNotch } from '@fortawesome/free-solid-svg-icons';
2
+ import { Flex, Icon } from '@stoplight/mosaic';
3
+ import React from 'react';
4
+
5
+ export const Loading = () => (
6
+ <Flex justify="center" alignItems="center" w="full" minH="screen" color="muted">
7
+ <Icon icon={faCircleNotch} size="3x" spin />
8
+ </Flex>
9
+ );
@@ -0,0 +1,25 @@
1
+ import { Box } from '@stoplight/mosaic';
2
+ import * as React from 'react';
3
+
4
+ import { LogoProps } from '../types';
5
+
6
+ export const Logo: React.FC<{ logo: LogoProps }> = ({ logo }) => {
7
+ return (
8
+ <Box
9
+ display="inline"
10
+ mr={3}
11
+ rounded="lg"
12
+ overflowY="hidden"
13
+ overflowX="hidden"
14
+ style={{ backgroundColor: logo.backgroundColor ?? 'transparent' }}
15
+ >
16
+ {logo.href ? (
17
+ <a href={logo.href} target="_blank" rel="noopener noreferrer">
18
+ <img src={logo.url} height="30px" width="30px" alt={logo.altText} />
19
+ </a>
20
+ ) : (
21
+ <img src={logo.url} height="30px" width="30px" alt={logo.altText} />
22
+ )}
23
+ </Box>
24
+ );
25
+ };