@patternfly/quickstarts 2.2.3 → 2.3.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 (198) hide show
  1. package/README.md +4 -4
  2. package/dist/ConsoleShared/src/components/markdown-extensions/inline-clipboard-extension.d.ts +1 -1
  3. package/dist/ConsoleShared/src/components/markdown-extensions/multiline-clipboard-extension.d.ts +1 -1
  4. package/dist/HelpTopicDrawer.d.ts +8 -2
  5. package/dist/QuickStartDrawer.d.ts +21 -2
  6. package/dist/controller/QuickStartTaskHeader.d.ts +1 -1
  7. package/dist/index.es.js +14 -13
  8. package/dist/index.es.js.map +1 -1
  9. package/dist/index.js +14 -13
  10. package/dist/index.js.map +1 -1
  11. package/dist/patternfly-docs/quick-starts/design-guidelines/design-guidelines.md +105 -0
  12. package/dist/patternfly-docs/quick-starts/design-guidelines/img/card-elements copy.png +0 -0
  13. package/dist/patternfly-docs/quick-starts/design-guidelines/img/card-elements.png +0 -0
  14. package/dist/patternfly-docs/quick-starts/design-guidelines/img/catalog-elements.png +0 -0
  15. package/dist/patternfly-docs/quick-starts/design-guidelines/img/check-your-work.png +0 -0
  16. package/dist/patternfly-docs/quick-starts/design-guidelines/img/introduction-screen.png +0 -0
  17. package/dist/patternfly-docs/quick-starts/design-guidelines/img/mixed-catalog.png +0 -0
  18. package/dist/patternfly-docs/quick-starts/design-guidelines/img/prerequisites.png +0 -0
  19. package/dist/patternfly-docs/quick-starts/design-guidelines/img/qs-context.png +0 -0
  20. package/dist/patternfly-docs/quick-starts/design-guidelines/img/side-panel-elements.png +0 -0
  21. package/dist/patternfly-docs/quick-starts/design-guidelines/img/side-panel-resized.png +0 -0
  22. package/dist/patternfly-docs/quick-starts/design-guidelines/img/side-panel.png +0 -0
  23. package/dist/patternfly-docs/quick-starts/design-guidelines/img/task-no.png +0 -0
  24. package/dist/patternfly-docs/quick-starts/design-guidelines/img/task-yes.png +0 -0
  25. package/dist/patternfly-docs/quick-starts/design-guidelines/img/task.png +0 -0
  26. package/dist/patternfly-docs/quick-starts/examples/Basic.jsx +73 -0
  27. package/dist/patternfly-docs/quick-starts/examples/HelpTopic.jsx +53 -0
  28. package/dist/patternfly-docs/quick-starts/examples/about.md +77 -0
  29. package/dist/patternfly-docs/quick-starts/examples/basic.md +27 -0
  30. package/dist/patternfly-docs/quick-starts/examples/example-data/example-help-topics.js +173 -0
  31. package/dist/patternfly-docs/quick-starts/examples/example-data/example-quickstarts.js +215 -0
  32. package/dist/patternfly-docs/quick-starts/examples/example-data/index.js +15 -0
  33. package/dist/patternfly-docs/quick-starts/examples/help-topics.md +25 -0
  34. package/dist/patternfly-docs/quick-starts/examples/img/catalog.png +0 -0
  35. package/dist/patternfly-docs/quick-starts/examples/img/help-topic.png +0 -0
  36. package/dist/patternfly-docs/quick-starts/examples/img/side-panel.png +0 -0
  37. package/dist/quickstarts-base.css +24 -24
  38. package/dist/quickstarts-full.es.js +14 -13
  39. package/dist/quickstarts-full.es.js.map +1 -1
  40. package/dist/quickstarts.css +24 -24
  41. package/dist/quickstarts.min.css +1 -1
  42. package/package.json +11 -4
  43. package/src/ConsoleInternal/components/_icon-and-text.scss +14 -0
  44. package/src/ConsoleInternal/components/_markdown-view.scss +19 -0
  45. package/src/ConsoleInternal/components/catalog/_catalog.scss +390 -0
  46. package/src/ConsoleInternal/components/markdown-view.tsx +305 -0
  47. package/src/ConsoleInternal/components/utils/_status-box.scss +58 -0
  48. package/src/ConsoleInternal/components/utils/camel-case-wrap.tsx +33 -0
  49. package/src/ConsoleInternal/components/utils/index.tsx +3 -0
  50. package/src/ConsoleInternal/components/utils/router.ts +47 -0
  51. package/src/ConsoleInternal/components/utils/status-box.tsx +94 -0
  52. package/src/ConsoleInternal/module/k8s/types.ts +53 -0
  53. package/src/ConsoleShared/index.ts +1 -0
  54. package/src/ConsoleShared/src/components/index.ts +7 -0
  55. package/src/ConsoleShared/src/components/layout/PageLayout.scss +29 -0
  56. package/src/ConsoleShared/src/components/markdown-extensions/MarkdownCopyClipboard.tsx +93 -0
  57. package/src/ConsoleShared/src/components/markdown-extensions/__tests__/MarkdownCopyClipboard.spec.tsx +25 -0
  58. package/src/ConsoleShared/src/components/markdown-extensions/__tests__/test-data.ts +5 -0
  59. package/src/ConsoleShared/src/components/markdown-extensions/admonition-extension.tsx +66 -0
  60. package/src/ConsoleShared/src/components/markdown-extensions/code-extension.tsx +25 -0
  61. package/src/ConsoleShared/src/components/markdown-extensions/const.ts +3 -0
  62. package/src/ConsoleShared/src/components/markdown-extensions/index.ts +5 -0
  63. package/src/ConsoleShared/src/components/markdown-extensions/inline-clipboard-extension.tsx +39 -0
  64. package/src/ConsoleShared/src/components/markdown-extensions/multiline-clipboard-extension.tsx +44 -0
  65. package/src/ConsoleShared/src/components/markdown-extensions/showdown-extension.scss +52 -0
  66. package/src/ConsoleShared/src/components/markdown-extensions/utils.ts +3 -0
  67. package/src/ConsoleShared/src/components/markdown-highlight-extension/MarkdownHighlightExtension.tsx +64 -0
  68. package/src/ConsoleShared/src/components/markdown-highlight-extension/highlight-consts.ts +9 -0
  69. package/src/ConsoleShared/src/components/markdown-highlight-extension/index.ts +1 -0
  70. package/src/ConsoleShared/src/components/modal/Modal.scss +3 -0
  71. package/src/ConsoleShared/src/components/modal/Modal.tsx +19 -0
  72. package/src/ConsoleShared/src/components/modal/index.ts +1 -0
  73. package/src/ConsoleShared/src/components/popper/Portal.tsx +23 -0
  74. package/src/ConsoleShared/src/components/popper/SimplePopper.tsx +90 -0
  75. package/src/ConsoleShared/src/components/popper/index.ts +2 -0
  76. package/src/ConsoleShared/src/components/spotlight/InteractiveSpotlight.tsx +58 -0
  77. package/src/ConsoleShared/src/components/spotlight/Spotlight.tsx +35 -0
  78. package/src/ConsoleShared/src/components/spotlight/StaticSpotlight.tsx +32 -0
  79. package/src/ConsoleShared/src/components/spotlight/index.ts +1 -0
  80. package/src/ConsoleShared/src/components/spotlight/spotlight.scss +63 -0
  81. package/src/ConsoleShared/src/components/status/GenericStatus.tsx +33 -0
  82. package/src/ConsoleShared/src/components/status/NotStartedIcon.tsx +27 -0
  83. package/src/ConsoleShared/src/components/status/PopoverStatus.tsx +42 -0
  84. package/src/ConsoleShared/src/components/status/Status.tsx +38 -0
  85. package/src/ConsoleShared/src/components/status/StatusIconAndText.tsx +42 -0
  86. package/src/ConsoleShared/src/components/status/icons.tsx +77 -0
  87. package/src/ConsoleShared/src/components/status/index.tsx +1 -0
  88. package/src/ConsoleShared/src/components/status/statuses.tsx +36 -0
  89. package/src/ConsoleShared/src/components/status/types.ts +7 -0
  90. package/src/ConsoleShared/src/components/utils/FallbackImg.tsx +20 -0
  91. package/src/ConsoleShared/src/components/utils/index.ts +1 -0
  92. package/src/ConsoleShared/src/constants/index.ts +1 -0
  93. package/src/ConsoleShared/src/constants/ui.ts +1 -0
  94. package/src/ConsoleShared/src/hooks/index.ts +6 -0
  95. package/src/ConsoleShared/src/hooks/scroll.ts +52 -0
  96. package/src/ConsoleShared/src/hooks/useBoundingClientRect.ts +18 -0
  97. package/src/ConsoleShared/src/hooks/useEventListener.ts +14 -0
  98. package/src/ConsoleShared/src/hooks/useForceRender.ts +6 -0
  99. package/src/ConsoleShared/src/hooks/useResizeObserver.ts +20 -0
  100. package/src/ConsoleShared/src/hooks/useScrollShadows.ts +45 -0
  101. package/src/ConsoleShared/src/index.ts +4 -0
  102. package/src/ConsoleShared/src/utils/index.ts +1 -0
  103. package/src/ConsoleShared/src/utils/useCombineRefs.ts +17 -0
  104. package/src/HelpTopicDrawer.tsx +124 -0
  105. package/src/HelpTopicPanelContent.tsx +152 -0
  106. package/src/QuickStartCatalogPage.tsx +190 -0
  107. package/src/QuickStartCloseModal.tsx +47 -0
  108. package/src/QuickStartController.tsx +113 -0
  109. package/src/QuickStartDrawer.scss +11 -0
  110. package/src/QuickStartDrawer.tsx +265 -0
  111. package/src/QuickStartMarkdownView.tsx +75 -0
  112. package/src/QuickStartPanelContent.scss +46 -0
  113. package/src/QuickStartPanelContent.tsx +153 -0
  114. package/src/__tests__/quick-start-utils.spec.tsx +16 -0
  115. package/src/catalog/Catalog/QuickStartCatalogHeader.tsx +18 -0
  116. package/src/catalog/Catalog/QuickStartCatalogSection.tsx +9 -0
  117. package/src/catalog/Catalog/QuickStartCatalogToolbar.tsx +12 -0
  118. package/src/catalog/Catalog/index.ts +3 -0
  119. package/src/catalog/QuickStartCatalog.scss +8 -0
  120. package/src/catalog/QuickStartCatalog.tsx +42 -0
  121. package/src/catalog/QuickStartTile.scss +11 -0
  122. package/src/catalog/QuickStartTile.tsx +105 -0
  123. package/src/catalog/QuickStartTileDescription.scss +29 -0
  124. package/src/catalog/QuickStartTileDescription.tsx +79 -0
  125. package/src/catalog/QuickStartTileFooter.tsx +101 -0
  126. package/src/catalog/QuickStartTileFooterExternal.tsx +40 -0
  127. package/src/catalog/QuickStartTileHeader.scss +12 -0
  128. package/src/catalog/QuickStartTileHeader.tsx +77 -0
  129. package/src/catalog/Toolbar/QuickStartCatalogFilter.scss +25 -0
  130. package/src/catalog/Toolbar/QuickStartCatalogFilter.tsx +34 -0
  131. package/src/catalog/Toolbar/QuickStartCatalogFilterItems.tsx +199 -0
  132. package/src/catalog/__tests__/QuickStartCatalog.spec.tsx +35 -0
  133. package/src/catalog/__tests__/QuickStartTile.spec.tsx +38 -0
  134. package/src/catalog/__tests__/QuickStartTileDescription.spec.tsx +44 -0
  135. package/src/catalog/index.ts +9 -0
  136. package/src/controller/QuickStartConclusion.tsx +63 -0
  137. package/src/controller/QuickStartContent.scss +12 -0
  138. package/src/controller/QuickStartContent.tsx +72 -0
  139. package/src/controller/QuickStartFooter.scss +13 -0
  140. package/src/controller/QuickStartFooter.tsx +128 -0
  141. package/src/controller/QuickStartIntroduction.scss +35 -0
  142. package/src/controller/QuickStartIntroduction.tsx +66 -0
  143. package/src/controller/QuickStartTaskHeader.scss +58 -0
  144. package/src/controller/QuickStartTaskHeader.tsx +116 -0
  145. package/src/controller/QuickStartTaskHeaderList.scss +17 -0
  146. package/src/controller/QuickStartTaskHeaderList.tsx +35 -0
  147. package/src/controller/QuickStartTaskReview.scss +30 -0
  148. package/src/controller/QuickStartTaskReview.tsx +81 -0
  149. package/src/controller/QuickStartTasks.scss +89 -0
  150. package/src/controller/QuickStartTasks.tsx +75 -0
  151. package/src/controller/__tests__/QuickStartConclusion.spec.tsx +95 -0
  152. package/src/controller/__tests__/QuickStartContent.spec.tsx +52 -0
  153. package/src/controller/__tests__/QuickStartFooter.spec.tsx +148 -0
  154. package/src/controller/__tests__/QuickStartTaskHeader.spec.tsx +56 -0
  155. package/src/controller/__tests__/QuickStartTaskReview.spec.tsx +45 -0
  156. package/src/controller/__tests__/QuickStartTasks.spec.tsx +81 -0
  157. package/src/data/mocks/json/explore-pipeline-quickstart.ts +66 -0
  158. package/src/data/mocks/json/explore-serverless-quickstart.ts +90 -0
  159. package/src/data/mocks/json/monitor-sampleapp-quickstart.ts +77 -0
  160. package/src/data/mocks/json/tour-icons.ts +3 -0
  161. package/src/data/mocks/yamls/add-healthchecks-quickstart.yaml +67 -0
  162. package/src/data/mocks/yamls/explore-pipeline-quickstart.yaml +57 -0
  163. package/src/data/mocks/yamls/explore-serverless-quickstart.yaml +83 -0
  164. package/src/data/mocks/yamls/install-associate-pipeline-quickstart.yaml +74 -0
  165. package/src/data/mocks/yamls/monitor-sampleapp-quickstart.yaml +66 -0
  166. package/src/data/mocks/yamls/sample-application-quickstart.yaml +97 -0
  167. package/src/data/mocks/yamls/serverless-application-quickstart.yaml +141 -0
  168. package/src/data/quick-start-test-data.ts +10 -0
  169. package/src/data/test-utils.ts +11 -0
  170. package/src/declaration.d.ts +2 -0
  171. package/src/index.ts +17 -0
  172. package/src/locales/en/quickstart.json +46 -0
  173. package/src/styles/_base.scss +54 -0
  174. package/src/styles/_dark-custom-override.scss +62 -0
  175. package/src/styles/legacy-bootstrap/README.md +21 -0
  176. package/src/styles/legacy-bootstrap/_code.scss +44 -0
  177. package/src/styles/legacy-bootstrap/_tables.scss +38 -0
  178. package/src/styles/legacy-bootstrap/_type.scss +90 -0
  179. package/src/styles/legacy-bootstrap/_variables.scss +48 -0
  180. package/src/styles/legacy-bootstrap.scss +5 -0
  181. package/src/styles/patternfly-global-entry.ts +1 -0
  182. package/src/styles/patternfly-global.scss +28 -0
  183. package/src/styles/patternfly-nested-entry.ts +1 -0
  184. package/src/styles/patternfly-nested.scss +18 -0
  185. package/src/styles/quickstarts-standalone-entry.ts +1 -0
  186. package/src/styles/quickstarts-standalone.scss +7 -0
  187. package/src/styles/style.scss +12 -0
  188. package/src/styles/vendor-entry.ts +1 -0
  189. package/src/styles/vendor.scss +7 -0
  190. package/src/utils/PluralResolver.ts +356 -0
  191. package/src/utils/asciidoc-procedure-parser.ts +132 -0
  192. package/src/utils/const.ts +10 -0
  193. package/src/utils/help-topic-context.tsx +74 -0
  194. package/src/utils/help-topic-types.ts +16 -0
  195. package/src/utils/quick-start-context.tsx +477 -0
  196. package/src/utils/quick-start-types.ts +72 -0
  197. package/src/utils/quick-start-utils.ts +92 -0
  198. package/src/utils/useLocalStorage.ts +38 -0
