@patternfly/quickstarts 2.4.2 → 5.0.0-prerelease.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 (207) hide show
  1. package/README.md +32 -23
  2. package/dist/ConsoleInternal/components/markdown-view.d.ts +19 -19
  3. package/dist/ConsoleInternal/components/utils/camel-case-wrap.d.ts +6 -6
  4. package/dist/ConsoleInternal/components/utils/index.d.ts +3 -3
  5. package/dist/ConsoleInternal/components/utils/router.d.ts +9 -9
  6. package/dist/ConsoleInternal/components/utils/status-box.d.ts +20 -20
  7. package/dist/ConsoleInternal/module/k8s/types.d.ts +42 -42
  8. package/dist/ConsoleShared/index.d.ts +1 -1
  9. package/dist/ConsoleShared/src/components/index.d.ts +7 -7
  10. package/dist/ConsoleShared/src/components/markdown-extensions/MarkdownCopyClipboard.d.ts +13 -13
  11. package/dist/ConsoleShared/src/components/markdown-extensions/accordion-extension.d.ts +7 -7
  12. package/dist/ConsoleShared/src/components/markdown-extensions/accordion-render-extension.d.ts +6 -6
  13. package/dist/ConsoleShared/src/components/markdown-extensions/admonition-extension.d.ts +7 -7
  14. package/dist/ConsoleShared/src/components/markdown-extensions/code-extension.d.ts +7 -7
  15. package/dist/ConsoleShared/src/components/markdown-extensions/const.d.ts +5 -5
  16. package/dist/ConsoleShared/src/components/markdown-extensions/index.d.ts +7 -7
  17. package/dist/ConsoleShared/src/components/markdown-extensions/inline-clipboard-extension.d.ts +7 -7
  18. package/dist/ConsoleShared/src/components/markdown-extensions/multiline-clipboard-extension.d.ts +7 -7
  19. package/dist/ConsoleShared/src/components/markdown-extensions/utils.d.ts +1 -1
  20. package/dist/ConsoleShared/src/components/markdown-highlight-extension/MarkdownHighlightExtension.d.ts +7 -7
  21. package/dist/ConsoleShared/src/components/markdown-highlight-extension/highlight-consts.d.ts +4 -4
  22. package/dist/ConsoleShared/src/components/markdown-highlight-extension/index.d.ts +1 -1
  23. package/dist/ConsoleShared/src/components/modal/Modal.d.ts +9 -9
  24. package/dist/ConsoleShared/src/components/modal/index.d.ts +1 -1
  25. package/dist/ConsoleShared/src/components/popper/Portal.d.ts +8 -7
  26. package/dist/ConsoleShared/src/components/popper/SimplePopper.d.ts +6 -3
  27. package/dist/ConsoleShared/src/components/popper/index.d.ts +2 -2
  28. package/dist/ConsoleShared/src/components/spotlight/InteractiveSpotlight.d.ts +7 -7
  29. package/dist/ConsoleShared/src/components/spotlight/Spotlight.d.ts +7 -7
  30. package/dist/ConsoleShared/src/components/spotlight/StaticSpotlight.d.ts +7 -7
  31. package/dist/ConsoleShared/src/components/spotlight/index.d.ts +1 -1
  32. package/dist/ConsoleShared/src/components/status/GenericStatus.d.ts +12 -11
  33. package/dist/ConsoleShared/src/components/status/NotStartedIcon.d.ts +3 -2
  34. package/dist/ConsoleShared/src/components/status/PopoverStatus.d.ts +13 -12
  35. package/dist/ConsoleShared/src/components/status/Status.d.ts +11 -11
  36. package/dist/ConsoleShared/src/components/status/StatusIconAndText.d.ts +8 -8
  37. package/dist/ConsoleShared/src/components/status/icons.d.ts +9 -9
  38. package/dist/ConsoleShared/src/components/status/index.d.ts +1 -1
  39. package/dist/ConsoleShared/src/components/status/statuses.d.ts +5 -5
  40. package/dist/ConsoleShared/src/components/status/types.d.ts +9 -7
  41. package/dist/ConsoleShared/src/components/utils/FallbackImg.d.ts +9 -9
  42. package/dist/ConsoleShared/src/components/utils/index.d.ts +1 -1
  43. package/dist/ConsoleShared/src/constants/index.d.ts +1 -1
  44. package/dist/ConsoleShared/src/constants/ui.d.ts +1 -1
  45. package/dist/ConsoleShared/src/hooks/index.d.ts +6 -6
  46. package/dist/ConsoleShared/src/hooks/scroll.d.ts +8 -8
  47. package/dist/ConsoleShared/src/hooks/useBoundingClientRect.d.ts +3 -1
  48. package/dist/ConsoleShared/src/hooks/useEventListener.d.ts +1 -1
  49. package/dist/ConsoleShared/src/hooks/useForceRender.d.ts +4 -4
  50. package/dist/ConsoleShared/src/hooks/useResizeObserver.d.ts +1 -1
  51. package/dist/ConsoleShared/src/hooks/useScrollShadows.d.ts +7 -7
  52. package/dist/ConsoleShared/src/index.d.ts +4 -4
  53. package/dist/ConsoleShared/src/utils/index.d.ts +1 -1
  54. package/dist/ConsoleShared/src/utils/useCombineRefs.d.ts +2 -2
  55. package/dist/HelpTopicDrawer.d.ts +33 -32
  56. package/dist/HelpTopicPanelContent.d.ts +11 -11
  57. package/dist/QuickStartCatalogPage.d.ts +14 -14
  58. package/dist/QuickStartCloseModal.d.ts +8 -8
  59. package/dist/QuickStartController.d.ts +10 -10
  60. package/dist/QuickStartDrawer.d.ts +62 -62
  61. package/dist/QuickStartMarkdownView.d.ts +9 -9
  62. package/dist/QuickStartPanelContent.d.ts +15 -15
  63. package/dist/catalog/Catalog/QuickStartCatalogHeader.d.ts +6 -6
  64. package/dist/catalog/Catalog/QuickStartCatalogSection.d.ts +5 -5
  65. package/dist/catalog/Catalog/QuickStartCatalogToolbar.d.ts +5 -5
  66. package/dist/catalog/Catalog/index.d.ts +3 -3
  67. package/dist/catalog/QuickStartCatalog.d.ts +8 -8
  68. package/dist/catalog/QuickStartTile.d.ts +11 -11
  69. package/dist/catalog/QuickStartTileDescription.d.ts +8 -8
  70. package/dist/catalog/QuickStartTileFooter.d.ts +8 -8
  71. package/dist/catalog/QuickStartTileFooterExternal.d.ts +8 -8
  72. package/dist/catalog/QuickStartTileHeader.d.ts +12 -12
  73. package/dist/catalog/Toolbar/QuickStartCatalogFilter.d.ts +10 -10
  74. package/dist/catalog/Toolbar/QuickStartCatalogFilterItems.d.ts +31 -31
  75. package/dist/catalog/index.d.ts +9 -9
  76. package/dist/controller/QuickStartConclusion.d.ts +12 -12
  77. package/dist/controller/QuickStartContent.d.ts +14 -14
  78. package/dist/controller/QuickStartFooter.d.ts +14 -14
  79. package/dist/controller/QuickStartIntroduction.d.ts +12 -12
  80. package/dist/controller/QuickStartTaskHeader.d.ts +15 -15
  81. package/dist/controller/QuickStartTaskHeaderList.d.ts +10 -10
  82. package/dist/controller/QuickStartTaskReview.d.ts +10 -10
  83. package/dist/controller/QuickStartTasks.d.ts +12 -12
  84. package/dist/data/mocks/json/explore-pipeline-quickstart.d.ts +2 -2
  85. package/dist/data/mocks/json/explore-serverless-quickstart.d.ts +2 -2
  86. package/dist/data/mocks/json/monitor-sampleapp-quickstart.d.ts +2 -2
  87. package/dist/data/mocks/json/tour-icons.d.ts +2 -2
  88. package/dist/data/quick-start-test-data.d.ts +2 -2
  89. package/dist/data/test-utils.d.ts +8 -7
  90. package/dist/index.d.ts +16 -16
  91. package/dist/index.es.js +2340 -2390
  92. package/dist/index.es.js.map +1 -1
  93. package/dist/index.js +2340 -2389
  94. package/dist/index.js.map +1 -1
  95. package/dist/patternfly-docs/quick-starts/examples/Basic.jsx +1 -1
  96. package/dist/patternfly-docs/quick-starts/examples/HelpTopic.jsx +2 -4
  97. package/dist/patternfly-global.css +752 -1110
  98. package/dist/patternfly-nested.css +9248 -9609
  99. package/dist/quickstarts-base.css +173 -173
  100. package/dist/quickstarts-full.es.js +19535 -10749
  101. package/dist/quickstarts-full.es.js.map +1 -1
  102. package/dist/quickstarts-standalone.css +216 -219
  103. package/dist/quickstarts-standalone.min.css +4 -4
  104. package/dist/quickstarts-vendor.css +71 -71
  105. package/dist/quickstarts.css +244 -244
  106. package/dist/quickstarts.min.css +1 -1
  107. package/dist/styles/patternfly-global-entry.d.ts +1 -1
  108. package/dist/styles/patternfly-nested-entry.d.ts +1 -1
  109. package/dist/styles/quickstarts-standalone-entry.d.ts +1 -1
  110. package/dist/styles/vendor-entry.d.ts +1 -1
  111. package/dist/utils/PluralResolver.d.ts +16 -10
  112. package/dist/utils/asciidoc-procedure-parser.d.ts +12 -12
  113. package/dist/utils/const.d.ts +6 -6
  114. package/dist/utils/help-topic-context.d.ts +23 -23
  115. package/dist/utils/help-topic-types.d.ts +13 -13
  116. package/dist/utils/quick-start-context.d.ts +81 -81
  117. package/dist/utils/quick-start-types.d.ts +60 -58
  118. package/dist/utils/quick-start-utils.d.ts +10 -10
  119. package/dist/utils/useLocalStorage.d.ts +1 -1
  120. package/package.json +17 -13
  121. package/src/ConsoleInternal/components/_icon-and-text.scss +2 -2
  122. package/src/ConsoleInternal/components/catalog/_catalog.scss +20 -20
  123. package/src/ConsoleInternal/components/markdown-view.tsx +23 -52
  124. package/src/ConsoleInternal/components/utils/_status-box.scss +1 -1
  125. package/src/ConsoleInternal/components/utils/camel-case-wrap.tsx +3 -3
  126. package/src/ConsoleInternal/components/utils/router.ts +0 -2
  127. package/src/ConsoleInternal/components/utils/status-box.tsx +8 -46
  128. package/src/ConsoleInternal/module/k8s/types.ts +6 -6
  129. package/src/ConsoleShared/src/components/layout/PageLayout.scss +10 -10
  130. package/src/ConsoleShared/src/components/markdown-extensions/MarkdownCopyClipboard.tsx +13 -11
  131. package/src/ConsoleShared/src/components/markdown-extensions/accordion-extension.tsx +3 -4
  132. package/src/ConsoleShared/src/components/markdown-extensions/accordion-render-extension.tsx +7 -7
  133. package/src/ConsoleShared/src/components/markdown-extensions/admonition-extension.tsx +4 -4
  134. package/src/ConsoleShared/src/components/markdown-extensions/code-extension.tsx +1 -3
  135. package/src/ConsoleShared/src/components/markdown-extensions/inline-clipboard-extension.tsx +5 -5
  136. package/src/ConsoleShared/src/components/markdown-extensions/multiline-clipboard-extension.tsx +8 -8
  137. package/src/ConsoleShared/src/components/markdown-extensions/showdown-extension.scss +5 -5
  138. package/src/ConsoleShared/src/components/markdown-extensions/utils.ts +1 -3
  139. package/src/ConsoleShared/src/components/markdown-highlight-extension/MarkdownHighlightExtension.tsx +7 -6
  140. package/src/ConsoleShared/src/components/popper/Portal.tsx +6 -4
  141. package/src/ConsoleShared/src/components/popper/SimplePopper.tsx +7 -5
  142. package/src/ConsoleShared/src/components/spotlight/InteractiveSpotlight.tsx +2 -2
  143. package/src/ConsoleShared/src/components/spotlight/Spotlight.tsx +2 -2
  144. package/src/ConsoleShared/src/components/spotlight/StaticSpotlight.tsx +3 -3
  145. package/src/ConsoleShared/src/components/spotlight/spotlight.scss +4 -4
  146. package/src/ConsoleShared/src/components/status/GenericStatus.tsx +1 -0
  147. package/src/ConsoleShared/src/components/status/PopoverStatus.tsx +20 -23
  148. package/src/ConsoleShared/src/components/status/Status.tsx +2 -2
  149. package/src/ConsoleShared/src/components/status/icons.tsx +17 -55
  150. package/src/ConsoleShared/src/components/status/statuses.tsx +1 -17
  151. package/src/ConsoleShared/src/components/status/types.ts +3 -2
  152. package/src/ConsoleShared/src/components/utils/FallbackImg.tsx +2 -2
  153. package/src/ConsoleShared/src/hooks/useResizeObserver.ts +5 -6
  154. package/src/ConsoleShared/src/utils/useCombineRefs.ts +2 -3
  155. package/src/HelpTopicDrawer.tsx +6 -14
  156. package/src/HelpTopicPanelContent.tsx +57 -49
  157. package/src/QuickStartCatalogPage.tsx +19 -14
  158. package/src/QuickStartCloseModal.tsx +2 -2
  159. package/src/QuickStartController.tsx +3 -5
  160. package/src/QuickStartDrawer.scss +1 -1
  161. package/src/QuickStartDrawer.tsx +2 -2
  162. package/src/QuickStartMarkdownView.tsx +4 -4
  163. package/src/QuickStartPanelContent.scss +8 -8
  164. package/src/QuickStartPanelContent.tsx +8 -9
  165. package/src/catalog/Catalog/QuickStartCatalogHeader.tsx +2 -2
  166. package/src/catalog/Catalog/QuickStartCatalogSection.tsx +2 -2
  167. package/src/catalog/Catalog/QuickStartCatalogToolbar.tsx +2 -2
  168. package/src/catalog/QuickStartCatalog.scss +1 -1
  169. package/src/catalog/QuickStartCatalog.tsx +2 -2
  170. package/src/catalog/QuickStartTile.tsx +20 -15
  171. package/src/catalog/QuickStartTileDescription.scss +4 -4
  172. package/src/catalog/QuickStartTileDescription.tsx +2 -2
  173. package/src/catalog/QuickStartTileFooter.tsx +2 -2
  174. package/src/catalog/QuickStartTileFooterExternal.tsx +2 -2
  175. package/src/catalog/QuickStartTileHeader.scss +5 -5
  176. package/src/catalog/QuickStartTileHeader.tsx +2 -2
  177. package/src/catalog/Toolbar/QuickStartCatalogFilter.scss +9 -9
  178. package/src/catalog/Toolbar/QuickStartCatalogFilter.tsx +1 -3
  179. package/src/catalog/Toolbar/QuickStartCatalogFilterItems.tsx +49 -30
  180. package/src/controller/QuickStartConclusion.tsx +3 -3
  181. package/src/controller/QuickStartContent.scss +2 -2
  182. package/src/controller/QuickStartContent.tsx +2 -2
  183. package/src/controller/QuickStartFooter.scss +3 -3
  184. package/src/controller/QuickStartFooter.tsx +6 -10
  185. package/src/controller/QuickStartIntroduction.scss +7 -7
  186. package/src/controller/QuickStartIntroduction.tsx +5 -7
  187. package/src/controller/QuickStartTaskHeader.scss +15 -15
  188. package/src/controller/QuickStartTaskHeader.tsx +14 -12
  189. package/src/controller/QuickStartTaskHeaderList.scss +1 -1
  190. package/src/controller/QuickStartTaskHeaderList.tsx +3 -5
  191. package/src/controller/QuickStartTaskReview.scss +7 -7
  192. package/src/controller/QuickStartTaskReview.tsx +2 -2
  193. package/src/controller/QuickStartTasks.scss +13 -13
  194. package/src/controller/QuickStartTasks.tsx +2 -2
  195. package/src/controller/__tests__/QuickStartTaskHeader.spec.tsx +4 -17
  196. package/src/styles/_base.scss +5 -5
  197. package/src/styles/_dark-custom-override.scss +28 -28
  198. package/src/styles/legacy-bootstrap/_variables.scss +7 -7
  199. package/src/styles/patternfly-global.scss +6 -6
  200. package/src/styles/patternfly-nested.scss +1 -1
  201. package/src/utils/PluralResolver.ts +29 -23
  202. package/src/utils/asciidoc-procedure-parser.ts +2 -4
  203. package/src/utils/help-topic-context.tsx +3 -5
  204. package/src/utils/help-topic-types.ts +4 -4
  205. package/src/utils/quick-start-context.tsx +8 -12
  206. package/src/utils/quick-start-types.ts +15 -14
  207. package/src/utils/quick-start-utils.ts +2 -6
