Merge pull request #36 from patternfly/readme-update

update readme
patternfly · Sep 3, 2021 · 4e82c76 · 4e82c76
2 parents 2f31514 + 1105b82
commit 4e82c76
Show file tree

Hide file tree

Showing 3 changed files with 16 additions and 6 deletions.
diff --git a/packages/dev/package.json b/packages/dev/package.json
@@ -9,7 +9,7 @@
     "serve": "serve public"
   },
   "dependencies": {
-    "@patternfly/quickstarts": "1.2.0",
+    "@patternfly/quickstarts": "1.2.1",
     "@patternfly/react-core": "^4.135.0",
     "asciidoctor": "^2.2.1",
     "i18next": "^19.8.3",

diff --git a/packages/module/README.md b/packages/module/README.md
@@ -41,12 +41,15 @@ import "@patternfly/quickstarts/dist/quickstarts.min.css";
 
 import * as React from "react";
 import {
-  QuickStartDrawer,
-  QuickStartContext,
-  QuickStartContextProvider,
+  QuickStartContainer,
   QuickStartCatalogPage,
-  useLocalStorage
+  QuickStartContext,
+  useLocalStorage,
+  setQueryArgument,
+  removeQueryArgument,
+  QUICKSTART_ID_FILTER_KEY
 } from "@patternfly/quickstarts";
+import { Button } from "@patternfly/react-core";
 import jsYaml from "js-yaml";
 // quick start files could be yaml files or js files, or really anything,
 // as long as they get parsed out to the expexted JSON format
@@ -82,6 +85,8 @@ const App = () => {
     }, 1500);
   }, []);
 
+  const withQueryParams = true;
+
   const drawerProps = {
     quickStarts,
     activeQuickStartID,
@@ -90,15 +95,20 @@ const App = () => {
     setAllQuickStartStates,
     showCardFooters: false,
     loading,
+    useQueryParams: withQueryParams,
   };
 
   const toggleQuickStart = (quickStartId: string) => {
     if (activeQuickStartID !== quickStartId) {
       // activate
       setActiveQuickStartID(quickStartId);
+      // optionally add the browser URL query param
+      withQueryParams && setQueryArgument(QUICKSTART_ID_FILTER_KEY, quickStartId);
     } else {
       // deactivate
       setActiveQuickStartID('');
+      // optionally remove the browser URL query param
+      withQueryParams && removeQueryArgument(QUICKSTART_ID_FILTER_KEY);
     }
   };
 

diff --git a/packages/module/package.json b/packages/module/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@patternfly/quickstarts",
-  "version": "1.2.0",
+  "version": "1.2.1",
   "description": "PatternFly quick starts",
   "files": [
     "dist"