package/dist/index.js CHANGED
@@ -1243,12 +1243,13 @@ const CopyClipboard = ({ element, rootSelector, docContext, }) => {
1243
1243
  const { getResource } = React__namespace.useContext(QuickStartContext);
1244
1244
  const [showSuccessContent, setShowSuccessContent] = React__namespace.useState(false);
1245
1245
  const textToCopy = React__namespace.useMemo(() => {
1246
+ var _a;
1246
1247
  const copyTextId = element.getAttribute(MARKDOWN_COPY_BUTTON_ID);
1247
- return docContext.querySelector(`${rootSelector} [${MARKDOWN_SNIPPET_ID}="${copyTextId}"]`).innerText;
1248
+ return (_a = docContext.querySelector(`${rootSelector} [${MARKDOWN_SNIPPET_ID}="${copyTextId}"]`)) === null || _a === void 0 ? void 0 : _a.innerText;
1248
1249
  }, [element, docContext, rootSelector]);
1249
1250
  useEventListener(element, 'click', React__namespace.useCallback(() => {
1250
1251
  navigator.clipboard
1251
- .writeText(textToCopy)
1252
+ .writeText(textToCopy.trim())
1252
1253
  .then(() => {
1253
1254
  setShowSuccessContent(true);
1254
1255
  })
@@ -1276,15 +1277,15 @@ const useInlineCopyClipboardShowdownExtension = () => {
1276
1277
  return React__namespace.useMemo(() => ({
1277
1278
  type: 'lang',
1278
1279
  regex: /`([^`](.*?)[^`])`{{copy}}/g,
1279
- replace: (text, group, subGroup, groupType, groupId) => {
1280
- if (!group || !subGroup || !groupType || !groupId) {
1280
+ replace: (text, group, _, groupId) => {
1281
+ if (!group || isNaN(groupId)) {
1281
1282
  return text;
1282
1283
  }
1283
1284
  return removeTemplateWhitespace(`<span class="pf-c-clipboard-copy pf-m-inline">
1284
- <span class="pf-c-clipboard-copy__text" ${MARKDOWN_SNIPPET_ID}="${groupType}">${group}</span>
1285
+ <span class="pf-c-clipboard-copy__text" ${MARKDOWN_SNIPPET_ID}="${groupId}">${group}</span>
1285
1286
  <span class="pf-c-clipboard-copy__actions">
1286
1287
  <span class="pf-c-clipboard-copy__actions-item">
1287
- <button class="pf-c-button pf-m-plain" aria-label="${getResource('Copy to clipboard')}" ${MARKDOWN_COPY_BUTTON_ID}="${groupType}">
1288
+ <button class="pf-c-button pf-m-plain" aria-label="${getResource('Copy to clipboard')}" ${MARKDOWN_COPY_BUTTON_ID}="${groupId}">
1288
1289
  ${server.renderToStaticMarkup(React__namespace.createElement(CopyIcon__default['default'], null))}
1289
1290
  </button>
1290
1291
  </span>
@@ -1298,16 +1299,16 @@ const useMultilineCopyClipboardShowdownExtension = () => {
1298
1299
  const { getResource } = React__namespace.useContext(QuickStartContext);
1299
1300
  return React__namespace.useMemo(() => ({
1300
1301
  type: 'lang',
1301
- regex: /```[\n]((.*?\n)+)```{{copy}}/g,
1302
- replace: (text, group, subgroup, groupType, groupId) => {
1303
- if (!group || !subgroup || !groupType || !groupId) {
1302
+ regex: /```[\n]\s*((((?!```).)*?\n)+)\s*```{{copy}}/g,
1303
+ replace: (text, group, _1, _2, groupId) => {
1304
+ if (!group || isNaN(groupId)) {
1304
1305
  return text;
1305
1306
  }
1306
1307
  return `<div class="pf-c-code-block">
1307
1308
  <div class="pf-c-code-block__header">
1308
1309
  <div class="pf-c-code-block__actions">
1309
1310
  <div class="pf-c-code-block__actions-item">
1310
- <button class="pf-c-button pf-m-plain" type="button" aria-label="${getResource('Copy to clipboard')}" ${MARKDOWN_COPY_BUTTON_ID}="${groupType}">
1311
+ <button class="pf-c-button pf-m-plain" type="button" aria-label="${getResource('Copy to clipboard')}" ${MARKDOWN_COPY_BUTTON_ID}="${groupId}">
1311
1312
  ${server.renderToStaticMarkup(React__namespace.createElement(CopyIcon__default['default'], null))}
1312
1313
  </button>
1313
1314
  </div>
@@ -1316,7 +1317,7 @@ const useMultilineCopyClipboardShowdownExtension = () => {
1316
1317
  <div class="pf-c-code-block__content">
1317
1318
  <pre class="pf-c-code-block__pre pfext-code-block__pre">
1318
1319
  <code class="pf-c-code-block__code"
1319
- ${MARKDOWN_SNIPPET_ID}="${groupType}">${group}</code>
1320
+ ${MARKDOWN_SNIPPET_ID}="${groupId}">${group.trim()}</code>
1320
1321
  </pre>
1321
1322
  </div>
1322
1323
  </div>`;
@@ -1343,7 +1344,7 @@ const useAdmonitionShowdownExtension = () => {
1343
1344
  // const { getResource } = React.useContext<QuickStartContextValues>(QuickStartContext);
1344
1345
  return React__namespace.useMemo(() => ({
1345
1346
  type: 'lang',
1346
- regex: /\[([\d\w\s-()$!]+)]{{(admonition) ([\w-]+)}}/g,
1347
+ regex: /\[(.+)]{{(admonition) ([\w-]+)}}/g,
1347
1348
  replace: (text, content, admonitionLabel, admonitionType, groupId) => {
1348
1349
  if (!content || !admonitionLabel || !admonitionType || !groupId) {
1349
1350
  return text;
@@ -2413,7 +2414,7 @@ const HelpTopicPanelContent = (_a) => {
2413
2414
  const paddingContainer = (children) => React__namespace.createElement("div", { style: { padding: '24px' } }, children);
2414
2415
  const panelBodyItems = (React__namespace.createElement(React__namespace.Fragment, null,
2415
2416
  paddingContainer(React__namespace.createElement(QuickStartMarkdownView, { content: activeHelpTopic === null || activeHelpTopic === void 0 ? void 0 : activeHelpTopic.content })),
2416
- ((_b = activeHelpTopic === null || activeHelpTopic === void 0 ? void 0 : activeHelpTopic.links) === null || _b === void 0 ? void 0 : _b.length) && React__namespace.createElement(reactCore.Divider, null),
2417
+ !!((_b = activeHelpTopic === null || activeHelpTopic === void 0 ? void 0 : activeHelpTopic.links) === null || _b === void 0 ? void 0 : _b.length) && React__namespace.createElement(reactCore.Divider, null),
2417
2418
  paddingContainer(React__namespace.createElement(reactCore.Stack, { hasGutter: true }, (_c = activeHelpTopic === null || activeHelpTopic === void 0 ? void 0 : activeHelpTopic.links) === null || _c === void 0 ? void 0 : _c.map(({ href, text, newTab, isExternal }, index) => {
2418
2419
  return (React__namespace.createElement(reactCore.StackItem, { key: index },
2419
2420
  React__namespace.createElement(reactCore.Button, { component: "a", href: href, target: newTab ? '_blank' : '', rel: "noopener noreferrer", variant: "link", "aria-label": `Open documentation in new window`, isInline: true, icon: isExternal ? React__namespace.createElement(ExternalLinkAltIcon__default['default'], null) : null, iconPosition: "right", style: { fontSize: 'inherit' } }, text || href)));