feat: Implement StaticText UserParam

Author: rht

examples/wolf_sheep/wolf_sheep/server.py

@@ -48,6 +48,8 @@ def wolf_sheep_portrayal(agent):
 )
 
 model_params = {
+    # The following line is an example to showcase StaticText.
+    "title": mesa.visualization.StaticText("Parameters:"),
     "grass": mesa.visualization.Checkbox("Grass Enabled", True),
     "grass_regrowth_time": mesa.visualization.Slider("Grass Regrowth Time", 20, 1, 50),
     "initial_sheep": mesa.visualization.Slider(

mesa/visualization/UserParam.py

@@ -253,3 +253,18 @@ def value(self, value):
                 "Selected choice value not in available choices, selected first choice from 'choices' list"
             )
             self._value = self.choices[0]
+
+
+class StaticText(UserParam):
+    """
+    A non-input textbox for displaying model info.
+
+    Example:
+    static_text = StaticText("This is a descriptive textbox")
+    """
+
+    def __init__(self, value=None):
+        self.param_type = STATIC_TEXT
+        self._value = value
+        valid = isinstance(self.value, str)
+        self.maybe_raise_error(valid)

tests/test_usersettableparam.py

@@ -1,5 +1,11 @@
 from unittest import TestCase
-from mesa.visualization.UserParam import UserSettableParameter, Slider, Checkbox, Choice
+from mesa.visualization.UserParam import (
+    UserSettableParameter,
+    Slider,
+    Checkbox,
+    Choice,
+    StaticText,
+)
 
 
 class TestOption(TestCase):
@@ -20,6 +26,7 @@ def setUp(self):
             "slider", value=123, min_value=100, max_value=200
         )
         self.slider_option_standalone = Slider(value=123, min_value=100, max_value=200)
+        self.static_text_option = StaticText("Hurr, Durr Im'a Sheep")
 
     def test_number(self):
         assert self.number_option.value == 123
@@ -52,3 +59,6 @@ def test_slider(self):
             assert option.json["value"] == 200
         with self.assertRaises(ValueError):
             Slider()
+
+    def test_static_text(self):
+        assert self.static_text_option.value == "Hurr, Durr Im'a Sheep"