better-rtplot 0.6.0__tar.gz → 0.6.1__tar.gz

{better_rtplot-0.6.0 → better_rtplot-0.6.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: better-rtplot
-Version: 0.6.0
+Version: 0.6.1
 Summary: 
 License: MIT
 License-File: LICENSE
@@ -159,3 +159,5 @@ A rising line now draws itself in the browser tab.
 Issues and feature requests:
 [github.com/jmontp/rtplot/issues](https://github.com/jmontp/rtplot/issues).
 
+Dropdown controls: [API and examples](docs/dropdowns.md).
+

{better_rtplot-0.6.0 → better_rtplot-0.6.1}/README.md

@@ -133,3 +133,5 @@ A rising line now draws itself in the browser tab.
 
 Issues and feature requests:
 [github.com/jmontp/rtplot/issues](https://github.com/jmontp/rtplot/issues).
+
+Dropdown controls: [API and examples](docs/dropdowns.md).

{better_rtplot-0.6.0 → better_rtplot-0.6.1}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "better-rtplot"
-version = "0.6.0"
+version = "0.6.1"
 description = ""
 authors = ["jmontp <jmontp@umich.edu>"]
 license = "MIT"

{better_rtplot-0.6.0 → better_rtplot-0.6.1}/rtplot/client.py

@@ -310,10 +310,24 @@ class TextInput:
         })
 
 
+@dataclass
+class Dropdown:
+    """Single choice control. Omitted value selects the first option."""
+    id: str
+    label: str
+    options: List[Union[str, dict]]
+    value: Optional[str] = None
+    height: Optional[float] = None
+
+    def to_dict(self):
+        return _drop_none({"type": "dropdown", "id": self.id, "label": self.label,
+                           "options": self.options, "value": self.value, "height": self.height})
+
+
 @dataclass
 class ControlsRow:
     """A row of control widgets, rendered in place of a plot."""
-    controls: List[Union[Button, Slider, Dial, Display, Text, TextInput, dict]] = field(default_factory=list)
+    controls: List[Union[Button, Slider, Dial, Display, Text, TextInput, Dropdown, dict]] = field(default_factory=list)
 
     section: Optional[str] = None
     title: Optional[str] = None
@@ -610,6 +624,10 @@ def initialize_plots(plot_descriptions=1, handshake_timeout=2.0, *, view=None, u
                       "confirm support: layout may be flat and disabled states are NOT enforced.",
                       RuntimeWarning, stacklevel=2)
 
+    if any(c["type"] == "dropdown" for c in _control_registry.values()) and "dropdown_v1" not in _server_capabilities:
+        warnings.warn("Dropdowns require rtplot browser server >= 0.6.1. This server did not "
+                      "confirm support; dropdown controls may be missing or unenforced.",
+                      RuntimeWarning, stacklevel=2)
     if presentation_requested(plot_desc_dict, _view) and "presentation_v1" not in _server_capabilities:
         warnings.warn("Presentation options require rtplot browser server >= 0.6.0. This server did not "
                       "confirm support; essential placement, groups, and styling may be ignored.",
@@ -767,12 +785,23 @@ def set_text_input(input_id: str, value):
     socket.send_json({"id": str(input_id), "value": str(value)})
 
 
+def set_dropdown(control_id: str, value: str):
+    """Select a declared option without rebuilding the layout (server >= 0.6.1)."""
+    control = _control_registry.get(control_id, {})
+    if control.get("type") != "dropdown" or value not in control["options"]:
+        raise ValueError("set_dropdown requires a dropdown ID and a declared string value")
+    if "dropdown_v1" not in _server_capabilities:
+        raise RuntimeError("set_dropdown requires rtplot browser server >= 0.6.1")
+    socket.send_string(SENDING_TEXT_INPUT, zmq.SNDMORE)
+    socket.send_json({"id": control_id, "value": value, "session": _session, "generation": _generation})
+
+
 def poll_controls():
     """Drain the return channel non-blocking and return current control state.
 
     Returns a ControlState(values, buttons) where:
       - values: dict of latest control values keyed by id. Sliders/dials
-        remain floats; text_input controls remain strings.
+        remain floats; text_input and dropdown controls remain strings.
       - buttons: list of button ids that fired since the previous poll
         (cleared after this call).
 

{better_rtplot-0.6.0 → better_rtplot-0.6.1}/rtplot/server_browser.py

@@ -676,8 +676,9 @@ def parse_config(tab: Tab, json_config):
         for element in row:
             if element.get("type") in ("slider", "dial") and "value" in element:
                 slider_values[element["id"]] = float(element["value"])
-            elif element.get("type") == "text_input":
-                text_values[element["id"]] = str(element.get("value", ""))
+            elif element.get("type") in ("text_input", "dropdown"):
+                default = registry[element["id"]]["options"][0] if element["type"] == "dropdown" else ""
+                text_values[element["id"]] = str(element.get("value", default))
 
     for plot_counter, (_, plot_description) in enumerate(plot_entries):
         trace_names = plot_description["names"]
@@ -717,10 +718,11 @@ def parse_config(tab: Tab, json_config):
         el["id"]
         for row in control_rows
         for el in row
-        if el.get("type") == "text_input"
+        if el.get("type") in ("text_input", "dropdown")
     }
     tab.text_values = {
-        text_id: tab.text_values.get(text_id, default_value)
+        text_id: (default_value if registry[text_id]["type"] == "dropdown"
+                  else tab.text_values.get(text_id, default_value))
         for text_id, default_value in text_values.items()
         if text_id in active_text_ids
     }
@@ -1264,6 +1266,12 @@ async def zmq_receiver(tab: Tab):
             if text_id is None:
                 continue
             value = str(payload.get("value", ""))
+            control = tab.control_registry.get(text_id, {})
+            if control.get("type") == "dropdown":
+                if (payload.get("session"), payload.get("generation")) != (tab.session, tab.generation):
+                    continue
+                if payload.get("value") not in control["options"]:
+                    continue
             if tab.text_values.get(text_id) != value:
                 tab.text_values[text_id] = value
                 tab.text_dirty.add(text_id)
@@ -1701,8 +1709,13 @@ async def handle_ws(request):
                     text_id = payload.get("id")
                     tid = ws_tab.get(ws, BIND_ME_ID)
                     t = tabs.get(tid)
-                    if text_id and t is not None and control_allowed(t, payload, {"text_input"}):
+                    if text_id and t is not None and control_allowed(t, payload, {"text_input", "dropdown"}):
                         value = str(payload.get("value", ""))
+                        control = t.control_registry.get(text_id, {})
+                        if control.get("type") == "dropdown":
+                            if payload.get("value") not in control["options"]:
+                                continue
+                            t.text_dirty.add(text_id)
                         t.text_values[text_id] = value
                         refresh_config_message(t)
                         await send_control_event(

{better_rtplot-0.6.0 → better_rtplot-0.6.1}/rtplot/static/index.html

@@ -742,6 +742,28 @@
           item.appendChild(val);
           controlElements.displays[el.id] = val;
           controlElements.displayKinds[el.id] = 'text';
+        } else if (el.type === 'dropdown') {
+          item.classList.add('ctrl-dropdown', 'flex');
+          const label = document.createElement('label');
+          label.textContent = el.label || el.id;
+          const select = document.createElement('select');
+          select.className = 'ctrl-textinput ctrl-select';
+          for (const choice of el.options) {
+            const option = document.createElement('option');
+            option.value = typeof choice === 'string' ? choice : choice.value;
+            option.textContent = typeof choice === 'string' ? choice : (choice.label ?? choice.value);
+            select.appendChild(option);
+          }
+          select.value = el.value ?? select.options[0].value;
+          let committed = select.value;
+          select.addEventListener('change', () => {
+            if (sendCtrl({type: 'control_text', id: el.id, value: select.value})) committed = select.value;
+            else select.value = committed;
+          });
+          select.setServerValue = value => { select.value = value; committed = value; };
+          label.appendChild(select);
+          item.appendChild(label);
+          controlElements.textInputs[el.id] = select;
         } else if (el.type === 'text_input') {
           item.classList.add('ctrl-text-input', 'flex');
           if (el.label) {
@@ -809,7 +831,7 @@
           applyElementSize(item, el);
           item.dataset.appearance = el.appearance || 'default';
           if (el.appearance === 'state') item.setAttribute('role', 'status');
-          item.querySelectorAll('input,svg.ctrl-dial').forEach(input => input.setAttribute('aria-label', el.label || el.id));
+          item.querySelectorAll('input,select,svg.ctrl-dial').forEach(input => input.setAttribute('aria-label', el.label || el.id));
           div.appendChild(item);
           viewManager.register(el.id, item, section);
         });
@@ -828,7 +850,8 @@
         if (!values) return;
         for (const [id, val] of Object.entries(values)) {
           const input = controlElements.textInputs[id];
-          if (input) input.value = (val !== undefined && val !== null) ? String(val) : '';
+          if (input?.setServerValue) input.setServerValue(String(val));
+          else if (input) input.value = (val !== undefined && val !== null) ? String(val) : '';
         }
       }
 

{better_rtplot-0.6.0 → better_rtplot-0.6.1}/rtplot/static/presentation.css

@@ -166,3 +166,8 @@ body { height: auto; min-height: 100%; }
 .ctrl-textinput, .ctrl-numinput, .ctrl-nudgebtn { border-color: #738799; }
 
 @media (max-height: 480px) and (min-width: 640px) { .ui-source-status { padding-block: 2px; font-size: 12px; line-height: 1.2; } }
+
+/* Native choices retain platform keyboard and touch behavior. */
+.ctrl-dropdown { min-width: 0; flex: 1 1 180px; }
+.ctrl-dropdown > label { display: flex; flex-direction: column; gap: 6px; width: 100%; min-width: 0; }
+.ctrl-select { flex: none; min-height: 44px; padding: 8px 12px; font: inherit; font-size: 16px; color: #18334b; background: #fff; border: 1px solid #738799; }

{better_rtplot-0.6.0 → better_rtplot-0.6.1}/rtplot/ui_state.py

@@ -2,12 +2,35 @@
 from copy import deepcopy
 
 META_KEY = "__rtplot_view__"
-CAPABILITIES = ["sections", "ui_state_v1", "presentation_v1"]
+CAPABILITIES = ["sections", "ui_state_v1", "presentation_v1", "dropdown_v1"]
 CONTROL_DEFAULTS = {"enabled": True, "visible": True, "busy": False, "selected": False, "reason": ""}
 SECTION_DEFAULTS = {"visible": True, "status": "idle", "message": ""}
 STATUSES = {"idle", "ready", "busy", "complete", "warning", "error"}
 
 
+def dropdown_options(control):
+    """Return validated (value, label) choices; values are always strings."""
+    options = control.get("options")
+    if not isinstance(options, list) or not options:
+        raise ValueError("Dropdown options must be a non-empty list")
+    choices = []
+    for option in options:
+        if isinstance(option, str):
+            value, label = option, option
+        elif isinstance(option, dict):
+            value, label = option.get("value"), option.get("label", option.get("value"))
+        else:
+            raise ValueError("Dropdown options must be strings or value/label dictionaries")
+        if not isinstance(value, str) or not isinstance(label, str):
+            raise ValueError("Dropdown option values and labels must be strings")
+        if value in [v for v, _ in choices]:
+            raise ValueError("Dropdown option values must be unique")
+        choices.append((value, label))
+    if control.get("value", choices[0][0]) not in [v for v, _ in choices]:
+        raise ValueError("Dropdown value must match an option")
+    return choices
+
+
 def declarations(config, view=None):
     """Validate optional view and return normalized view plus control registry."""
     if hasattr(view, "to_dict"):
@@ -78,6 +101,8 @@ def declarations(config, view=None):
             if row.get("exclusive") and control.get("type") != "button":
                 raise ValueError("Exclusive groups may contain only buttons")
             controls[cid] = {"type": control.get("type"), "section": sid}
+            if control.get("type") == "dropdown":
+                controls[cid]["options"] = [value for value, _ in dropdown_options(control)]
             if row.get("exclusive"):
                 controls[cid]["exclusive_group"] = key
     essentials = view.get("essential_controls", [])