@patternfly/quickstarts 2.2.3 → 2.2.4

package/dist/HelpTopicDrawer.d.ts

@@ -3,19 +3,25 @@ import * as React from 'react';
 import { QuickStartContextValues } from './utils/quick-start-context';
 import { HelpTopic } from './utils/help-topic-types';
 export interface HelpTopicContainerProps extends React.HTMLProps<HTMLDivElement> {
+    /** array of HelpTopics */
     helpTopics: HelpTopic[];
+    /** text resources object
+     * Add custom strings: https://github.com/patternfly/patternfly-quickstarts/tree/main/packages/module#localization
+     */
     resourceBundle?: any;
+    /** language of the current resource bundle */
     language?: string;
+    /** if true, will show a loading spinner on the catalog page (default false) */
     loading?: boolean;
     /**
      * Additional markdown extensions and renderers to use
-     * TODO: example usage - In the meantime you can take a look at:
-     * https://github.com/openshift/console/blob/master/frontend/packages/console-app/src/components/quick-starts/utils/quick-start-context.tsx#L235
+     * Example usage: https://github.com/patternfly/patternfly-quickstarts/tree/main/packages/module#markdown-extensions
      */
     markdown?: {
         extensions?: any[];
         renderExtension?: (docContext: HTMLDocument, rootSelector: string) => React.ReactNode;
     };
+    /** additional quick start context props */
     contextProps?: QuickStartContextValues;
 }
 export declare const HelpTopicContainer: React.FC<HelpTopicContainerProps>;

package/dist/QuickStartDrawer.d.ts

@@ -3,32 +3,51 @@ import * as React from 'react';
 import { QuickStartContextValues } from './utils/quick-start-context';
 import { QuickStart, AllQuickStartStates } from './utils/quick-start-types';
 export interface QuickStartContainerProps extends React.HTMLProps<HTMLDivElement> {
+    /** array of quick starts */
     quickStarts: QuickStart[];
+    /** id of the currently active quick start */
     activeQuickStartID: string;
+    /** setter for the active quick starts */
     setActiveQuickStartID: React.Dispatch<React.SetStateAction<string>>;
+    /** quick starts state object */
     allQuickStartStates: AllQuickStartStates;
+    /** setter for the quick starts state object */
     setAllQuickStartStates: React.Dispatch<React.SetStateAction<AllQuickStartStates>>;
+    /** content to render within the container */
     children?: React.ReactNode;
+    /** element to render the drawer panel into */
     appendTo?: HTMLElement | (() => HTMLElement);
+    /** if true, the panel will take up the full browser width */
     fullWidth?: boolean;
+    /** callback when an in-progress quick start is closed */
     onCloseInProgress?: any;
+    /** callback when a not-in-progress quick start is closed */
     onCloseNotInProgress?: any;
+    /** true to show footer buttons in the catalog tiles (default true) */
     showCardFooters?: boolean;
+    /** true to use legacy drawer header variant colors */
     useLegacyHeaderColors?: boolean;
+    /** text resources object */
     resourceBundle?: any;
+    /** language of the current resource bundle
+     * Add custom strings: https://github.com/patternfly/patternfly-quickstarts/tree/main/packages/module#localization
+     */
     language?: string;
+    /** if true, will show a loading spinner on the catalog page (default false) */
     loading?: boolean;
+    /** if true, will update the browser URL with ?quickstart={ID} (default true) */
     useQueryParams?: boolean;
+    /** if true, the TaskReview component, aka "Check your work", will be shown regardless of task status */
     alwaysShowTaskReview?: boolean;
     /**
      * Additional markdown extensions and renderers to use
-     * TODO: example usage - In the meantime you can take a look at:
-     * https://github.com/openshift/console/blob/master/frontend/packages/console-app/src/components/quick-starts/utils/quick-start-context.tsx#L235
+     * Example usage: https://github.com/patternfly/patternfly-quickstarts/tree/main/packages/module#markdown-extensions
      */
     markdown?: {
         extensions?: any[];
         renderExtension?: (docContext: HTMLDocument, rootSelector: string) => React.ReactNode;
     };
+    /** additional quick start context props */
     contextProps?: QuickStartContextValues;
 }
 export declare const QuickStartContainer: React.FC<QuickStartContainerProps>;