package/README.md CHANGED
@@ -12,6 +12,7 @@ yarn add @patternfly/quickstarts
12
12
  ### Peer dependencies
13
13
 
14
14
  If your project doesn't already have these installed, you'll need:
15
+
15
16
  ```bash
16
17
  yarn add @patternfly/react-core showdown
17
18
  ```
@@ -28,13 +29,15 @@ import '@patternfly/quickstarts/dist/quickstarts.min.css';
28
29
  ```
29
30
 
30
31
  ### Stylesheets if you use an older version of PatternFly
32
+
31
33
  If you use an older version of @patternfly/react-core (older than "4.115.2"), and you can't upgrade yet, you can pull in the necessary PatternFly styles that @patternfly/quickstarts depends upon.
32
34
 
33
35
  Ideally @patternfly/quickstarts will use the consumer provided PatternFly styles, only use these stylesheets if really needed.
34
36
 
35
- `quickstarts-standalone.min.css` nests the css classes within a **.pfext-quick-start__base** parent, so that they have higher specificity. `patternfly-global.css` includes component styles that we cannot nest with more specificity (for example Drawer since it can include consumer components that depend on an older PF version).
37
+ `quickstarts-standalone.min.css` nests the css classes within a **.pfext-quick-start\_\_base** parent, so that they have higher specificity. `patternfly-global.css` includes component styles that we cannot nest with more specificity (for example Drawer since it can include consumer components that depend on an older PF version).
36
38
 
37
39
  > Note: Only use these stylesheets if necessary!
40
+
38
41
  ```js
