@patternfly/quickstarts 5.0.0-prerelease.2 → 5.1.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 (113) hide show
  1. package/dist/ConsoleInternal/components/markdown-view.d.ts +19 -19
  2. package/dist/ConsoleInternal/components/utils/camel-case-wrap.d.ts +6 -6
  3. package/dist/ConsoleInternal/components/utils/index.d.ts +3 -3
  4. package/dist/ConsoleInternal/components/utils/router.d.ts +9 -9
  5. package/dist/ConsoleInternal/components/utils/status-box.d.ts +20 -20
  6. package/dist/ConsoleInternal/module/k8s/types.d.ts +42 -42
  7. package/dist/ConsoleShared/index.d.ts +1 -1
  8. package/dist/ConsoleShared/src/components/index.d.ts +7 -7
  9. package/dist/ConsoleShared/src/components/markdown-extensions/MarkdownCopyClipboard.d.ts +13 -13
  10. package/dist/ConsoleShared/src/components/markdown-extensions/accordion-extension.d.ts +7 -7
  11. package/dist/ConsoleShared/src/components/markdown-extensions/accordion-render-extension.d.ts +6 -6
  12. package/dist/ConsoleShared/src/components/markdown-extensions/admonition-extension.d.ts +7 -7
  13. package/dist/ConsoleShared/src/components/markdown-extensions/code-extension.d.ts +7 -7
  14. package/dist/ConsoleShared/src/components/markdown-extensions/const.d.ts +5 -5
  15. package/dist/ConsoleShared/src/components/markdown-extensions/index.d.ts +7 -7
  16. package/dist/ConsoleShared/src/components/markdown-extensions/inline-clipboard-extension.d.ts +7 -7
  17. package/dist/ConsoleShared/src/components/markdown-extensions/multiline-clipboard-extension.d.ts +7 -7
  18. package/dist/ConsoleShared/src/components/markdown-extensions/utils.d.ts +1 -1
  19. package/dist/ConsoleShared/src/components/markdown-highlight-extension/MarkdownHighlightExtension.d.ts +7 -7
  20. package/dist/ConsoleShared/src/components/markdown-highlight-extension/highlight-consts.d.ts +4 -4
  21. package/dist/ConsoleShared/src/components/markdown-highlight-extension/index.d.ts +1 -1
  22. package/dist/ConsoleShared/src/components/modal/Modal.d.ts +9 -9
  23. package/dist/ConsoleShared/src/components/modal/index.d.ts +1 -1
  24. package/dist/ConsoleShared/src/components/popper/Portal.d.ts +8 -8
  25. package/dist/ConsoleShared/src/components/popper/SimplePopper.d.ts +6 -6
  26. package/dist/ConsoleShared/src/components/popper/index.d.ts +2 -2
  27. package/dist/ConsoleShared/src/components/spotlight/InteractiveSpotlight.d.ts +7 -7
  28. package/dist/ConsoleShared/src/components/spotlight/Spotlight.d.ts +7 -7
  29. package/dist/ConsoleShared/src/components/spotlight/StaticSpotlight.d.ts +7 -7
  30. package/dist/ConsoleShared/src/components/spotlight/index.d.ts +1 -1
  31. package/dist/ConsoleShared/src/components/status/GenericStatus.d.ts +12 -12
  32. package/dist/ConsoleShared/src/components/status/NotStartedIcon.d.ts +3 -3
  33. package/dist/ConsoleShared/src/components/status/PopoverStatus.d.ts +13 -13
  34. package/dist/ConsoleShared/src/components/status/Status.d.ts +11 -11
  35. package/dist/ConsoleShared/src/components/status/StatusIconAndText.d.ts +8 -8
  36. package/dist/ConsoleShared/src/components/status/icons.d.ts +9 -9
  37. package/dist/ConsoleShared/src/components/status/index.d.ts +1 -1
  38. package/dist/ConsoleShared/src/components/status/statuses.d.ts +5 -5
  39. package/dist/ConsoleShared/src/components/status/types.d.ts +9 -9
  40. package/dist/ConsoleShared/src/components/utils/FallbackImg.d.ts +9 -9
  41. package/dist/ConsoleShared/src/components/utils/index.d.ts +1 -1
  42. package/dist/ConsoleShared/src/constants/index.d.ts +1 -1
  43. package/dist/ConsoleShared/src/constants/ui.d.ts +1 -1
  44. package/dist/ConsoleShared/src/hooks/index.d.ts +6 -6
  45. package/dist/ConsoleShared/src/hooks/scroll.d.ts +8 -8
  46. package/dist/ConsoleShared/src/hooks/useBoundingClientRect.d.ts +3 -3
  47. package/dist/ConsoleShared/src/hooks/useEventListener.d.ts +1 -1
  48. package/dist/ConsoleShared/src/hooks/useForceRender.d.ts +4 -4
  49. package/dist/ConsoleShared/src/hooks/useResizeObserver.d.ts +1 -1
  50. package/dist/ConsoleShared/src/hooks/useScrollShadows.d.ts +7 -7
  51. package/dist/ConsoleShared/src/index.d.ts +4 -4
  52. package/dist/ConsoleShared/src/utils/index.d.ts +1 -1
  53. package/dist/ConsoleShared/src/utils/useCombineRefs.d.ts +2 -2
  54. package/dist/HelpTopicDrawer.d.ts +33 -33
  55. package/dist/HelpTopicPanelContent.d.ts +11 -11
  56. package/dist/QuickStartCatalogPage.d.ts +14 -14
  57. package/dist/QuickStartCloseModal.d.ts +8 -8
  58. package/dist/QuickStartController.d.ts +10 -10
  59. package/dist/QuickStartDrawer.d.ts +62 -62
  60. package/dist/QuickStartMarkdownView.d.ts +9 -9
  61. package/dist/QuickStartPanelContent.d.ts +15 -15
  62. package/dist/catalog/Catalog/QuickStartCatalogHeader.d.ts +6 -6
  63. package/dist/catalog/Catalog/QuickStartCatalogSection.d.ts +5 -5
  64. package/dist/catalog/Catalog/QuickStartCatalogToolbar.d.ts +5 -5
  65. package/dist/catalog/Catalog/index.d.ts +3 -3
  66. package/dist/catalog/QuickStartCatalog.d.ts +8 -8
  67. package/dist/catalog/QuickStartTile.d.ts +11 -11
  68. package/dist/catalog/QuickStartTileDescription.d.ts +8 -8
  69. package/dist/catalog/QuickStartTileFooter.d.ts +8 -8
  70. package/dist/catalog/QuickStartTileFooterExternal.d.ts +8 -8
  71. package/dist/catalog/QuickStartTileHeader.d.ts +12 -12
  72. package/dist/catalog/Toolbar/QuickStartCatalogFilter.d.ts +10 -10
  73. package/dist/catalog/Toolbar/QuickStartCatalogFilterItems.d.ts +31 -31
  74. package/dist/catalog/index.d.ts +9 -9
  75. package/dist/controller/QuickStartConclusion.d.ts +12 -12
  76. package/dist/controller/QuickStartContent.d.ts +14 -14
  77. package/dist/controller/QuickStartFooter.d.ts +14 -14
  78. package/dist/controller/QuickStartIntroduction.d.ts +12 -12
  79. package/dist/controller/QuickStartTaskHeader.d.ts +15 -15
  80. package/dist/controller/QuickStartTaskHeaderList.d.ts +10 -10
  81. package/dist/controller/QuickStartTaskReview.d.ts +10 -10
  82. package/dist/controller/QuickStartTasks.d.ts +12 -12
  83. package/dist/data/mocks/json/explore-pipeline-quickstart.d.ts +2 -2
  84. package/dist/data/mocks/json/explore-serverless-quickstart.d.ts +2 -2
  85. package/dist/data/mocks/json/monitor-sampleapp-quickstart.d.ts +2 -2
  86. package/dist/data/mocks/json/tour-icons.d.ts +2 -2
  87. package/dist/data/quick-start-test-data.d.ts +2 -2
  88. package/dist/data/test-utils.d.ts +8 -8
  89. package/dist/index.d.ts +16 -16
  90. package/dist/index.es.js +2286 -2286
  91. package/dist/index.es.js.map +1 -1
  92. package/dist/index.js +2286 -2286
  93. package/dist/index.js.map +1 -1
  94. package/dist/quickstarts-base.css +4 -4
  95. package/dist/quickstarts-full.es.js +3026 -2393
  96. package/dist/quickstarts-full.es.js.map +1 -1
  97. package/dist/quickstarts.css +4 -4
  98. package/dist/quickstarts.min.css +1 -1
  99. package/dist/styles/patternfly-global-entry.d.ts +1 -1
  100. package/dist/styles/patternfly-nested-entry.d.ts +1 -1
  101. package/dist/styles/quickstarts-standalone-entry.d.ts +1 -1
  102. package/dist/styles/vendor-entry.d.ts +1 -1
  103. package/dist/utils/PluralResolver.d.ts +16 -16
  104. package/dist/utils/asciidoc-procedure-parser.d.ts +12 -12
  105. package/dist/utils/const.d.ts +6 -6
  106. package/dist/utils/help-topic-context.d.ts +23 -23
  107. package/dist/utils/help-topic-types.d.ts +13 -13
  108. package/dist/utils/quick-start-context.d.ts +81 -81
  109. package/dist/utils/quick-start-types.d.ts +60 -60
  110. package/dist/utils/quick-start-utils.d.ts +10 -10
  111. package/dist/utils/useLocalStorage.d.ts +1 -1
  112. package/package.json +12 -13
  113. package/src/QuickStartController.tsx +1 -1
