Add directive to transfert URL search parameters from the documentati…

…on page to jupyterlite
jupyterlite · Sep 7, 2023 · d65dbbb · d65dbbb
1 parent 83663db
commit d65dbbb
Show file tree

Hide file tree

Showing 2 changed files with 44 additions and 7 deletions.
diff --git a/jupyterlite_sphinx/jupyterlite_sphinx.js b/jupyterlite_sphinx/jupyterlite_sphinx.js
@@ -11,3 +11,19 @@ window.jupyterliteShowIframe = (tryItButtonId, iframeSrc) => {
   tryItButton.classList.remove('jupyterlite_sphinx_try_it_button_unclicked');
   tryItButton.classList.add('jupyterlite_sphinx_try_it_button_clicked');
 }
+
+window.jupyterliteConcatSearchParams = (iframeSrc, params) => {
+  const baseURL = window.location.origin;
+  const iframeUrl = new URL(iframeSrc, baseURL);
+
+  let pageParams = new URLSearchParams(window.location.search);
+
+  params.forEach(param => {
+    value = pageParams.get(param);
+    if (value !== null) {
+      iframeUrl.searchParams.append(param, value);
+    }
+  });
+
+  return iframeUrl.toString().replace(baseURL, '');
+}
diff --git a/jupyterlite_sphinx/jupyterlite_sphinx.py b/jupyterlite_sphinx/jupyterlite_sphinx.py
@@ -51,6 +51,7 @@ def __init__(
         height="100%",
         prompt=False,
         prompt_color=None,
+        search_params=[],
         **attributes,
     ):
         super().__init__(
@@ -60,10 +61,12 @@ def __init__(
             height=height,
             prompt=prompt,
             prompt_color=prompt_color,
+            search_params=search_params
         )
 
     def html(self):
         iframe_src = self["iframe_src"]
+        search_params = self["search_params"]
 
         if self["prompt"]:
             prompt = (
@@ -76,13 +79,24 @@ def html(self):
             placeholder_id = uuid4()
             container_style = f'width: {self["width"]}; height: {self["height"]};'
 
-            return (
-                f"<div class=\"jupyterlite_sphinx_iframe_container\" style=\"{container_style}\" onclick=window.jupyterliteShowIframe('{placeholder_id}','{iframe_src}')>"
-                f'  <div id={placeholder_id} class="jupyterlite_sphinx_try_it_button jupyterlite_sphinx_try_it_button_unclicked" style="background-color: {prompt_color};">'
-                f"    {prompt}"
-                "   </div>"
-                "</div>"
-            )
+            return (f"""
+                <div
+                    class=\"jupyterlite_sphinx_iframe_container\"
+                    style=\"{container_style}\"
+                    onclick=\"window.jupyterliteShowIframe(
+                        '{placeholder_id}',
+                        window.jupyterliteConcatSearchParams('{iframe_src}',{search_params})
+                    )\"
+                >
+                    <div
+                        id={placeholder_id}
+                        class=\"jupyterlite_sphinx_try_it_button jupyterlite_sphinx_try_it_button_unclicked\"
+                        style=\"background-color: {prompt_color};\"
+                    >
+                    {prompt}
+                    </div>
+                </div>
+            """)
 
         return (
             f'<iframe src="{iframe_src}"'
@@ -233,6 +247,7 @@ class _LiteDirective(SphinxDirective):
         "theme": directives.unchanged,
         "prompt": directives.unchanged,
         "prompt_color": directives.unchanged,
+        "search_params": directives.unchanged,
     }
 
     def run(self):
@@ -242,6 +257,11 @@ def run(self):
         prompt = self.options.pop("prompt", False)
         prompt_color = self.options.pop("prompt_color", None)
 
+        search_params = list(map(
+            str.strip,
+            self.options.pop("search_params", "").split(",")
+        ))
+
         source_location = os.path.dirname(self.get_source_info()[0])
 
         prefix = os.path.relpath(
@@ -276,6 +296,7 @@ def run(self):
                 height=height,
                 prompt=prompt,
                 prompt_color=prompt_color,
+                search_params=search_params,
                 lite_options=self.options,
             )
         ]