add get_alarm_window() to MPComponent

Author: minhsueh

crystal_toolkit/components/pourbaix.py

@@ -460,8 +460,8 @@ def _sub_layouts(self) -> dict[str, Component]:
                     [
                         html.Div(
                             [
-                                dcc.ConfirmDialog(
-                                    id=self.id("invalid-comp-alarm"),
+                                self.get_alarm_window(
+                                    self.id("invalid-comp-alarm"),
                                     message="Illegal composition entry!",
                                 ),
                                 html.Div(
@@ -521,7 +521,7 @@ def _sub_layouts(self) -> dict[str, Component]:
                         ),
                         html.Div(
                             [
-                                dcc.ConfirmDialog(
+                                self.get_alarm_window(
                                     id=self.id("invalid-conc-alarm"),
                                     message=f"Illegal concentration entry! Must be between {MIN_CONCENTRATION} and {MAX_CONCENTRATION} M",
                                 ),

crystal_toolkit/core/mpcomponent.py

@@ -627,6 +627,32 @@ def pair_element(idx, key=None, value=None):
 
         return add_label_help(dict_input, label, help_str)
 
+    def get_alarm_window(
+        self,
+        id: str,
+        message: str,
+        **kwargs,
+    ):
+        """Get the pop-out alarm window component, default set to not display
+        Eaxmple:
+        self.get_alarm_window(
+            self.id("invalid-comp-alarm"),
+            message="Illegal composition entry!"
+        ),
+
+        Return True in the callback function to show alarm
+        Output(self.id("invalid-conc-alarm"), "displayed") -> True
+
+        Args:
+            :param id: The name of the corresponding Python input, this is used
+        to name the component.
+            :param message (str): A default value for this input.
+        """
+        if not message:
+            raise ValueError("The error message cannot be empty!")
+
+        return dcc.ConfirmDialog(id=id, message=message, displayed=False, **kwargs)
+
     def get_kwarg_id(self, kwarg_name) -> dict[str, str]:
         return {
             "component_id": self._id,