Added a logbox_clear function (#4)

* Added logbox_clear function * add logbox_clear() to doc --------- Co-authored-by: WangWeimin <[email protected]>
pywebio · Apr 20, 2024 · 14c1318 · 14c1318
1 parent e9a97f3
commit 14c1318
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 3 deletions.
diff --git a/pywebio_battery/__init__.py b/pywebio_battery/__init__.py
@@ -35,7 +35,7 @@
    * - `run_shell <pywebio_battery.run_shell>`
      - Run command in shell
 
-   * - `put_logbox <pywebio_battery.put_logbox>`, `logbox_append <pywebio_battery.logbox_append>`
+   * - `put_logbox <pywebio_battery.put_logbox>`, `logbox_append <pywebio_battery.logbox_append>`, `logbox_clear <pywebio_battery.logbox_clear>`
      - Logbox widget
 
    * - `put_video <pywebio_battery.put_video>`

diff --git a/pywebio_battery/interaction.py b/pywebio_battery/interaction.py
@@ -12,8 +12,8 @@
 from pywebio.session import *
 from pywebio.utils import random_str
 
-__all__ = ['confirm', 'popup_input', 'redirect_stdout', 'run_shell', 'put_logbox', 'logbox_append', 'put_video',
-           'put_audio', 'wait_scroll_to_bottom']
+__all__ = ['confirm', 'popup_input', 'redirect_stdout', 'run_shell', 'put_logbox', 'logbox_append', 'logbox_clear', 
+           'put_video', 'put_audio', 'wait_scroll_to_bottom']
 
 
 def confirm(
@@ -240,6 +240,11 @@ def logbox_append(name: str, text: str):
     run_js('$("#webio-logbox-%s").append(document.createTextNode(text))' % name, text=str(text))
 
 
+def logbox_clear(name: str):
+    """Clear all contents of a logbox widget"""
+    pywebio.session.run_js('$("#webio-logbox-%s").empty()' % name)
+
+
 def put_video(src: Union[str, bytes], autoplay: bool = False, loop: bool = False,
               height: int = None, width: int = None, muted: bool = False, poster: str = None,
               scope: str = None, position: int = OutputPosition.BOTTOM) -> Output: