Add in-app guide mechanism

src/aiidalab_qe/app/static/styles/infobox.css

@@ -13,3 +13,6 @@
 .info-box p {
   line-height: 24px;
 }
+.info-box.in-app-guide.show {
+  display: flex !important;
+}

src/aiidalab_qe/app/static/templates/guide.jinja

@@ -38,5 +38,8 @@
     For a more in-depth dive into the app's features, please refer to the
     <a href="https://aiidalab-qe.readthedocs.io/howto/index.html" target="_blank">how-to guides</a>.
   </p>
+
+  <p>
+    Alternatively, you can select one of our in-app guides below to walk through an example use-case.
   </p>
 </div>

src/aiidalab_qe/app/wrapper.py

@@ -2,6 +2,7 @@
 
 import ipywidgets as ipw
 import traitlets
+from IPython.display import Javascript, display
 
 
 def without_triggering(toggle: str):
@@ -52,7 +53,14 @@ def enable_toggles(self) -> None:
     @without_triggering("about_toggle")
     def _on_guide_toggle(self, change: dict):
         """Toggle the guide section."""
-        self._view.info_container.children = [self._view.guide] if change["new"] else []
+        self._view.info_container.children = (
+            [
+                self._view.guide,
+                self._view.guide_selection,
+            ]
+            if change["new"]
+            else []
+        )
         self._view.info_container.layout.display = "flex" if change["new"] else "none"
 
     @without_triggering("guide_toggle")
@@ -61,10 +69,35 @@ def _on_about_toggle(self, change: dict):
         self._view.info_container.children = [self._view.about] if change["new"] else []
         self._view.info_container.layout.display = "flex" if change["new"] else "none"
 
+    def _on_guide_select(self, change: dict):
+        """Toggle the guide section."""
+        display(
+            Javascript(f"""
+                document.querySelectorAll('.{change["old"]}').forEach((guide) => {'{'}
+                    guide.classList.remove('show');
+                {'}'});
+            """)
+        )
+        if (guide_class := change["new"]) != "none":
+            display(
+                Javascript(f"""
+                    document.querySelectorAll('.{guide_class}').forEach((guide) => {'{'}
+                        guide.classList.add('show');
+                    {'}'});
+                """)
+            )
+
+    def _on_close_first_time_info(self, _=None):
+        """Close the first time info box."""
+        self._view.first_time_users_infobox.layout.display = "none"
+        with open("first-time-user", "w") as file:
+            file.write("existing user")
+
     def _set_event_handlers(self) -> None:
         """Set up event handlers."""
         self._view.guide_toggle.observe(self._on_guide_toggle, "value")
         self._view.about_toggle.observe(self._on_about_toggle, "value")
+        self._view.guide_selection.observe(self._on_guide_select, "value")
 
 
 class AppWrapperModel(traitlets.HasTraits):
@@ -85,7 +118,7 @@ def __init__(self) -> None:
         from datetime import datetime
 
         from importlib_resources import files
-        from IPython.display import Image, display
+        from IPython.display import Image
         from jinja2 import Environment
 
         from aiidalab_qe.app.static import templates
@@ -140,6 +173,16 @@ def __init__(self) -> None:
         self.guide = ipw.HTML(env.from_string(guide_template).render())
         self.about = ipw.HTML(env.from_string(about_template).render())
 
+        self.guide_selection = ipw.RadioButtons(
+            options=[
+                "none",
+                "relaxation",
+                "bands",
+            ],
+            description="Guides:",
+            value="none",
+        )
+
         self.info_container = InfoBox()
 
         header = ipw.VBox(

src/aiidalab_qe/common/infobox.py

@@ -20,3 +20,20 @@ def __init__(self, classes: list[str] | None = None, **kwargs):
             for custom_class in custom_classes.split(" "):
                 if custom_class:
                     self.add_class(custom_class)
+
+
+class InAppGuide(InfoBox):
+    """The `InfoAppGuide` is used to set up in-app guides that may be toggle in unison."""
+
+    def __init__(self, guide_id: str, classes: list[str] | None = None, **kwargs):
+        """`InAppGuide` constructor.
+
+        Parameters
+        ----------
+        `guide_id` : `str`
+            The unique identifier for the guide.
+        `classes` : `list[str]`, optional
+            One or more CSS classes.
+        """
+        classes = ["in-app-guide", *(classes or []), guide_id]
+        super().__init__(classes=classes, **kwargs)

tests/test_infobox.py

@@ -1,4 +1,4 @@
-from aiidalab_qe.common.infobox import InfoBox
+from aiidalab_qe.common.infobox import InAppGuide, InfoBox
 
 
 def test_infobox_classes():
@@ -14,3 +14,17 @@ def test_infobox_classes():
             "custom-3",
         )
     )
+
+
+def test_in_app_guide():
+    """Test `InAppGuide` class."""
+    guide_id = "some_guide"
+    in_app_guide = InAppGuide(guide_id=guide_id)
+    assert all(
+        css_class in in_app_guide._dom_classes
+        for css_class in (
+            "info-box",
+            "in-app-guide",
+            guide_id,
+        )
+    )

tests/test_wrapper.py

@@ -18,7 +18,7 @@ def test_guide_toggle(self):
         self.controller._on_guide_toggle({"new": True})
         self._assert_guide_is_on()
         self.controller._on_guide_toggle({"new": False})
-        self._assert_no_guide_info()
+        self._assert_no_info()
 
     def test_about_toggle(self):
         """Test about_toggle method."""
@@ -27,33 +27,33 @@ def test_about_toggle(self):
         self.controller._on_about_toggle({"new": True})
         self._assert_about_is_on()
         self.controller._on_about_toggle({"new": False})
-        self._assert_no_guide_info()
+        self._assert_no_info()
 
     def test_toggle_switch(self):
         """Test toggle_switch method."""
         self._instansiate_mvc_components()
         self.controller.enable_toggles()
-        self._assert_no_guide_info()
+        self._assert_no_info()
         self.controller._on_guide_toggle({"new": True})
         self._assert_guide_is_on()
         self.controller._on_about_toggle({"new": True})
         self._assert_about_is_on()
         self.controller._on_guide_toggle({"new": True})
         self._assert_guide_is_on()
         self.controller._on_guide_toggle({"new": False})
-        self._assert_no_guide_info()
+        self._assert_no_info()
 
     def _assert_guide_is_on(self):
         """Assert guide is on."""
-        assert len(self.view.info_container.children) == 1
+        assert len(self.view.info_container.children) == 2
         assert self.view.guide in self.view.info_container.children
 
     def _assert_about_is_on(self):
         """Assert about is on."""
         assert len(self.view.info_container.children) == 1
         assert self.view.about in self.view.info_container.children
 
-    def _assert_no_guide_info(self):
+    def _assert_no_info(self):
         """Assert no info is shown."""
         assert len(self.view.info_container.children) == 0