@patternfly/quickstarts 2.3.3 → 2.3.4

package/dist/ConsoleInternal/components/markdown-view.d.ts

@@ -5,7 +5,7 @@ declare type ShowdownExtension = {
     regex?: RegExp;
     replace?: (...args: any[]) => string;
 };
-export declare const markdownConvert: (markdown: any, extensions?: ShowdownExtension[]) => any;
+export declare const markdownConvert: (markdown: string, extensions?: ShowdownExtension[]) => Promise<any>;
 declare type SyncMarkdownProps = {
     content?: string;
     emptyMsg?: string;

package/dist/ConsoleShared/src/components/markdown-extensions/accordion-extension.d.ts

@@ -0,0 +1,7 @@
+import './showdown-extension.scss';
+declare const useAccordionShowdownExtension: () => {
+    type: string;
+    regex: RegExp;
+    replace: (_text: string, accordionContent: string, _command: string, accordionHeading: string) => string;
+};
+export default useAccordionShowdownExtension;

package/dist/ConsoleShared/src/components/markdown-extensions/accordion-render-extension.d.ts

@@ -0,0 +1,6 @@
+import * as React from 'react';
+declare type accordionRenderExtensionProps = {
+    docContext: HTMLDocument;
+};
+declare const AccordionRenderExtension: React.FC<accordionRenderExtensionProps>;
+export default AccordionRenderExtension;

package/dist/ConsoleShared/src/components/markdown-extensions/const.d.ts

@@ -1,3 +1,5 @@
 export declare const MARKDOWN_COPY_BUTTON_ID = "data-copy-for";
 export declare const MARKDOWN_EXECUTE_BUTTON_ID = "data-execute-for";
 export declare const MARKDOWN_SNIPPET_ID = "data-snippet-id";
+export declare const ACCORDION_MARKDOWN_BUTTON_ID = "accordion-markdown-button-id";
+export declare const ACCORDION_MARKDOWN_CONTENT_ID = "accordion-markdown-content-id";

package/dist/ConsoleShared/src/components/markdown-extensions/index.d.ts

@@ -3,3 +3,5 @@ export { default as useInlineCopyClipboardShowdownExtension } from './inline-cli
 export { default as useMultilineCopyClipboardShowdownExtension } from './multiline-clipboard-extension';
 export { default as useAdmonitionShowdownExtension } from './admonition-extension';
 export { default as useCodeShowdownExtension } from './code-extension';
+export { default as useAccordionShowdownExtension } from './accordion-extension';
+export { default as AccordionRenderExtension } from './accordion-render-extension';

package/dist/index.es.js

@@ -1,16 +1,16 @@
 import * as React from 'react';
 import React__default, { createContext, useCallback, useEffect, useState } from 'react';
-import { Card, CardHeader, CardActions, CardTitle, CardBody, CardFooter, Modal as Modal$1, Tooltip, Alert, CodeBlock, Popover, PopoverPosition, Button, Text, TextVariants, TextList, TextListItem, Flex, FlexItem, Title, Label, Gallery, GalleryItem, ToolbarItem, SearchInput, Select, SelectVariant, SelectOption, Toolbar, ToolbarContent, EmptyState, EmptyStateIcon, EmptyStateBody, EmptyStatePrimary, Divider, ModalVariant, WizardNavItem, List, ExpandableSection, ListItem, Radio, DrawerPanelContent, DrawerHead, DrawerActions, DrawerCloseButton, DrawerPanelBody, Drawer, DrawerContent, DrawerContentBody, OptionsMenuItem, Stack, StackItem, OptionsMenu, OptionsMenuToggle } from '@patternfly/react-core';
+import { Card, CardHeader, CardActions, CardTitle, CardBody, CardFooter, Modal as Modal$1, Tooltip, Alert, CodeBlock, Accordion, AccordionItem, AccordionToggle, AccordionContent, Popover, PopoverPosition, Button, Text, TextVariants, TextList, TextListItem, Flex, FlexItem, Title, Label, Gallery, GalleryItem, ToolbarItem, SearchInput, Select, SelectVariant, SelectOption, Toolbar, ToolbarContent, EmptyState, EmptyStateIcon, EmptyStateBody, EmptyStatePrimary, Divider, ModalVariant, WizardNavItem, List, ExpandableSection, ListItem, Radio, DrawerPanelContent, DrawerHead, DrawerActions, DrawerCloseButton, DrawerPanelBody, Drawer, DrawerContent, DrawerContentBody, OptionsMenuItem, Stack, StackItem, OptionsMenu, OptionsMenuToggle } from '@patternfly/react-core';
 import SearchIcon from '@patternfly/react-icons/dist/js/icons/search-icon';
 import { css } from '@patternfly/react-styles';
 import RocketIcon from '@patternfly/react-icons/dist/js/icons/rocket-icon';
-import { __rest } from 'tslib';
+import { __rest, __awaiter } from 'tslib';
 import * as ReactDOM from 'react-dom';
 import { renderToStaticMarkup } from 'react-dom/server';
 import CopyIcon from '@patternfly/react-icons/dist/js/icons/copy-icon';
 import LightbulbIcon from '@patternfly/react-icons/dist/js/icons/lightbulb-icon';
 import FireIcon from '@patternfly/react-icons/dist/js/icons/fire-icon';
-import { Converter } from 'showdown';
+import { marked } from 'marked';
 import SyncAltIcon from '@patternfly/react-icons/dist/js/icons/sync-alt-icon';
 import CheckCircleIcon from '@patternfly/react-icons/dist/js/icons/check-circle-icon';
 import ExclamationCircleIcon from '@patternfly/react-icons/dist/js/icons/exclamation-circle-icon';
@@ -1195,7 +1195,9 @@ const MarkdownHighlightExtension = ({ docContext, rootSelector, }) => {
 };
 
 const MARKDOWN_COPY_BUTTON_ID = 'data-copy-for';
-const MARKDOWN_SNIPPET_ID = 'data-snippet-id';
+const MARKDOWN_SNIPPET_ID = 'data-snippet-id';
+const ACCORDION_MARKDOWN_BUTTON_ID = `accordion-markdown-button-id`;
+const ACCORDION_MARKDOWN_CONTENT_ID = `accordion-markdown-content-id`;
 
 const CopyClipboard = ({ element, rootSelector, docContext, }) => {
     const { getResource } = React.useContext(QuickStartContext);
@@ -1285,16 +1287,7 @@ const useMultilineCopyClipboardShowdownExtension = () => {
 
 // eslint-disable-next-line @typescript-eslint/no-require-imports
 const DOMPurify = require('dompurify');
-const markdownConvert = (markdown, extensions) => {
-    const converter = new Converter({
-        tables: true,
-        openLinksInNewWindow: true,
-        strikethrough: true,
-        emoji: false,
-    });
-    if (extensions) {
-        converter.addExtension(extensions);
-    }
+const markdownConvert = (markdown, extensions) => __awaiter(void 0, void 0, void 0, function* () {
     DOMPurify.addHook('beforeSanitizeElements', function (node) {
         // nodeType 1 = element type
         // transform anchor tags
@@ -1321,20 +1314,38 @@ const markdownConvert = (markdown, extensions) => {
             node.setAttribute('xlink:show', 'new');
         }
     });
-    return DOMPurify.sanitize(converter.makeHtml(markdown), {
-        USE_PROFILES: {
-            html: true,
-            svg: true,
-        },
-    });
-};
+    // Replace code fences with non markdown formatting relates tokens so that marked doesn't try to parse them as code spans
+    const markdownWithSubstitutedCodeFences = markdown.replace(/```/g, '@@@');
+    const parsedMarkdown = yield marked.parse(markdownWithSubstitutedCodeFences);
+    // Swap the temporary tokens back to code fences before we run the extensions
+    let md = parsedMarkdown.replace(/@@@/g, '```');
+    if (extensions) {
+        // Convert code spans back to md format before we run the custom extension regexes
+        md = md.replace(/<code>(.*)<\/code>/g, '`$1`');
+        extensions.forEach(({ regex, replace }) => {
+            if (regex) {
+                md = md.replace(regex, replace);
+            }
+        });
+        // Convert any remaining backticks back into code spans
+        md = md.replace(/`(.*)`/g, '<code>$1</code>');
+    }
+    return DOMPurify.sanitize(md);
+});
 const SyncMarkdownView = ({ 
 // truncateContent,
 content, emptyMsg, extensions, renderExtension, exactHeight, inline, className, }) => {
     const { getResource } = React.useContext(QuickStartContext);
-    const markup = React.useMemo(() => {
-        return markdownConvert(content || emptyMsg || getResource('Not available'), extensions);
-    }, [content, emptyMsg, extensions, getResource]);
+    const [markup, setMarkup] = React.useState('');
+    React.useEffect(() => {
+        function getMd() {
+            return __awaiter(this, void 0, void 0, function* () {
+                const md = yield markdownConvert(content || emptyMsg || getResource('Not available'), extensions);
+                setMarkup(md);
+            });
+        }
+        getMd();
+    }, [content, emptyMsg, getResource, extensions]);
     const innerProps = {
         renderExtension: (extensions === null || extensions === void 0 ? void 0 : extensions.length) > 0 ? renderExtension : undefined,
         exactHeight,
@@ -1459,6 +1470,7 @@ const QuickStartMarkdownView = ({ content, exactHeight, className, }) => {
     const multilineCopyClipboardShowdownExtension = useMultilineCopyClipboardShowdownExtension();
     const admonitionShowdownExtension = useAdmonitionShowdownExtension();
     const codeShowdownExtension = useCodeShowdownExtension();
+    const accordionShowdownExtension = useAccordionShowdownExtension();
     return (React.createElement(SyncMarkdownView, { inline: true, content: content, exactHeight: exactHeight, extensions: [
             {
                 type: 'lang',
@@ -1482,8 +1494,10 @@ const QuickStartMarkdownView = ({ content, exactHeight, className, }) => {
             multilineCopyClipboardShowdownExtension,
             admonitionShowdownExtension,
             codeShowdownExtension,
+            accordionShowdownExtension,
             ...(markdown ? markdown.extensions : []),
         ], renderExtension: (docContext, rootSelector) => (React.createElement(React.Fragment, null,
+            React.createElement(AccordionRenderExtension, { docContext: docContext }),
             React.createElement(MarkdownHighlightExtension, { docContext: docContext, rootSelector: rootSelector }),
             React.createElement(MarkdownCopyClipboard, { docContext: docContext, rootSelector: rootSelector }),
             markdown &&
@@ -1539,6 +1553,45 @@ const useCodeShowdownExtension = () => {
     }), []);
 };
 
+const useAccordionShowdownExtension = () => {
+    return React.useMemo(() => ({
+        type: 'lang',
+        regex: /\[(.+)]{{(accordion) ("(.*?)")}}/g,
+        replace: (_text, accordionContent, _command, accordionHeading) => {
+            const accordionId = new String(accordionHeading).replace(/\s/g, '-');
+            return removeTemplateWhitespace(renderToStaticMarkup(React.createElement(Accordion, { asDefinitionList: true },
+                React.createElement(AccordionItem, null,
+                    React.createElement(AccordionToggle, { isExpanded: false, id: `${ACCORDION_MARKDOWN_BUTTON_ID}-${accordionId}` }, accordionHeading),
+                    React.createElement(AccordionContent, { id: `${ACCORDION_MARKDOWN_CONTENT_ID}-${accordionId}`, isHidden: !false }, accordionContent)))));
+        },
+    }), []);
+};
+
+const AccordionShowdownHandler = ({ buttonElement, contentElement, }) => {
+    const [expanded, setExpanded] = React.useState(false);
+    const handleClick = () => {
+        const expandedModifier = 'pf-m-expanded';
+        buttonElement.className = `pf-c-accordion__toggle ${!expanded ? expandedModifier : ''}`;
+        contentElement.hidden = expanded;
+        contentElement.className = `pf-c-accordion__expanded-content ${!expanded ? expandedModifier : ''}`;
+        setExpanded(!expanded);
+    };
+    useEventListener(buttonElement, 'click', handleClick);
+    return React.createElement(React.Fragment, null);
+};
+const AccordionRenderExtension = ({ docContext }) => {
+    const buttonElements = docContext.querySelectorAll(`[id ^= ${ACCORDION_MARKDOWN_BUTTON_ID}]`);
+    const contentElements = docContext.querySelectorAll(`[id ^= ${ACCORDION_MARKDOWN_CONTENT_ID}]`);
+    return buttonElements.length > 0 ? (React.createElement(React.Fragment, null, Array.from(buttonElements).map((elm) => {
+        const content = Array.from(contentElements).find((elm2) => {
+            const elmId = elm.id.split(ACCORDION_MARKDOWN_BUTTON_ID)[1];
+            const elm2Id = elm2.id.split(ACCORDION_MARKDOWN_CONTENT_ID)[1];
+            return elmId === elm2Id;
+        });
+        return (React.createElement(AccordionShowdownHandler, { key: elm.id.split(ACCORDION_MARKDOWN_BUTTON_ID)[1], buttonElement: elm, contentElement: content }));
+    }))) : null;
+};
+
 const FallbackImg = ({ src, alt, className, fallback }) => {
     const [isSrcValid, setIsSrcValid] = React.useState(true);
     if (src && isSrcValid) {
@@ -1959,12 +2012,22 @@ const TaskIcon = ({ taskIndex, taskStatus }) => {
 };
 const QuickStartTaskHeader = ({ title, taskIndex, subtitle, taskStatus, size, isActiveTask, onTaskSelect, children, }) => {
     const titleRef = React.useRef(null);
+    const [parsedTitle, setParsedTitle] = React.useState('');
     React.useEffect(() => {
         if (isActiveTask) {
             // Focus the WizardNavItem button element that contains the title
             titleRef.current.parentNode.focus();
         }
     }, [isActiveTask]);
+    React.useEffect(() => {
+        function getParsedTitle() {
+            return __awaiter(this, void 0, void 0, function* () {
+                const convertedMdTitle = yield markdownConvert(title);
+                setParsedTitle(removeParagraphWrap(convertedMdTitle));
+            });
+        }
+        getParsedTitle();
+    }, [title]);
     const classNames = css('pfext-quick-start-task-header__title', {
         'pfext-quick-start-task-header__title-success': taskStatus === QuickStartTaskStatus.SUCCESS,
         'pfext-quick-start-task-header__title-failed': taskStatus === (QuickStartTaskStatus.FAILED || QuickStartTaskStatus.VISITED),
@@ -1980,7 +2043,7 @@ const QuickStartTaskHeader = ({ title, taskIndex, subtitle, taskStatus, size, is
     const content = (React.createElement("div", { className: "pfext-quick-start-task-header", ref: titleRef },
         React.createElement(TaskIcon, { taskIndex: taskIndex, taskStatus: taskStatus }),
         React.createElement(Title, { headingLevel: "h3", size: size, className: classNames },
-            React.createElement("span", { dangerouslySetInnerHTML: { __html: removeParagraphWrap(markdownConvert(title)) } }),
+            React.createElement("span", { dangerouslySetInnerHTML: { __html: parsedTitle } }),
             isActiveTask && subtitle && (React.createElement("span", { className: "pfext-quick-start-task-header__subtitle", "data-test-id": "quick-start-task-subtitle" },
                 ' ',
                 subtitle))),
@@ -2187,6 +2250,7 @@ const QuickStartPanelContent = (_a) => {
     const titleRef = React.useRef(null);
     const { getResource, activeQuickStartState } = React.useContext(QuickStartContext);
     const [contentRef, setContentRef] = React.useState();
+    const [displayName, setDisplayName] = React.useState('');
     const shadows = useScrollShadows(contentRef);
     const quickStart = quickStarts.find((qs) => qs.metadata.name === activeQuickStartID);
     const taskNumber = activeQuickStartState === null || activeQuickStartState === void 0 ? void 0 : activeQuickStartState.taskNumber;
@@ -2214,13 +2278,22 @@ const QuickStartPanelContent = (_a) => {
             titleRef.current.focus();
         }
     }, [quickStart]);
+    React.useEffect(() => {
+        function getDisplayName() {
+            return __awaiter(this, void 0, void 0, function* () {
+                const convertedMdDisplayName = yield markdownConvert(quickStart === null || quickStart === void 0 ? void 0 : quickStart.spec.displayName);
+                setDisplayName(removeParagraphWrap(convertedMdDisplayName));
+            });
+        }
+        getDisplayName();
+    }, [quickStart]);
     const content = quickStart ? (React.createElement(DrawerPanelContent, Object.assign({ isResizable: isResizable, className: "pfext-quick-start__base", "data-testid": `qs-drawer-${camelize(quickStart.spec.displayName)}`, "data-qs": `qs-step-${getStep()}`, "data-test": "quickstart drawer" }, props),
         React.createElement("div", { className: headerClasses },
             React.createElement(DrawerHead, null,
                 React.createElement("div", { className: "pfext-quick-start-panel-content__title", tabIndex: -1, ref: titleRef },
-                    React.createElement(Title, { headingLevel: "h1", size: "xl", className: "pfext-quick-start-panel-content__name", style: { marginRight: 'var(--pf-global--spacer--md)' } },
+                    React.createElement(Title, { headingLevel: "h2", size: "xl", className: "pfext-quick-start-panel-content__name", style: { marginRight: 'var(--pf-global--spacer--md)' } },
                         React.createElement("span", { dangerouslySetInnerHTML: {
-                                __html: removeParagraphWrap(markdownConvert(quickStart === null || quickStart === void 0 ? void 0 : quickStart.spec.displayName)),
+                                __html: displayName,
                             } }),
                         ' ',
                         React.createElement("small", { className: "pfext-quick-start-panel-content__duration" }, (quickStart === null || quickStart === void 0 ? void 0 : quickStart.spec.durationMinutes) ? getResource('{{type}} • {{duration, number}} minutes', quickStart === null || quickStart === void 0 ? void 0 : quickStart.spec.durationMinutes)
@@ -2387,7 +2460,7 @@ const HelpTopicPanelContent = (_a) => {
         setActiveHelpTopicByName(topicName);
         toggleHelpTopicMenu();
     };
-    const menuItems = filteredHelpTopics.length > 0 &&
+    const menuItems = filteredHelpTopics.length > 1 &&
         filteredHelpTopics.map((topic) => {
             return (React.createElement(OptionsMenuItem, { key: topic.name, onSelect: onSelectHelpTopic, id: topic.name }, topic.title));
         });