39
42
  // import base from PatternFly to get the font
40
43
  import '@patternfly/react-core/dist/styles/base.css';
@@ -49,14 +52,14 @@ import '@patternfly/quickstarts/dist/quickstarts-standalone.min.css';
49
52
  Note: You can also view this example on [codesandbox](https://codesandbox.io/s/patternfly-quickstarts-finished-cnv53)!
50
53
 
51
54
  ```js
52
- import "./styles.css";
55
+ import './styles.css';
53
56
 
54
57
  // base styles/variables for PatternFly-react
55
- import "@patternfly/react-core/dist/styles/base.css";
58
+ import '@patternfly/react-core/dist/styles/base.css';
56
59
  // quick starts styles
57
- import "@patternfly/quickstarts/dist/quickstarts.min.css";
60
+ import '@patternfly/quickstarts/dist/quickstarts.min.css';
58
61
 
59
- import * as React from "react";
62
+ import * as React from 'react';
60
63
  import {
61
64
  QuickStartContainer,
62
65
  QuickStartCatalogPage,
@@ -64,15 +67,15 @@ import {
64
67
  useLocalStorage,
65
68
  setQueryArgument,
66
69
  removeQueryArgument,
67
- QUICKSTART_ID_FILTER_KEY
68
- } from "@patternfly/quickstarts";
69
- import { Button } from "@patternfly/react-core";
70
- import jsYaml from "js-yaml";
70
+ QUICKSTART_ID_FILTER_KEY,
71
+ } from '@patternfly/quickstarts';
72
+ import { Button } from '@patternfly/react-core';
73
+ import jsYaml from 'js-yaml';
71
74
  // quick start files could be yaml files or js files, or really anything,
72
75
  // as long as they get parsed out to the expected JSON format
73
- import quickstartOne from "./quick-starts/quickstart-one.yaml";
74
- import quickstartTwo from "./quick-starts/quickstart-two.yaml";
75
- import quickstartThree from "./quick-starts/quickstart-three";
76
+ import quickstartOne from './quick-starts/quickstart-one.yaml';
77
+ import quickstartTwo from './quick-starts/quickstart-two.yaml';
78
+ import quickstartThree from './quick-starts/quickstart-three';
76
79
 
77
80
  const App = () => {
78
81
  const [quickStarts, setQuickStarts] = React.useState([]);
@@ -80,8 +83,8 @@ const App = () => {
80
83
 
81
84
  // You can use the useLocalStorage hook if you want to store user progress in local storage
82
85
  // Otherwise you can use React.useState here or another means (backend) to store the active quick start ID and state
83
- const [activeQuickStartID, setActiveQuickStartID] = useLocalStorage("quickstartId", "");
84
- const [allQuickStartStates, setAllQuickStartStates] = useLocalStorage("quickstarts", {});
86
+ const [activeQuickStartID, setActiveQuickStartID] = useLocalStorage('quickstartId', '');
87
+ const [allQuickStartStates, setAllQuickStartStates] = useLocalStorage('quickstarts', {});
85
88
  // or
86
89
  // const [activeQuickStartID, setActiveQuickStartID] = React.useState("");
87
90
  // const [allQuickStartStates, setAllQuickStartStates] = React.useState({});
@@ -91,7 +94,7 @@ const App = () => {
91
94
  const loadedQuickStarts = [
92
95
  jsYaml.load(quickstartOne),
93
96
  jsYaml.load(quickstartTwo),
94
- quickstartThree
97
+ quickstartThree,
95
98
  ];
96
99
  setQuickStarts(loadedQuickStarts);
97
100
  setLoading(false);
@@ -134,7 +137,7 @@ const App = () => {
134
137
 
135
138
  return (
136
139
  <QuickStartContainer {...drawerProps}>
137
- <Button onClick={() => toggleQuickStart("node-with-s2i")}>
140
+ <Button onClick={() => toggleQuickStart('node-with-s2i')}>
138
141
  Toggle quick start through prop
139
142
  </Button>
140
143
  <SomeNestedComponent />
@@ -151,7 +154,7 @@ const SomeNestedComponent = () => {
151
154
  const qsContext = React.useContext(QuickStartContext);
152
155
  // the quick start ID is defined in the quick start object's metadata.name field
153
156
  return (
154
- <button onClick={() => qsContext.setActiveQuickStart("monitor-sampleapp")}>
157
+ <button onClick={() => qsContext.setActiveQuickStart('monitor-sampleapp')}>
155
158
  Toggle quick start through context
156
159
  </button>
157
160
  );
@@ -173,6 +176,7 @@ Here's a [yaml template](https://github.com/patternfly/patternfly-quickstarts/bl
173
176
  ## Writing quick starts
174
177
 
175
178
  Quick starts are typically written in yaml, but we've also seen projects use asciidoc and json. As long as you can pass in an [array of quick starts](https://github.com/patternfly/patternfly-quickstarts/blob/b086faefb0699e4259ca23d058ed330df1d87f8a/packages/module/src/QuickStartDrawer.tsx#L18) it doesn't really matter in what format your content is sourced.
179
+
176
180
  - We have a [yaml starter template here](https://github.com/patternfly/patternfly-quickstarts/blob/main/packages/dev/src/quickstarts-data/yaml/template.yaml)
177
181
  - The easiest way to preview the content as you're writing it, is to use Visual Studio code with our [quickstarts-preview extension](https://marketplace.visualstudio.com/items?itemName=PatternFly.quickstarts-preview).
178
182
  - Alternatively, you can use [github.dev](https://github.dev/) which is basically VS Code on the web, and install the extension there, then edit your yaml content!
@@ -181,11 +185,13 @@ Quick starts are typically written in yaml, but we've also seen projects use asc
181
185
  ### Highlighting elements
182
186
 
183
187
  You can highlight an element on the page from within a quick start. The element that should be highlightable needs a data-quickstart-id attribute. Example:
188
+
184
189
  ```
185
190
  <button data-quickstart-id="special-btn">Click me</button>
186
191
  ```
187
192
 
188
193
  In the quick start task description, you can add this type of markdown to target this element:
194
+
189
195
  ```
190
196
  Highlight [special button]{{highlight special-btn}}
191
197
  ```
@@ -195,20 +201,24 @@ Highlight [special button]{{highlight special-btn}}
195
201
  You can have inline or block copyable text.
196
202
 
197
203
  #### Inline copyable text example
204
+
198
205
  ```
199
206
  `echo "Donec id est ante"`{{copy}}
200
207
  ```
201
208
 
202
209
  #### Multiline copyable text example
203
- ```
210
+
211
+ ````
204
212
  ```
205
213
  First line of text.
206
214
  Second line of text.
207
215
  ```{{copy}}
208
- ```
216
+ ````
209
217
 
210
218
  ## Markdown extensions
219
+
211
220
  If your source material content is defined in markdown (yaml + markdown / json + markdown), then you can add your own markdown extensions, example:
221
+
212
222
  ```
213
223
  const drawerProps: QuickStartContainerProps = {
214
224
  markdown: {
@@ -232,9 +242,11 @@ return <QuickStartContainer {...drawerProps}>My page content</QuickStartContaine
232
242
  ```
233
243
 
234
244
  ## Localization
245
+
235
246
  We use English as the default language. You can override the default by providing your own key/value pairs to the `QuickStartContainer` or `QuickStartContextProvider` resourceBundle prop.
236
247
 
237
248
  Example:
249
+
238
250
  ```js
239
251
  // load my own resource Czech translations resource bundle using i18next
240
252
  const resourceBundle = i18n.getResourceBundle('cs', 'quickstart');
@@ -244,10 +256,7 @@ const resources = {
244
256
  Continue: 'Resume',
245
257
  Restart: 'Start over',
246
258
  };
247
- return (
248
- <QuickStartContainer resourceBundle={resources}>
249
- </QuickStartContainer>
250
- )
259
+ return <QuickStartContainer resourceBundle={resources}></QuickStartContainer>;
251
260
  ```
252
261
 
253
262
  Use this [file](https://github.com/patternfly/patternfly-quickstarts/blob/main/packages/module/src/locales/en/quickstart.json) as a base for your translations.
@@ -1,19 +1,19 @@
1
- import * as React from 'react';
2
- import './_markdown-view.scss';
3
- declare type ShowdownExtension = {
4
- type: string;
5
- regex?: RegExp;
6
- replace?: (...args: any[]) => string;
7
- };
8
- export declare const markdownConvert: (markdown: any, extensions?: ShowdownExtension[]) => any;
9
- declare type SyncMarkdownProps = {
10
- content?: string;
11
- emptyMsg?: string;
12
- exactHeight?: boolean;
13
- extensions?: ShowdownExtension[];
14
- renderExtension?: (contentDocument: HTMLDocument, rootSelector: string) => React.ReactNode;
15
- inline?: boolean;
16
- className?: string;
17
- };
18
- export declare const SyncMarkdownView: React.FC<SyncMarkdownProps>;
19
- export {};
1
+ import * as React from 'react';
2
+ import './_markdown-view.scss';
3
+ interface ShowdownExtension {
4
+ type: string;
5
+ regex?: RegExp;
6
+ replace?: (...args: any[]) => string;
7
+ }
8
+ export declare const markdownConvert: (markdown: any, extensions?: ShowdownExtension[]) => any;
9
+ interface SyncMarkdownProps {
10
+ content?: string;
11
+ emptyMsg?: string;
12
+ exactHeight?: boolean;
13
+ extensions?: ShowdownExtension[];
14
+ renderExtension?: (contentDocument: Document, rootSelector: string) => React.ReactNode;
15
+ inline?: boolean;
16
+ className?: string;
17
+ }
18
+ export declare const SyncMarkdownView: React.FC<SyncMarkdownProps>;
19
+ export {};
@@ -1,6 +1,6 @@
1
- import * as React from 'react';
2
- export declare const CamelCaseWrap: React.SFC<CamelCaseWrapProps>;
3
- export declare type CamelCaseWrapProps = {
4
- value: string;
5
- dataTest?: string;
6
- };
1
+ import * as React from 'react';
2
+ export declare const CamelCaseWrap: React.FC<CamelCaseWrapProps>;
3
+ export interface CamelCaseWrapProps {
4
+ value: string;
5
+ dataTest?: string;
6
+ }
@@ -1,3 +1,3 @@
1
- export * from './status-box';
2
- export * from './router';
3
- export * from './camel-case-wrap';
1
+ export * from './status-box';
2
+ export * from './router';
3
+ export * from './camel-case-wrap';
@@ -1,9 +1,9 @@
1
- import { History } from 'history';
2
- declare type AppHistory = History & {
3
- pushPath: History['push'];
4
- };
5
- export declare const history: AppHistory;
6
- export declare const removeQueryArgument: (k: string) => void;
7
- export declare const setQueryArgument: (k: string, v: string) => void;
8
- export declare const clearFilterParams: () => void;
9
- export {};
1
+ import { History } from 'history';
2
+ type AppHistory = History & {
3
+ pushPath: History['push'];
4
+ };
5
+ export declare const history: AppHistory;
6
+ export declare const removeQueryArgument: (k: string) => void;
7
+ export declare const setQueryArgument: (k: string, v: string) => void;
8
+ export declare const clearFilterParams: () => void;
9
+ export {};
@@ -1,20 +1,20 @@
1
- import * as React from 'react';
2
- export declare const Box: React.FC<BoxProps>;
3
- export declare const Loading: React.FC<LoadingProps>;
4
- export declare const LoadingBox: React.FC<LoadingBoxProps>;
5
- export declare const EmptyBox: React.FC<EmptyBoxProps>;
6
- declare type BoxProps = {
7
- children: React.ReactNode;
8
- className?: string;
9
- };
10
- declare type LoadingProps = {
11
- className?: string;
12
- };
13
- declare type LoadingBoxProps = {
14
- className?: string;
15
- message?: string;
16
- };
17
- declare type EmptyBoxProps = {
18
- label?: string;
19
- };
20
- export {};
1
+ import * as React from 'react';
2
+ export declare const Box: React.FC<BoxProps>;
3
+ export declare const Loading: React.FC<LoadingProps>;
4
+ export declare const LoadingBox: React.FC<LoadingBoxProps>;
5
+ export declare const EmptyBox: React.FC<EmptyBoxProps>;
6
+ interface BoxProps {
7
+ children: React.ReactNode;
8
+ className?: string;
9
+ }
10
+ interface LoadingProps {
11
+ className?: string;
12
+ }
13
+ interface LoadingBoxProps {
14
+ className?: string;
15
+ message?: string;
16
+ }
17
+ interface EmptyBoxProps {
18
+ label?: string;
19
+ }
20
+ export {};
@@ -1,42 +1,42 @@
1
- export declare type AccessReviewResourceAttributes = {
2
- group?: string;
3
- resource?: string;
4
- subresource?: string;
5
- verb?: K8sVerb;
6
- name?: string;
7
- namespace?: string;
8
- };
9
- export declare type K8sVerb = 'create' | 'get' | 'list' | 'update' | 'patch' | 'delete' | 'deletecollection' | 'watch';
10
- export declare type OwnerReference = {
11
- name: string;
12
- kind: string;
13
- uid: string;
14
- apiVersion: string;
15
- controller?: boolean;
16
- blockOwnerDeletion?: boolean;
17
- };
18
- export declare type ObjectMetadata = {
19
- name: string;
20
- annotations?: {
21
- [key: string]: string;
22
- };
23
- clusterName?: string;
24
- creationTimestamp?: string;
25
- deletionGracePeriodSeconds?: number;
26
- deletionTimestamp?: string;
27
- finalizers?: string[];
28
- generateName?: string;
29
- generation?: number;
30
- labels?: {
31
- [key: string]: string;
32
- };
33
- managedFields?: any[];
34
- namespace?: string;
35
- ownerReferences?: OwnerReference[];
36
- resourceVersion?: string;
37
- uid?: string;
38
- language?: string;
39
- country?: string;
40
- locale?: string;
41
- [key: string]: any;
42
- };
1
+ export interface AccessReviewResourceAttributes {
2
+ group?: string;
3
+ resource?: string;
4
+ subresource?: string;
5
+ verb?: K8sVerb;
6
+ name?: string;
7
+ namespace?: string;
8
+ }
9
+ export type K8sVerb = 'create' | 'get' | 'list' | 'update' | 'patch' | 'delete' | 'deletecollection' | 'watch';
10
+ export interface OwnerReference {
11
+ name: string;
12
+ kind: string;
13
+ uid: string;
14
+ apiVersion: string;
15
+ controller?: boolean;
16
+ blockOwnerDeletion?: boolean;
17
+ }
18
+ export interface ObjectMetadata {
19
+ name: string;
20
+ annotations?: {
21
+ [key: string]: string;
22
+ };
23
+ clusterName?: string;
24
+ creationTimestamp?: string;
25
+ deletionGracePeriodSeconds?: number;
26
+ deletionTimestamp?: string;
27
+ finalizers?: string[];
28
+ generateName?: string;
29
+ generation?: number;
30
+ labels?: {
31
+ [key: string]: string;
32
+ };
33
+ managedFields?: any[];
34
+ namespace?: string;
35
+ ownerReferences?: OwnerReference[];
36
+ resourceVersion?: string;
37
+ uid?: string;
38
+ language?: string;
39
+ country?: string;
40
+ locale?: string;
41
+ [key: string]: any;
42
+ }
@@ -1 +1 @@
1
- export * from './src';
1
+ export * from './src';
@@ -1,7 +1,7 @@
1
- export * from './modal';
2
- export * from './spotlight';
3
- export * from './markdown-highlight-extension';
4
- export * from './markdown-extensions';
5
- export * from './popper';
6
- export * from './utils';
7
- export * from './status';
1
+ export * from './modal';
2
+ export * from './spotlight';
3
+ export * from './markdown-highlight-extension';
4
+ export * from './markdown-extensions';
5
+ export * from './popper';
6
+ export * from './utils';
7
+ export * from './status';
@@ -1,13 +1,13 @@
1
- import * as React from 'react';
2
- declare type CopyClipboardProps = {
3
- element: HTMLElement;
4
- rootSelector: string;
5
- docContext: HTMLDocument;
6
- };
7
- export declare const CopyClipboard: React.FC<CopyClipboardProps>;
8
- declare type MarkdownCopyClipboardProps = {
9
- docContext: HTMLDocument;
10
- rootSelector: string;
11
- };
12
- declare const MarkdownCopyClipboard: React.FC<MarkdownCopyClipboardProps>;
13
- export default MarkdownCopyClipboard;
1
+ import * as React from 'react';
2
+ interface CopyClipboardProps {
3
+ element: HTMLElement;
4
+ rootSelector: string;
5
+ docContext: Document;
6
+ }
7
+ export declare const CopyClipboard: React.FC<CopyClipboardProps>;
8
+ interface MarkdownCopyClipboardProps {
9
+ docContext: Document;
10
+ rootSelector: string;
11
+ }
12
+ declare const MarkdownCopyClipboard: React.FC<MarkdownCopyClipboardProps>;
13
+ export default MarkdownCopyClipboard;
@@ -1,7 +1,7 @@
1
- import './showdown-extension.scss';
2
- declare const useAccordionShowdownExtension: () => {
3
- type: string;
4
- regex: RegExp;
5
- replace: (_text: string, accordionContent: string, _command: string, accordionHeading: string) => string;
6
- };
7
- export default useAccordionShowdownExtension;
1
+ import './showdown-extension.scss';
2
+ declare const useAccordionShowdownExtension: () => {
3
+ type: string;
4
+ regex: RegExp;
5
+ replace: (_text: string, accordionContent: string, _command: string, accordionHeading: string) => string;
6
+ };
7
+ export default useAccordionShowdownExtension;
@@ -1,6 +1,6 @@
1
- import * as React from 'react';
2
- declare type accordionRenderExtensionProps = {
3
- docContext: HTMLDocument;
4
- };
5
- declare const AccordionRenderExtension: React.FC<accordionRenderExtensionProps>;
6
- export default AccordionRenderExtension;
1
+ import * as React from 'react';
2
+ interface accordionRenderExtensionProps {
3
+ docContext: Document;
4
+ }
5
+ declare const AccordionRenderExtension: React.FC<accordionRenderExtensionProps>;
6
+ export default AccordionRenderExtension;
@@ -1,7 +1,7 @@
1
- import './showdown-extension.scss';
2
- declare const useAdmonitionShowdownExtension: () => {
3
- type: string;
4
- regex: RegExp;
5
- replace: (text: string, content: string, admonitionLabel: string, admonitionType: string, groupId: string) => string;
6
- };
7
- export default useAdmonitionShowdownExtension;
1
+ import './showdown-extension.scss';
2
+ declare const useAdmonitionShowdownExtension: () => {
3
+ type: string;
4
+ regex: RegExp;
5
+ replace: (text: string, content: string, admonitionLabel: string, admonitionType: string, groupId: string) => string;
6
+ };
7
+ export default useAdmonitionShowdownExtension;
@@ -1,7 +1,7 @@
1
- import './showdown-extension.scss';
2
- declare const useCodeShowdownExtension: () => {
3
- type: string;
4
- regex: RegExp;
5
- replace: (text: string, content: string) => string;
6
- };
7
- export default useCodeShowdownExtension;
1
+ import './showdown-extension.scss';
2
+ declare const useCodeShowdownExtension: () => {
3
+ type: string;
4
+ regex: RegExp;
5
+ replace: (text: string, content: string) => string;
6
+ };
7
+ export default useCodeShowdownExtension;
@@ -1,5 +1,5 @@
1
- export declare const MARKDOWN_COPY_BUTTON_ID = "data-copy-for";
2
- export declare const MARKDOWN_EXECUTE_BUTTON_ID = "data-execute-for";
3
- export declare const MARKDOWN_SNIPPET_ID = "data-snippet-id";
4
- export declare const ACCORDION_MARKDOWN_BUTTON_ID = "accordion-markdown-button-id";
5
- export declare const ACCORDION_MARKDOWN_CONTENT_ID = "accordion-markdown-content-id";
1
+ export declare const MARKDOWN_COPY_BUTTON_ID = "data-copy-for";
2
+ export declare const MARKDOWN_EXECUTE_BUTTON_ID = "data-execute-for";
3
+ export declare const MARKDOWN_SNIPPET_ID = "data-snippet-id";
4
+ export declare const ACCORDION_MARKDOWN_BUTTON_ID = "accordion-markdown-button-id";
5
+ export declare const ACCORDION_MARKDOWN_CONTENT_ID = "accordion-markdown-content-id";
@@ -1,7 +1,7 @@
1
- export { default as MarkdownCopyClipboard } from './MarkdownCopyClipboard';
2
- export { default as useInlineCopyClipboardShowdownExtension } from './inline-clipboard-extension';
3
- export { default as useMultilineCopyClipboardShowdownExtension } from './multiline-clipboard-extension';
4
- export { default as useAdmonitionShowdownExtension } from './admonition-extension';
5
- export { default as useCodeShowdownExtension } from './code-extension';
6
- export { default as useAccordionShowdownExtension } from './accordion-extension';
7
- export { default as AccordionRenderExtension } from './accordion-render-extension';
1
+ export { default as MarkdownCopyClipboard } from './MarkdownCopyClipboard';
2
+ export { default as useInlineCopyClipboardShowdownExtension } from './inline-clipboard-extension';
3
+ export { default as useMultilineCopyClipboardShowdownExtension } from './multiline-clipboard-extension';
4
+ export { default as useAdmonitionShowdownExtension } from './admonition-extension';
5
+ export { default as useCodeShowdownExtension } from './code-extension';
6
+ export { default as useAccordionShowdownExtension } from './accordion-extension';
7
+ export { default as AccordionRenderExtension } from './accordion-render-extension';
@@ -1,7 +1,7 @@
1
- import './showdown-extension.scss';
2
- declare const useInlineCopyClipboardShowdownExtension: () => {
3
- type: string;
4
- regex: RegExp;
5
- replace: (text: string, group: string, _: string, groupId: number) => string;
6
- };
7
- export default useInlineCopyClipboardShowdownExtension;
1
+ import './showdown-extension.scss';
2
+ declare const useInlineCopyClipboardShowdownExtension: () => {
3
+ type: string;
4
+ regex: RegExp;
5
+ replace: (text: string, group: string, _: string, groupId: number) => string;
6
+ };
7
+ export default useInlineCopyClipboardShowdownExtension;
@@ -1,7 +1,7 @@
1
- import './showdown-extension.scss';
2
- declare const useMultilineCopyClipboardShowdownExtension: () => {
3
- type: string;
4
- regex: RegExp;
5
- replace: (text: string, group: string, _1: string, _2: string, groupId: number) => string;
6
- };
7
- export default useMultilineCopyClipboardShowdownExtension;
1
+ import './showdown-extension.scss';
2
+ declare const useMultilineCopyClipboardShowdownExtension: () => {
3
+ type: string;
4
+ regex: RegExp;
5
+ replace: (text: string, group: string, _1: string, _2: string, groupId: number) => string;
6
+ };
7
+ export default useMultilineCopyClipboardShowdownExtension;
@@ -1 +1 @@
1
- export declare const removeTemplateWhitespace: (template: string) => string;
1
+ export declare const removeTemplateWhitespace: (template: string) => string;
@@ -1,7 +1,7 @@
1
- import * as React from 'react';
2
- declare type MarkdownHighlightExtensionProps = {
3
- docContext: HTMLDocument;
4
- rootSelector: string;
5
- };
6
- declare const MarkdownHighlightExtension: React.FC<MarkdownHighlightExtensionProps>;
7
- export default MarkdownHighlightExtension;
1
+ import * as React from 'react';
2
+ interface MarkdownHighlightExtensionProps {
3
+ docContext: Document;
4
+ rootSelector: string;
5
+ }
6
+ declare const MarkdownHighlightExtension: React.FC<MarkdownHighlightExtensionProps>;
7
+ export default MarkdownHighlightExtension;
@@ -1,4 +1,4 @@
1
- export declare const LINK_LABEL = "[\\d\\w\\s-()$!]+";
2
- export declare const HIGHLIGHT_ACTIONS: string[];
3
- export declare const SELECTOR_ID = "[\\w-]+";
4
- export declare const HIGHLIGHT_REGEXP: RegExp;
1
+ export declare const LINK_LABEL = "[\\d\\w\\s-()$!]+";
2
+ export declare const HIGHLIGHT_ACTIONS: string[];
3
+ export declare const SELECTOR_ID = "[\\w-]+";
4
+ export declare const HIGHLIGHT_REGEXP: RegExp;
@@ -1 +1 @@
1
- export { default as MarkdownHighlightExtension } from './MarkdownHighlightExtension';
1
+ export { default as MarkdownHighlightExtension } from './MarkdownHighlightExtension';
@@ -1,9 +1,9 @@
1
- import './Modal.scss';
2
- import * as React from 'react';
3
- import { Modal as PfModal, ModalProps as PfModalProps } from '@patternfly/react-core';
4
- declare type ModalProps = {
5
- isFullScreen?: boolean;
6
- ref?: React.LegacyRef<PfModal>;
7
- } & PfModalProps;
8
- declare const Modal: React.FC<ModalProps>;
9
- export default Modal;
1
+ import './Modal.scss';
2
+ import * as React from 'react';
3
+ import { Modal as PfModal, ModalProps as PfModalProps } from '@patternfly/react-core';
4
+ type ModalProps = {
5
+ isFullScreen?: boolean;
6
+ ref?: React.LegacyRef<PfModal>;
7
+ } & PfModalProps;
8
+ declare const Modal: React.FC<ModalProps>;
9
+ export default Modal;
@@ -1 +1 @@
1
- export { default as Modal } from './Modal';
1
+ export { default as Modal } from './Modal';
@@ -1,7 +1,8 @@
1
- import * as React from 'react';
2
- declare type GetContainer = Element | null | undefined | (() => Element);
3
- declare type PortalProps = {
4
- container?: GetContainer;
5
- };
6
- declare const Portal: React.FC<PortalProps>;
7
- export default Portal;
1
+ import * as React from 'react';
2
+ type GetContainer = Element | null | undefined | (() => Element);
3
+ interface PortalProps {
4
+ children: React.ReactNode;
5
+ container?: GetContainer;
6
+ }
7
+ declare const Portal: ({ children, container }: PortalProps) => React.ReactPortal;
8
+ export default Portal;
@@ -1,3 +1,6 @@
1
- import * as React from 'react';
2
- declare const SimplePopper: React.FC;
3
- export default SimplePopper;
1
+ import * as React from 'react';
2
+ interface SimplePopperProps {
3
+ children: React.ReactNode;
4
+ }
5
+ declare const SimplePopper: ({ children }: SimplePopperProps) => React.JSX.Element;
6
+ export default SimplePopper;