@@ -1,9 +1,9 @@
1
- import * as React from 'react';
2
- export declare const GreenCheckCircleIcon: React.FC<ColoredIconProps>;
3
- export declare const RedExclamationCircleIcon: React.FC<ColoredIconProps>;
4
- export declare const BlueInfoCircleIcon: React.FC<ColoredIconProps>;
5
- export interface ColoredIconProps {
6
- className?: string;
7
- title?: string;
8
- size?: 'sm' | 'md' | 'lg' | 'xl';
9
- }
1
+ import * as React from 'react';
2
+ export declare const GreenCheckCircleIcon: React.FC<ColoredIconProps>;
3
+ export declare const RedExclamationCircleIcon: React.FC<ColoredIconProps>;
4
+ export declare const BlueInfoCircleIcon: React.FC<ColoredIconProps>;
5
+ export interface ColoredIconProps {
6
+ className?: string;
7
+ title?: string;
8
+ size?: 'sm' | 'md' | 'lg' | 'xl';
9
+ }
@@ -1 +1 @@
1
- export * from './Status';
1
+ export * from './Status';
@@ -1,5 +1,5 @@
1
- import * as React from 'react';
2
- import { StatusComponentProps } from './types';
3
- export declare const ErrorStatus: React.FC<StatusComponentProps>;
4
- export declare const InfoStatus: React.FC<StatusComponentProps>;
5
- export declare const SuccessStatus: React.FC<StatusComponentProps>;
1
+ import * as React from 'react';
2
+ import { StatusComponentProps } from './types';
3
+ export declare const ErrorStatus: React.FC<StatusComponentProps>;
4
+ export declare const InfoStatus: React.FC<StatusComponentProps>;
5
+ export declare const SuccessStatus: React.FC<StatusComponentProps>;
@@ -1,9 +1,9 @@
1
- /// <reference types="react" />
2
- export interface StatusComponentProps {
3
- children?: React.ReactNode;
4
- title?: string;
5
- iconOnly?: boolean;
6
- noTooltip?: boolean;
7
- className?: string;
8
- popoverTitle?: string;
9
- }
1
+ /// <reference types="react" />
2
+ export interface StatusComponentProps {
3
+ children?: React.ReactNode;
4
+ title?: string;
5
+ iconOnly?: boolean;
6
+ noTooltip?: boolean;
7
+ className?: string;
8
+ popoverTitle?: string;
9
+ }
@@ -1,9 +1,9 @@
1
- import * as React from 'react';
2
- interface FallbackImgProps {
3
- src: string;
4
- alt?: string;
5
- className?: string;
6
- fallback?: React.ReactNode;
7
- }
8
- declare const FallbackImg: React.FC<FallbackImgProps>;
9
- export default FallbackImg;
1
+ import * as React from 'react';
2
+ interface FallbackImgProps {
3
+ src: string;
4
+ alt?: string;
5
+ className?: string;
6
+ fallback?: React.ReactNode;
7
+ }
8
+ declare const FallbackImg: React.FC<FallbackImgProps>;
9
+ export default FallbackImg;
@@ -1 +1 @@
1
- export { default as FallbackImg } from './FallbackImg';
1
+ export { default as FallbackImg } from './FallbackImg';
@@ -1 +1 @@
1
- export * from './ui';
1
+ export * from './ui';
@@ -1 +1 @@
1
- export declare const DASH = "-";
1
+ export declare const DASH = "-";
@@ -1,6 +1,6 @@
1
- export * from './scroll';
2
- export * from './useResizeObserver';
3
- export * from './useScrollShadows';
4
- export * from './useBoundingClientRect';
5
- export * from './useForceRender';
6
- export * from './useEventListener';
1
+ export * from './scroll';
2
+ export * from './useResizeObserver';
3
+ export * from './useScrollShadows';
4
+ export * from './useBoundingClientRect';
5
+ export * from './useForceRender';
6
+ export * from './useEventListener';
@@ -1,8 +1,8 @@
1
- export declare enum ScrollDirection {
2
- scrollingUp = "scrolling-up",
3
- scrollingDown = "scrolling-down",
4
- scrolledToBottom = "scrolled-to-bottom",
5
- scrolledToTop = "scrolled-to-top"
6
- }
7
- export declare const getScrollDirection: (prevScrollTop: number, currentScrollTop: number, scrollHeight: number, clientHeight: number) => any;
8
- export declare const useScrollDirection: () => [ScrollDirection, (event: any) => void];
1
+ export declare enum ScrollDirection {
2
+ scrollingUp = "scrolling-up",
3
+ scrollingDown = "scrolling-down",
4
+ scrolledToBottom = "scrolled-to-bottom",
5
+ scrolledToTop = "scrolled-to-top"
6
+ }
7
+ export declare const getScrollDirection: (prevScrollTop: number, currentScrollTop: number, scrollHeight: number, clientHeight: number) => any;
8
+ export declare const useScrollDirection: () => [ScrollDirection, (event: any) => void];
@@ -1,3 +1,3 @@
1
- declare type BoundingClientRect = ClientRect | null;
2
- export declare const useBoundingClientRect: (targetElement: HTMLElement | null) => BoundingClientRect;
3
- export {};
1
+ type BoundingClientRect = ClientRect | null;
2
+ export declare const useBoundingClientRect: (targetElement: HTMLElement | null) => BoundingClientRect;
3
+ export {};
@@ -1 +1 @@
1
- export declare const useEventListener: (target: EventTarget, event: keyof WindowEventMap, callback: EventListener) => void;
1
+ export declare const useEventListener: (target: EventTarget, event: keyof WindowEventMap, callback: EventListener) => void;
@@ -1,4 +1,4 @@
1
- /**
2
- * React hook that forces component render.
3
- */
4
- export declare const useForceRender: () => VoidFunction;
1
+ /**
2
+ * React hook that forces component render.
3
+ */
4
+ export declare const useForceRender: () => VoidFunction;
@@ -1 +1 @@
1
- export declare const useResizeObserver: (callback: ResizeObserverCallback, targetElement?: HTMLElement | null, observerOptions?: ResizeObserverOptions) => void;
1
+ export declare const useResizeObserver: (callback: ResizeObserverCallback, targetElement?: HTMLElement | null, observerOptions?: ResizeObserverOptions) => void;
@@ -1,7 +1,7 @@
1
- export declare enum Shadows {
2
- none = "none",
3
- both = "both",
4
- top = "top",
5
- bottom = "bottom"
6
- }
7
- export declare const useScrollShadows: (node: HTMLElement) => Shadows;
1
+ export declare enum Shadows {
2
+ none = "none",
3
+ both = "both",
4
+ top = "top",
5
+ bottom = "bottom"
6
+ }
7
+ export declare const useScrollShadows: (node: HTMLElement) => Shadows;
@@ -1,4 +1,4 @@
1
- export * from './components';
2
- export * from './hooks';
3
- export * from './utils';
4
- export * from './constants';
1
+ export * from './components';
2
+ export * from './hooks';
3
+ export * from './utils';
4
+ export * from './constants';
@@ -1 +1 @@
1
- export * from './useCombineRefs';
1
+ export * from './useCombineRefs';
@@ -1,2 +1,2 @@
1
- import * as React from 'react';
2
- export declare const useCombineRefs: <RefType>(...refs: React.Ref<RefType>[]) => (element: RefType) => void;
1
+ import * as React from 'react';
2
+ export declare const useCombineRefs: <RefType>(...refs: React.Ref<RefType>[]) => (element: RefType) => void;
@@ -1,33 +1,33 @@
1
- import './QuickStartDrawer.scss';
2
- import * as React from 'react';
3
- import { QuickStartContextValues } from './utils/quick-start-context';
4
- import { HelpTopic } from './utils/help-topic-types';
5
- export interface HelpTopicContainerProps extends React.HTMLProps<HTMLDivElement> {
6
- /** array of HelpTopics */
7
- helpTopics: HelpTopic[];
8
- /** text resources object
9
- * Add custom strings: https://github.com/patternfly/patternfly-quickstarts/tree/main/packages/module#localization
10
- */
11
- resourceBundle?: any;
12
- /** language of the current resource bundle */
13
- language?: string;
14
- /** if true, will show a loading spinner on the catalog page (default false) */
15
- loading?: boolean;
16
- /**
17
- * Additional markdown extensions and renderers to use
18
- * Example usage: https://github.com/patternfly/patternfly-quickstarts/tree/main/packages/module#markdown-extensions
19
- */
20
- markdown?: {
21
- extensions?: any[];
22
- renderExtension?: (docContext: Document, rootSelector: string) => React.ReactNode;
23
- };
24
- /** additional quick start context props */
25
- contextProps?: QuickStartContextValues;
26
- children?: React.ReactNode;
27
- }
28
- export declare const HelpTopicContainer: React.FC<HelpTopicContainerProps>;
29
- export interface HelpTopicDrawerProps extends React.HTMLProps<HTMLDivElement> {
30
- helpTopics?: HelpTopic[];
31
- children?: React.ReactNode;
32
- }
33
- export declare const HelpTopicDrawer: React.FC<HelpTopicDrawerProps>;
1
+ import './QuickStartDrawer.scss';
2
+ import * as React from 'react';
3
+ import { QuickStartContextValues } from './utils/quick-start-context';
4
+ import { HelpTopic } from './utils/help-topic-types';
5
+ export interface HelpTopicContainerProps extends React.HTMLProps<HTMLDivElement> {
6
+ /** array of HelpTopics */
7
+ helpTopics: HelpTopic[];
8
+ /** text resources object
9
+ * Add custom strings: https://github.com/patternfly/patternfly-quickstarts/tree/main/packages/module#localization
10
+ */
11
+ resourceBundle?: any;
12
+ /** language of the current resource bundle */
13
+ language?: string;
14
+ /** if true, will show a loading spinner on the catalog page (default false) */
15
+ loading?: boolean;
16
+ /**
17
+ * Additional markdown extensions and renderers to use
18
+ * Example usage: https://github.com/patternfly/patternfly-quickstarts/tree/main/packages/module#markdown-extensions
19
+ */
20
+ markdown?: {
21
+ extensions?: any[];
22
+ renderExtension?: (docContext: Document, rootSelector: string) => React.ReactNode;
23
+ };
24
+ /** additional quick start context props */
25
+ contextProps?: QuickStartContextValues;
26
+ children?: React.ReactNode;
27
+ }
28
+ export declare const HelpTopicContainer: React.FC<HelpTopicContainerProps>;
29
+ export interface HelpTopicDrawerProps extends React.HTMLProps<HTMLDivElement> {
30
+ helpTopics?: HelpTopic[];
31
+ children?: React.ReactNode;
32
+ }
33
+ export declare const HelpTopicDrawer: React.FC<HelpTopicDrawerProps>;
@@ -1,11 +1,11 @@
1
- import * as React from 'react';
2
- import { HelpTopic } from './utils/help-topic-types';
3
- import './QuickStartPanelContent.scss';
4
- interface HelpTopicPanelContentProps {
5
- activeHelpTopic: HelpTopic;
6
- filteredHelpTopics?: HelpTopic[];
7
- isResizable?: boolean;
8
- onClose: () => void;
9
- }
10
- declare const HelpTopicPanelContent: React.FC<HelpTopicPanelContentProps>;
11
- export default HelpTopicPanelContent;
1
+ import * as React from 'react';
2
+ import { HelpTopic } from './utils/help-topic-types';
3
+ import './QuickStartPanelContent.scss';
4
+ interface HelpTopicPanelContentProps {
5
+ activeHelpTopic: HelpTopic;
6
+ filteredHelpTopics?: HelpTopic[];
7
+ isResizable?: boolean;
8
+ onClose: () => void;
9
+ }
10
+ declare const HelpTopicPanelContent: React.FC<HelpTopicPanelContentProps>;
11
+ export default HelpTopicPanelContent;
@@ -1,14 +1,14 @@
1
- import * as React from 'react';
2
- import { QuickStart } from './utils/quick-start-types';
3
- export interface QuickStartCatalogPageProps {
4
- quickStarts?: QuickStart[];
5
- showFilter?: boolean;
6
- sortFnc?: (q1: QuickStart, q2: QuickStart) => number;
7
- title?: string;
8
- hint?: string;
9
- showTitle?: boolean;
10
- }
11
- export declare const QuickStartCatalogEmptyState: ({ clearFilters }: {
12
- clearFilters: any;
13
- }) => React.JSX.Element;
14
- export declare const QuickStartCatalogPage: React.FC<QuickStartCatalogPageProps>;
1
+ import * as React from 'react';
2
+ import { QuickStart } from './utils/quick-start-types';
3
+ export interface QuickStartCatalogPageProps {
4
+ quickStarts?: QuickStart[];
5
+ showFilter?: boolean;
6
+ sortFnc?: (q1: QuickStart, q2: QuickStart) => number;
7
+ title?: string;
8
+ hint?: string;
9
+ showTitle?: boolean;
10
+ }
11
+ export declare const QuickStartCatalogEmptyState: ({ clearFilters }: {
12
+ clearFilters: any;
13
+ }) => React.JSX.Element;
14
+ export declare const QuickStartCatalogPage: React.FC<QuickStartCatalogPageProps>;
@@ -1,8 +1,8 @@
1
- import * as React from 'react';
2
- interface QuickStartCloseModalProps {
3
- isOpen: boolean;
4
- onConfirm: () => void;
5
- onCancel: () => void;
6
- }
7
- declare const QuickStartCloseModal: React.FC<QuickStartCloseModalProps>;
8
- export default QuickStartCloseModal;
1
+ import * as React from 'react';
2
+ interface QuickStartCloseModalProps {
3
+ isOpen: boolean;
4
+ onConfirm: () => void;
5
+ onCancel: () => void;
6
+ }
7
+ declare const QuickStartCloseModal: React.FC<QuickStartCloseModalProps>;
8
+ export default QuickStartCloseModal;
@@ -1,10 +1,10 @@
1
- import * as React from 'react';
2
- import { QuickStart } from './utils/quick-start-types';
3
- interface QuickStartControllerProps {
4
- quickStart: QuickStart;
5
- nextQuickStarts?: QuickStart[];
6
- footerClass: string;
7
- contentRef: React.Ref<HTMLDivElement>;
8
- }
9
- declare const QuickStartController: React.FC<QuickStartControllerProps>;
10
- export default QuickStartController;
1
+ import * as React from 'react';
2
+ import { QuickStart } from './utils/quick-start-types';
3
+ interface QuickStartControllerProps {
4
+ quickStart: QuickStart;
5
+ nextQuickStarts?: QuickStart[];
6
+ footerClass: string;
7
+ contentRef: React.Ref<HTMLDivElement>;
8
+ }
9
+ declare const QuickStartController: React.FC<QuickStartControllerProps>;
10
+ export default QuickStartController;
@@ -1,62 +1,62 @@
1
- import './QuickStartDrawer.scss';
2
- import * as React from 'react';
3
- import { QuickStartContextValues } from './utils/quick-start-context';
4
- import { QuickStart, AllQuickStartStates } from './utils/quick-start-types';
5
- export interface QuickStartContainerProps extends React.HTMLProps<HTMLDivElement> {
6
- /** array of quick starts */
7
- quickStarts: QuickStart[];
8
- /** id of the currently active quick start */
9
- activeQuickStartID: string;
10
- /** setter for the active quick starts */
11
- setActiveQuickStartID: React.Dispatch<React.SetStateAction<string>>;
12
- /** quick starts state object */
13
- allQuickStartStates: AllQuickStartStates;
14
- /** setter for the quick starts state object */
15
- setAllQuickStartStates: React.Dispatch<React.SetStateAction<AllQuickStartStates>>;
16
- /** content to render within the container */
17
- children?: React.ReactNode;
18
- /** element to render the drawer panel into */
19
- appendTo?: HTMLElement | (() => HTMLElement);
20
- /** if true, the panel will take up the full browser width */
21
- fullWidth?: boolean;
22
- /** callback when an in-progress quick start is closed */
23
- onCloseInProgress?: any;
24
- /** callback when a not-in-progress quick start is closed */
25
- onCloseNotInProgress?: any;
26
- /** true to show footer buttons in the catalog tiles (default true) */
27
- showCardFooters?: boolean;
28
- /** true to use legacy drawer header variant colors */
29
- useLegacyHeaderColors?: boolean;
30
- /** text resources object */
31
- resourceBundle?: any;
32
- /** language of the current resource bundle
33
- * Add custom strings: https://github.com/patternfly/patternfly-quickstarts/tree/main/packages/module#localization
34
- */
35
- language?: string;
36
- /** if true, will show a loading spinner on the catalog page (default false) */
37
- loading?: boolean;
38
- /** if true, will update the browser URL with ?quickstart={ID} (default true) */
39
- useQueryParams?: boolean;
40
- /** if true, the TaskReview component, aka "Check your work", will be shown regardless of task status */
41
- alwaysShowTaskReview?: boolean;
42
- /**
43
- * Additional markdown extensions and renderers to use
44
- * Example usage: https://github.com/patternfly/patternfly-quickstarts/tree/main/packages/module#markdown-extensions
45
- */
46
- markdown?: {
47
- extensions?: any[];
48
- renderExtension?: (docContext: Document, rootSelector: string) => React.ReactNode;
49
- };
50
- /** additional quick start context props */
51
- contextProps?: QuickStartContextValues;
52
- }
53
- export declare const QuickStartContainer: React.FC<QuickStartContainerProps>;
54
- export interface QuickStartDrawerProps extends React.HTMLProps<HTMLDivElement> {
55
- quickStarts?: QuickStart[];
56
- children?: React.ReactNode;
57
- appendTo?: HTMLElement | (() => HTMLElement);
58
- fullWidth?: boolean;
59
- onCloseInProgress?: any;
60
- onCloseNotInProgress?: any;
61
- }
62
- export declare const QuickStartDrawer: React.FC<QuickStartDrawerProps>;
1
+ import './QuickStartDrawer.scss';
2
+ import * as React from 'react';
3
+ import { QuickStartContextValues } from './utils/quick-start-context';
4
+ import { QuickStart, AllQuickStartStates } from './utils/quick-start-types';
5
+ export interface QuickStartContainerProps extends React.HTMLProps<HTMLDivElement> {
6
+ /** array of quick starts */
7
+ quickStarts: QuickStart[];
8
+ /** id of the currently active quick start */
9
+ activeQuickStartID: string;
10
+ /** setter for the active quick starts */
11
+ setActiveQuickStartID: React.Dispatch<React.SetStateAction<string>>;
12
+ /** quick starts state object */
13
+ allQuickStartStates: AllQuickStartStates;
14
+ /** setter for the quick starts state object */
15
+ setAllQuickStartStates: React.Dispatch<React.SetStateAction<AllQuickStartStates>>;
16
+ /** content to render within the container */
17
+ children?: React.ReactNode;
18
+ /** element to render the drawer panel into */
19
+ appendTo?: HTMLElement | (() => HTMLElement);
20
+ /** if true, the panel will take up the full browser width */
21
+ fullWidth?: boolean;
22
+ /** callback when an in-progress quick start is closed */
23
+ onCloseInProgress?: any;
24
+ /** callback when a not-in-progress quick start is closed */
25
+ onCloseNotInProgress?: any;
26
+ /** true to show footer buttons in the catalog tiles (default true) */
27
+ showCardFooters?: boolean;
28
+ /** true to use legacy drawer header variant colors */
29
+ useLegacyHeaderColors?: boolean;
30
+ /** text resources object */
31
+ resourceBundle?: any;
32
+ /** language of the current resource bundle
33
+ * Add custom strings: https://github.com/patternfly/patternfly-quickstarts/tree/main/packages/module#localization
34
+ */
35
+ language?: string;
36
+ /** if true, will show a loading spinner on the catalog page (default false) */
37
+ loading?: boolean;
38
+ /** if true, will update the browser URL with ?quickstart={ID} (default true) */
39
+ useQueryParams?: boolean;
40
+ /** if true, the TaskReview component, aka "Check your work", will be shown regardless of task status */
41
+ alwaysShowTaskReview?: boolean;
42
+ /**
43
+ * Additional markdown extensions and renderers to use
44
+ * Example usage: https://github.com/patternfly/patternfly-quickstarts/tree/main/packages/module#markdown-extensions
45
+ */
46
+ markdown?: {
47
+ extensions?: any[];
48
+ renderExtension?: (docContext: Document, rootSelector: string) => React.ReactNode;
49
+ };
50
+ /** additional quick start context props */
51
+ contextProps?: QuickStartContextValues;
52
+ }
53
+ export declare const QuickStartContainer: React.FC<QuickStartContainerProps>;
54
+ export interface QuickStartDrawerProps extends React.HTMLProps<HTMLDivElement> {
55
+ quickStarts?: QuickStart[];
56
+ children?: React.ReactNode;
57
+ appendTo?: HTMLElement | (() => HTMLElement);
58
+ fullWidth?: boolean;
59
+ onCloseInProgress?: any;
60
+ onCloseNotInProgress?: any;
61
+ }
62
+ export declare const QuickStartDrawer: React.FC<QuickStartDrawerProps>;
@@ -1,9 +1,9 @@
1
- import * as React from 'react';
2
- export declare const removeParagraphWrap: (markdown: string) => string;
3
- interface QuickStartMarkdownViewProps {
4
- content: string;
5
- exactHeight?: boolean;
6
- className?: string;
7
- }
8
- declare const QuickStartMarkdownView: React.FC<QuickStartMarkdownViewProps>;
9
- export default QuickStartMarkdownView;
1
+ import * as React from 'react';
2
+ export declare const removeParagraphWrap: (markdown: string) => string;
3
+ interface QuickStartMarkdownViewProps {
4
+ content: string;
5
+ exactHeight?: boolean;
6
+ className?: string;
7
+ }
8
+ declare const QuickStartMarkdownView: React.FC<QuickStartMarkdownViewProps>;
9
+ export default QuickStartMarkdownView;
@@ -1,15 +1,15 @@
1
- import './QuickStartPanelContent.scss';
2
- import * as React from 'react';
3
- import { QuickStart } from './utils/quick-start-types';
4
- declare type HandleClose = () => void;
5
- interface QuickStartPanelContentProps {
6
- quickStarts: QuickStart[];
7
- activeQuickStartID: string;
8
- handleClose: HandleClose;
9
- appendTo?: HTMLElement | (() => HTMLElement);
10
- isResizable?: boolean;
11
- showClose?: boolean;
12
- headerVariant?: '' | 'blue-white';
13
- }
14
- declare const QuickStartPanelContent: React.FC<QuickStartPanelContentProps>;
15
- export default QuickStartPanelContent;
1
+ import './QuickStartPanelContent.scss';
2
+ import * as React from 'react';
3
+ import { QuickStart } from './utils/quick-start-types';
4
+ type HandleClose = () => void;
5
+ interface QuickStartPanelContentProps {
6
+ quickStarts: QuickStart[];
7
+ activeQuickStartID: string;
8
+ handleClose: HandleClose;
9
+ appendTo?: HTMLElement | (() => HTMLElement);
10
+ isResizable?: boolean;
11
+ showClose?: boolean;
12
+ headerVariant?: '' | 'blue-white';
13
+ }
14
+ declare const QuickStartPanelContent: React.FC<QuickStartPanelContentProps>;
15
+ export default QuickStartPanelContent;
@@ -1,6 +1,6 @@
1
- import * as React from 'react';
2
- export interface QuickStartCatalogHeaderProps {
3
- title: string;
4
- hint?: string;
5
- }
6
- export declare const QuickStartCatalogHeader: React.FC<QuickStartCatalogHeaderProps>;
1
+ import * as React from 'react';
2
+ export interface QuickStartCatalogHeaderProps {
3
+ title: string;
4
+ hint?: string;
5
+ }
6
+ export declare const QuickStartCatalogHeader: React.FC<QuickStartCatalogHeaderProps>;
@@ -1,5 +1,5 @@
1
- import * as React from 'react';
2
- export interface QuickStartCatalogSectionProps {
3
- children: React.ReactNode;
4
- }
5
- export declare const QuickStartCatalogSection: React.FC<QuickStartCatalogSectionProps>;
1
+ import * as React from 'react';
2
+ export interface QuickStartCatalogSectionProps {
3
+ children: React.ReactNode;
4
+ }
5
+ export declare const QuickStartCatalogSection: React.FC<QuickStartCatalogSectionProps>;
@@ -1,5 +1,5 @@
1
- import * as React from 'react';
2
- export interface QuickStartCatalogToolbarProps {
3
- children: React.ReactNode;
4
- }
5
- export declare const QuickStartCatalogToolbar: React.FC<QuickStartCatalogToolbarProps>;
1
+ import * as React from 'react';
2
+ export interface QuickStartCatalogToolbarProps {
3
+ children: React.ReactNode;
4
+ }
5
+ export declare const QuickStartCatalogToolbar: React.FC<QuickStartCatalogToolbarProps>;
@@ -1,3 +1,3 @@
1
- export * from './QuickStartCatalogHeader';
2
- export * from './QuickStartCatalogSection';
3
- export * from './QuickStartCatalogToolbar';
1
+ export * from './QuickStartCatalogHeader';
2
+ export * from './QuickStartCatalogSection';
3
+ export * from './QuickStartCatalogToolbar';
@@ -1,8 +1,8 @@
1
- import * as React from 'react';
2
- import { QuickStart } from '../utils/quick-start-types';
3
- import './QuickStartCatalog.scss';
4
- interface QuickStartCatalogProps {
5
- quickStarts: QuickStart[];
6
- }
7
- declare const QuickStartCatalog: React.FC<QuickStartCatalogProps>;
8
- export default QuickStartCatalog;
1
+ import * as React from 'react';
2
+ import { QuickStart } from '../utils/quick-start-types';
3
+ import './QuickStartCatalog.scss';
4
+ interface QuickStartCatalogProps {
5
+ quickStarts: QuickStart[];
6
+ }
7
+ declare const QuickStartCatalog: React.FC<QuickStartCatalogProps>;
8
+ export default QuickStartCatalog;
@@ -1,11 +1,11 @@
1
- import * as React from 'react';
2
- import { QuickStart, QuickStartStatus } from '../utils/quick-start-types';
3
- import './QuickStartTile.scss';
4
- interface QuickStartTileProps {
5
- quickStart: QuickStart;
6
- status: QuickStartStatus;
7
- isActive: boolean;
8
- onClick?: () => void;
9
- }
10
- declare const QuickStartTile: React.FC<QuickStartTileProps>;
11
- export default QuickStartTile;
1
+ import * as React from 'react';
2
+ import { QuickStart, QuickStartStatus } from '../utils/quick-start-types';
3
+ import './QuickStartTile.scss';
4
+ interface QuickStartTileProps {
5
+ quickStart: QuickStart;
6
+ status: QuickStartStatus;
7
+ isActive: boolean;
8
+ onClick?: () => void;
9
+ }
10
+ declare const QuickStartTile: React.FC<QuickStartTileProps>;
11
+ export default QuickStartTile;
@@ -1,8 +1,8 @@
1
- import * as React from 'react';
2
- import './QuickStartTileDescription.scss';
3
- interface QuickStartTileDescriptionProps {
4
- description: string;
5
- prerequisites?: string[];
6
- }
7
- declare const QuickStartTileDescription: React.FC<QuickStartTileDescriptionProps>;
8
- export default QuickStartTileDescription;
1
+ import * as React from 'react';
2
+ import './QuickStartTileDescription.scss';
3
+ interface QuickStartTileDescriptionProps {
4
+ description: string;
5
+ prerequisites?: string[];
6
+ }
7
+ declare const QuickStartTileDescription: React.FC<QuickStartTileDescriptionProps>;
8
+ export default QuickStartTileDescription;