Update v 0.0.5

README.md

@@ -6,7 +6,7 @@ tags:
 - textbox
 - editing
 - color
-title: gradio_highlightedtextbox V0.0.4
+title: gradio_highlightedtextbox v0.0.5
 colorFrom: indigo
 colorTo: green
 sdk: docker

src/README.md

@@ -1,10 +1,455 @@
 
-# gradio_highlightedtextbox
-A Custom Gradio component.
+# `gradio_highlightedtextbox`
+<a href="https://pypi.org/project/gradio_highlightedtextbox/" target="_blank"><img alt="PyPI - Version" src="https://img.shields.io/pypi/v/gradio_highlightedtextbox"></a>  <a href="https://huggingface.co/spaces/gsarti/gradio_highlightedtextbox/discussions" target="_blank"><img alt="Static Badge" src="https://img.shields.io/badge/%F0%9F%A4%97%20Discuss-%23097EFF?style=flat&logoColor=black"></a>
 
-## Example usage
+Editable Gradio textarea supporting highlighting
+
+## Installation
+    
+```bash 
+pip install gradio_highlightedtextbox
+```
+
+## Usage
 
 ```python
 import gradio as gr
 from gradio_highlightedtextbox import HighlightedTextbox
+
+
+def convert_tagged_text_to_highlighted_text(
+    tagged_text: str, tag_id: str, tag_open: str, tag_close: str
+) -> list[tuple[str, str | None]]:
+    return HighlightedTextbox.tagged_text_to_tuples(
+        tagged_text, tag_id, tag_open, tag_close
+    )
+
+
+def convert_highlighted_text_to_tagged_text(
+    highlighted_text: dict[str, str | list[tuple[str, str | None]]],
+    tag_id: str,
+    tag_open: str,
+    tag_close: str,
+) -> str:
+    return HighlightedTextbox.tuples_to_tagged_text(
+        highlighted_text["data"], tag_id, tag_open, tag_close
+    )
+
+
+initial_text = "It is not something to be ashamed of: it is no different from the <h>personal fears</h> and <h>dislikes</h> of other things that <h>very many people</h> have."
+
+with gr.Blocks() as demo:
+    tag_id = gr.Textbox(
+        "Potential issue",
+        label="Tag ID",
+        show_label=True,
+        info="Insert a tag ID to use in the highlighted textbox.",
+    )
+    tag_open = gr.Textbox(
+        "<h>",
+        label="Tag open",
+        show_label=True,
+        info="Insert a tag to mark the beginning of a highlighted section.",
+    )
+    tag_close = gr.Textbox(
+        "</h>",
+        label="Tag close",
+        show_label=True,
+        info="Insert a tag to mark the end of a highlighted section.",
+    )
+    with gr.Row():
+        tagged_t2h = gr.Textbox(
+            initial_text,
+            interactive=True,
+            label="Input",
+            show_label=True,
+            info="Insert a text with <h>...</h> tags to mark spans that will be highlighted.",
+        )
+        high_t2h = HighlightedTextbox(
+            convert_tagged_text_to_highlighted_text(
+                tagged_t2h.value, tag_id.value, tag_open.value, tag_close.value
+            ),
+            interactive=True,
+            label="Output",
+            info="Highlighted textbox.",
+            show_legend=True,
+            show_label=True,
+            legend_label="Legend:",
+            show_legend_label=True,
+        )
+    with gr.Row():
+        high_h2t = HighlightedTextbox(
+            convert_tagged_text_to_highlighted_text(
+                tagged_t2h.value, tag_id.value, tag_open.value, tag_close.value
+            ),
+            interactive=True,
+            label="Input",
+            info="The following text will be marked by spans according to its highlights.",
+            show_legend=True,
+            show_label=True,
+            legend_label="Legend:",
+            show_legend_label=True,
+        )
+        tagged_h2t = gr.Textbox(
+            initial_text,
+            interactive=True,
+            label="Output",
+            show_label=True,
+        )
+
+    # Functions
+
+    tagged_t2h.change(
+        fn=convert_tagged_text_to_highlighted_text,
+        inputs=[tagged_t2h, tag_id, tag_open, tag_close],
+        outputs=high_t2h,
+    )
+    high_t2h.change(
+        fn=lambda x: x["data"],
+        inputs=high_t2h,
+        outputs=high_h2t,
+    )
+    high_h2t.change(
+        fn=convert_highlighted_text_to_tagged_text,
+        inputs=[high_h2t, tag_id, tag_open, tag_close],
+        outputs=tagged_h2t,
+    )
+
+
+demo.launch()
+
+```
+
+## `HighlightedTextbox`
+
+### Initialization
+
+<table>
+<thead>
+<tr>
+<th align="left">name</th>
+<th align="left" style="width: 25%;">type</th>
+<th align="left">default</th>
+<th align="left">description</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td align="left"><code>value</code></td>
+<td align="left" style="width: 25%;">
+
+```python
+str | Callable | None
+```
+
+</td>
+<td align="left"><code>""</code></td>
+<td align="left">default text to provide in textbox. If callable, the function will be called whenever the app loads to set the initial value of the component.</td>
+</tr>
+
+<tr>
+<td align="left"><code>color_map</code></td>
+<td align="left" style="width: 25%;">
+
+```python
+dict[str, str] | None
+```
+
+</td>
+<td align="left"><code>None</code></td>
+<td align="left">dictionary mapping labels to colors.</td>
+</tr>
+
+<tr>
+<td align="left"><code>show_legend</code></td>
+<td align="left" style="width: 25%;">
+
+```python
+bool
+```
+
+</td>
+<td align="left"><code>False</code></td>
+<td align="left">if True, will display legend.</td>
+</tr>
+
+<tr>
+<td align="left"><code>show_legend_label</code></td>
+<td align="left" style="width: 25%;">
+
+```python
+bool
+```
+
+</td>
+<td align="left"><code>False</code></td>
+<td align="left">if True, will display legend label.</td>
+</tr>
+
+<tr>
+<td align="left"><code>legend_label</code></td>
+<td align="left" style="width: 25%;">
+
+```python
+str
+```
+
+</td>
+<td align="left"><code>""</code></td>
+<td align="left">label to display above legend.</td>
+</tr>
+
+<tr>
+<td align="left"><code>combine_adjacent</code></td>
+<td align="left" style="width: 25%;">
+
+```python
+bool
+```
+
+</td>
+<td align="left"><code>False</code></td>
+<td align="left">if True, will combine adjacent spans with the same label.</td>
+</tr>
+
+<tr>
+<td align="left"><code>adjacent_separator</code></td>
+<td align="left" style="width: 25%;">
+
+```python
+str
+```
+
+</td>
+<td align="left"><code>""</code></td>
+<td align="left">separator to use when combining adjacent spans.</td>
+</tr>
+
+<tr>
+<td align="left"><code>label</code></td>
+<td align="left" style="width: 25%;">
+
+```python
+str | None
+```
+
+</td>
+<td align="left"><code>None</code></td>
+<td align="left">component name in interface.</td>
+</tr>
+
+<tr>
+<td align="left"><code>info</code></td>
+<td align="left" style="width: 25%;">
+
+```python
+str | None
+```
+
+</td>
+<td align="left"><code>None</code></td>
+<td align="left">None</td>
+</tr>
+
+<tr>
+<td align="left"><code>every</code></td>
+<td align="left" style="width: 25%;">
+
+```python
+float | None
+```
+
+</td>
+<td align="left"><code>None</code></td>
+<td align="left">If `value` is a callable, run the function 'every' number of seconds while the client connection is open. Has no effect otherwise. Queue must be enabled. The event can be accessed (e.g. to cancel it) via this component's .load_event attribute.</td>
+</tr>
+
+<tr>
+<td align="left"><code>show_label</code></td>
+<td align="left" style="width: 25%;">
+
+```python
+bool | None
+```
+
+</td>
+<td align="left"><code>None</code></td>
+<td align="left">if True, will display label.</td>
+</tr>
+
+<tr>
+<td align="left"><code>container</code></td>
+<td align="left" style="width: 25%;">
+
+```python
+bool
+```
+
+</td>
+<td align="left"><code>True</code></td>
+<td align="left">If True, will place the component in a container - providing some extra padding around the border.</td>
+</tr>
+
+<tr>
+<td align="left"><code>scale</code></td>
+<td align="left" style="width: 25%;">
+
+```python
+int | None
 ```
+
+</td>
+<td align="left"><code>None</code></td>
+<td align="left">relative width compared to adjacent Components in a Row. For example, if Component A has scale=2, and Component B has scale=1, A will be twice as wide as B. Should be an integer.</td>
+</tr>
+
+<tr>
+<td align="left"><code>min_width</code></td>
+<td align="left" style="width: 25%;">
+
+```python
+int
+```
+
+</td>
+<td align="left"><code>160</code></td>
+<td align="left">minimum pixel width, will wrap if not sufficient screen space to satisfy this value. If a certain scale value results in this Component being narrower than min_width, the min_width parameter will be respected first.</td>
+</tr>
+
+<tr>
+<td align="left"><code>visible</code></td>
+<td align="left" style="width: 25%;">
+
+```python
+bool
+```
+
+</td>
+<td align="left"><code>True</code></td>
+<td align="left">If False, component will be hidden.</td>
+</tr>
+
+<tr>
+<td align="left"><code>elem_id</code></td>
+<td align="left" style="width: 25%;">
+
+```python
+str | None
+```
+
+</td>
+<td align="left"><code>None</code></td>
+<td align="left">An optional string that is assigned as the id of this component in the HTML DOM. Can be used for targeting CSS styles.</td>
+</tr>
+
+<tr>
+<td align="left"><code>autofocus</code></td>
+<td align="left" style="width: 25%;">
+
+```python
+bool
+```
+
+</td>
+<td align="left"><code>False</code></td>
+<td align="left">None</td>
+</tr>
+
+<tr>
+<td align="left"><code>autoscroll</code></td>
+<td align="left" style="width: 25%;">
+
+```python
+bool
+```
+
+</td>
+<td align="left"><code>True</code></td>
+<td align="left">If True, will automatically scroll to the bottom of the textbox when the value changes, unless the user scrolls up. If False, will not scroll to the bottom of the textbox when the value changes.</td>
+</tr>
+
+<tr>
+<td align="left"><code>interactive</code></td>
+<td align="left" style="width: 25%;">
+
+```python
+bool
+```
+
+</td>
+<td align="left"><code>True</code></td>
+<td align="left">if True, will be rendered as an editable textbox; if False, editing will be disabled. If not provided, this is inferred based on whether the component is used as an input or output.</td>
+</tr>
+
+<tr>
+<td align="left"><code>elem_classes</code></td>
+<td align="left" style="width: 25%;">
+
+```python
+list[str] | str | None
+```
+
+</td>
+<td align="left"><code>None</code></td>
+<td align="left">An optional list of strings that are assigned as the classes of this component in the HTML DOM. Can be used for targeting CSS styles.</td>
+</tr>
+
+<tr>
+<td align="left"><code>render</code></td>
+<td align="left" style="width: 25%;">
+
+```python
+bool
+```
+
+</td>
+<td align="left"><code>True</code></td>
+<td align="left">If False, component will not render be rendered in the Blocks context. Should be used if the intention is to assign event listeners now but render the component later.</td>
+</tr>
+
+<tr>
+<td align="left"><code>show_copy_button</code></td>
+<td align="left" style="width: 25%;">
+
+```python
+bool
+```
+
+</td>
+<td align="left"><code>False</code></td>
+<td align="left">If True, includes a copy button to copy the text in the textbox. Only applies if show_label is True.</td>
+</tr>
+</tbody></table>
+
+
+### Events
+
+| name | description |
+|:-----|:------------|
+| `change` | Triggered when the value of the HighlightedTextbox changes either because of user input (e.g. a user types in a textbox) OR because of a function update (e.g. an image receives a value from the output of an event trigger). See `.input()` for a listener that is only triggered by user input. |
+| `input` | This listener is triggered when the user changes the value of the HighlightedTextbox. |
+| `select` | Event listener for when the user selects or deselects the HighlightedTextbox. Uses event data gradio.SelectData to carry `value` referring to the label of the HighlightedTextbox, and `selected` to refer to state of the HighlightedTextbox. See EventData documentation on how to use this event data |
+| `submit` | This listener is triggered when the user presses the Enter key while the HighlightedTextbox is focused. |
+| `focus` | This listener is triggered when the HighlightedTextbox is focused. |
+| `blur` | This listener is triggered when the HighlightedTextbox is unfocused/blurred. |
+
+
+
+### User function
+
+The impact on the users predict function varies depending on whether the component is used as an input or output for an event (or both).
+
+- When used as an Input, the component only impacts the input signature of the user function. 
+- When used as an output, the component only impacts the return signature of the user function. 
+
+The code snippet below is accurate in cases where the component is used as both an input and an output.
+
+- **As input:** Should return, list of (word, category) tuples, or a dictionary of two keys: "text", and "highlights", which itself is.
+
+ ```python
+ def predict(
+     value: dict
+ ) -> list[tuple[str, str | None]] | dict | None:
+     return value
+ ```
+ 

src/backend/gradio_highlightedtextbox/highlightedtextbox.py

@@ -264,8 +264,13 @@ class HighlightedTextbox(FormComponent):
             tag_ids = [tag_ids]
         out = ""
         for text, tag_id in tuples:
+            space_or_not = (
+                " "
+                if text not in [".", "!", "?", ",", ":", ")", "]", ";", "}", """'"""]
+                else ""
+            )
             if tag_id in tag_ids:
-                out += f" {tag_open}{text.strip()}{tag_close} "
+                out += f"{space_or_not}{tag_open}{text.strip()}{tag_close}"
             else:
-                out += text.strip()
+                out += f"{space_or_not}{text.strip()} "
         return out.strip()

src/backend/gradio_highlightedtextbox/highlightedtextbox.pyi

@@ -260,10 +260,15 @@ class HighlightedTextbox(FormComponent):
             tag_ids = [tag_ids]
         out = ""
         for text, tag_id in tuples:
+            space_or_not = (
+                " "
+                if text not in [".", "!", "?", ",", ":", ")", "]", ";", "}", """'"""]
+                else ""
+            )
             if tag_id in tag_ids:
-                out += f" {tag_open}{text.strip()}{tag_close} "
+                out += f"{space_or_not}{tag_open}{text.strip()}{tag_close}"
             else:
-                out += text.strip()
+                out += f"{space_or_not}{text.strip()} "
         return out.strip()
 
     

src/backend/gradio_highlightedtextbox/templates/component/index.js

@@ -11,7 +11,7 @@ const {
   insert: ul,
   safe_not_equal: cl,
   set_dynamic_element_data: et,
-  set_style: A,
+  set_style: z,
   toggle_class: te,
   transition_in: Ot,
   transition_out: It,
@@ -70,7 +70,7 @@ function ml(n) {
         n[5] === "focus"
       ), te(e, "hide-container", !/*explicit_call*/
       n[8] && !/*container*/
-      n[9]), A(
+      n[9]), z(
         e,
         "height",
         /*get_dimension*/
@@ -78,7 +78,7 @@ function ml(n) {
           /*height*/
           n[0]
         )
-      ), A(e, "width", typeof /*width*/
+      ), z(e, "width", typeof /*width*/
       n[1] == "number" ? `calc(min(${/*width*/
       n[1]}px, 100%))` : (
         /*get_dimension*/
@@ -86,23 +86,23 @@ function ml(n) {
           /*width*/
           n[1]
         )
-      )), A(
+      )), z(
         e,
         "border-style",
         /*variant*/
         n[4]
-      ), A(
+      ), z(
         e,
         "overflow",
         /*allow_overflow*/
         n[11] ? "visible" : "hidden"
-      ), A(
+      ), z(
         e,
         "flex-grow",
         /*scale*/
         n[12]
-      ), A(e, "min-width", `calc(min(${/*min_width*/
-      n[13]}px, 100%))`), A(e, "border-width", "var(--block-border-width)");
+      ), z(e, "min-width", `calc(min(${/*min_width*/
+      n[13]}px, 100%))`), z(e, "border-width", "var(--block-border-width)");
     },
     m(f, a) {
       ul(f, e, a), o && o.m(e, null), l = !0;
@@ -161,7 +161,7 @@ function ml(n) {
       ), te(e, "hide-container", !/*explicit_call*/
       f[8] && !/*container*/
       f[9]), a & /*height*/
-      1 && A(
+      1 && z(
         e,
         "height",
         /*get_dimension*/
@@ -170,7 +170,7 @@ function ml(n) {
           f[0]
         )
       ), a & /*width*/
-      2 && A(e, "width", typeof /*width*/
+      2 && z(e, "width", typeof /*width*/
       f[1] == "number" ? `calc(min(${/*width*/
       f[1]}px, 100%))` : (
         /*get_dimension*/
@@ -179,25 +179,25 @@ function ml(n) {
           f[1]
         )
       )), a & /*variant*/
-      16 && A(
+      16 && z(
         e,
         "border-style",
         /*variant*/
         f[4]
       ), a & /*allow_overflow*/
-      2048 && A(
+      2048 && z(
         e,
         "overflow",
         /*allow_overflow*/
         f[11] ? "visible" : "hidden"
       ), a & /*scale*/
-      4096 && A(
+      4096 && z(
         e,
         "flex-grow",
         /*scale*/
         f[12]
       ), a & /*min_width*/
-      8192 && A(e, "min-width", `calc(min(${/*min_width*/
+      8192 && z(e, "min-width", `calc(min(${/*min_width*/
       f[13]}px, 100%))`);
     },
     i(f) {
@@ -240,16 +240,16 @@ function bl(n) {
 }
 function gl(n, e, t) {
   let { $$slots: l = {}, $$scope: i } = e, { height: o = void 0 } = e, { width: s = void 0 } = e, { elem_id: r = "" } = e, { elem_classes: f = [] } = e, { variant: a = "solid" } = e, { border_mode: _ = "base" } = e, { padding: u = !0 } = e, { type: c = "normal" } = e, { test_id: m = void 0 } = e, { explicit_call: p = !1 } = e, { container: T = !0 } = e, { visible: S = !0 } = e, { allow_overflow: L = !0 } = e, { scale: C = null } = e, { min_width: d = 0 } = e, y = c === "fieldset" ? "fieldset" : "div";
-  const M = (g) => {
-    if (g !== void 0) {
-      if (typeof g == "number")
-        return g + "px";
-      if (typeof g == "string")
-        return g;
+  const M = (b) => {
+    if (b !== void 0) {
+      if (typeof b == "number")
+        return b + "px";
+      if (typeof b == "string")
+        return b;
     }
   };
-  return n.$$set = (g) => {
-    "height" in g && t(0, o = g.height), "width" in g && t(1, s = g.width), "elem_id" in g && t(2, r = g.elem_id), "elem_classes" in g && t(3, f = g.elem_classes), "variant" in g && t(4, a = g.variant), "border_mode" in g && t(5, _ = g.border_mode), "padding" in g && t(6, u = g.padding), "type" in g && t(16, c = g.type), "test_id" in g && t(7, m = g.test_id), "explicit_call" in g && t(8, p = g.explicit_call), "container" in g && t(9, T = g.container), "visible" in g && t(10, S = g.visible), "allow_overflow" in g && t(11, L = g.allow_overflow), "scale" in g && t(12, C = g.scale), "min_width" in g && t(13, d = g.min_width), "$$scope" in g && t(17, i = g.$$scope);
+  return n.$$set = (b) => {
+    "height" in b && t(0, o = b.height), "width" in b && t(1, s = b.width), "elem_id" in b && t(2, r = b.elem_id), "elem_classes" in b && t(3, f = b.elem_classes), "variant" in b && t(4, a = b.variant), "border_mode" in b && t(5, _ = b.border_mode), "padding" in b && t(6, u = b.padding), "type" in b && t(16, c = b.type), "test_id" in b && t(7, m = b.test_id), "explicit_call" in b && t(8, p = b.explicit_call), "container" in b && t(9, T = b.container), "visible" in b && t(10, S = b.visible), "allow_overflow" in b && t(11, L = b.allow_overflow), "scale" in b && t(12, C = b.scale), "min_width" in b && t(13, d = b.min_width), "$$scope" in b && t(17, i = b.$$scope);
   }, [
     o,
     s,
@@ -1118,7 +1118,7 @@ const {
   toggle_class: mt,
   transition_in: ne,
   transition_out: ce
-} = window.__gradio__svelte__internal, { beforeUpdate: zn, afterUpdate: En, createEventDispatcher: Pn, tick: Ui } = window.__gradio__svelte__internal;
+} = window.__gradio__svelte__internal, { beforeUpdate: zn, afterUpdate: En, createEventDispatcher: Pn } = window.__gradio__svelte__internal;
 function bt(n, e, t) {
   const l = n.slice();
   return l[39] = e[t][0], l[40] = e[t][1], l[42] = t, l;
@@ -1530,35 +1530,35 @@ function Un(n) {
 }
 function Wn(n, e, t) {
   const l = typeof document < "u";
-  let { value: i = [] } = e, { value_is_output: o = !1 } = e, { label: s } = e, { legend_label: r } = e, { info: f = void 0 } = e, { show_label: a = !0 } = e, { show_legend: _ = !1 } = e, { show_legend_label: u = !1 } = e, { container: c = !0 } = e, { color_map: m = {} } = e, { show_copy_button: p = !1 } = e, { disabled: T } = e, S, L = "", C = "", d, y = {}, M = {}, g = !1, B;
+  let { value: i = [] } = e, { value_is_output: o = !1 } = e, { label: s } = e, { legend_label: r } = e, { info: f = void 0 } = e, { show_label: a = !0 } = e, { show_legend: _ = !1 } = e, { show_legend_label: u = !1 } = e, { container: c = !0 } = e, { color_map: m = {} } = e, { show_copy_button: p = !1 } = e, { disabled: T } = e, S, L = "", C = "", d, y = {}, M = {}, b = !1, B;
   function Q() {
     if (!m || Object.keys(m).length === 0 ? y = {} : y = m, i.length > 0) {
-      for (let [b, j] of i)
+      for (let [g, j] of i)
         if (j !== null && !(j in y)) {
-          let E = wn(Object.keys(y).length);
-          y[j] = E;
+          let V = wn(Object.keys(y).length);
+          y[j] = V;
         }
     }
     t(12, M = qn(y, l, d));
   }
-  function z() {
-    i.length > 0 && o && (t(11, L = i.map(([b, j]) => b).join(" ")), t(9, C = i.map(([b, j]) => j !== null ? `<mark class="hl ${j}" style="background-color:${M[j].secondary}">${b}</mark>` : b).join(" ") + " "));
+  function E(g) {
+    i.length > 0 && g && (t(11, L = i.map(([j, V]) => j).join(" ")), t(9, C = i.map(([j, V]) => V !== null ? `<mark class="hl ${V}" style="background-color:${M[V].secondary}">${j}</mark>` : j).join(" ") + " "));
   }
   const R = Pn();
   zn(() => {
     S && S.offsetHeight + S.scrollTop > S.scrollHeight - 100;
   });
   function U() {
-    R("change", C), o || R("input"), V();
+    R("change", C), o || R("input"), A();
   }
   En(() => {
-    Q(), z(), t(18, o = !1);
+    Q(), E(o), t(18, o = !1);
   });
   function se() {
-    let b = [], j = "", E = null, ee = !1, be = "";
+    let g = [], j = "", V = null, ee = !1, be = "";
     for (let fe = 0; fe < C.length; fe++) {
       let re = C[fe];
-      re === "<" ? (ee = !0, j && b.push([j, E]), j = "", E = null) : re === ">" ? (ee = !1, be.startsWith("mark") && (E = Un([
+      re === "<" ? (ee = !0, j && g.push([j, V]), j = "", V = null) : re === ">" ? (ee = !1, be.startsWith("mark") && (V = Un([
         be,
         "access",
         (W) => W.match,
@@ -1568,27 +1568,27 @@ function Wn(n, e, t) {
         (W) => W[1]
       ]) || null), be = "") : ee ? be += re : j += re;
     }
-    j && b.push([j, E]), t(17, i = b);
+    j && g.push([j, V]), t(17, i = g);
   }
   async function D() {
     "clipboard" in navigator && (await navigator.clipboard.writeText(L), x());
   }
   function x() {
-    t(13, g = !0), B && clearTimeout(B), B = setTimeout(
+    t(13, b = !0), B && clearTimeout(B), B = setTimeout(
       () => {
-        t(13, g = !1);
+        t(13, b = !1);
       },
       1e3
     );
   }
-  function V() {
-    const b = window.getSelection(), j = b.anchorOffset;
-    if (b.rangeCount > 0) {
-      var E = b.getRangeAt(0).commonAncestorContainer.parentElement;
-      if (E && E.tagName.toLowerCase() === "mark") {
-        const el = E.textContent;
-        var ee = E.parentElement, be = document.createTextNode(el);
-        ee.replaceChild(be, E), t(9, C = ee.innerHTML);
+  function A() {
+    const g = window.getSelection(), j = g.anchorOffset;
+    if (g.rangeCount > 0) {
+      var V = g.getRangeAt(0).commonAncestorContainer.parentElement;
+      if (V && V.tagName.toLowerCase() === "mark") {
+        const el = V.textContent;
+        var ee = V.parentElement, be = document.createTextNode(el);
+        ee.replaceChild(be, V), t(9, C = ee.innerHTML);
         var fe = document.createRange(), re = window.getSelection();
         const tl = j + Ln(ee);
         var W = Tn(ee, tl);
@@ -1596,43 +1596,43 @@ function Wn(n, e, t) {
       }
     }
   }
-  function de(b) {
-    qe.call(this, n, b);
+  function de(g) {
+    qe.call(this, n, g);
   }
-  function h(b) {
-    qe.call(this, n, b);
+  function h(g) {
+    qe.call(this, n, g);
   }
-  function Fe(b) {
-    qe.call(this, n, b);
+  function Fe(g) {
+    qe.call(this, n, g);
   }
-  function Me(b) {
-    qe.call(this, n, b);
+  function Me(g) {
+    qe.call(this, n, g);
   }
-  function me(b) {
-    qe.call(this, n, b);
+  function me(g) {
+    qe.call(this, n, g);
   }
-  function Pe(b) {
-    ct[b ? "unshift" : "push"](() => {
-      S = b, t(10, S);
+  function Pe(g) {
+    ct[g ? "unshift" : "push"](() => {
+      S = g, t(10, S);
     });
   }
   function Ze() {
     L = this.textContent, C = this.innerHTML, t(11, L), t(9, C);
   }
-  function w(b) {
-    ct[b ? "unshift" : "push"](() => {
-      S = b, t(10, S);
+  function w(g) {
+    ct[g ? "unshift" : "push"](() => {
+      S = g, t(10, S);
     });
   }
   function $t() {
     L = this.textContent, C = this.innerHTML, t(11, L), t(9, C);
   }
-  return n.$$set = (b) => {
-    "value" in b && t(17, i = b.value), "value_is_output" in b && t(18, o = b.value_is_output), "label" in b && t(0, s = b.label), "legend_label" in b && t(1, r = b.legend_label), "info" in b && t(2, f = b.info), "show_label" in b && t(3, a = b.show_label), "show_legend" in b && t(4, _ = b.show_legend), "show_legend_label" in b && t(5, u = b.show_legend_label), "container" in b && t(6, c = b.container), "color_map" in b && t(19, m = b.color_map), "show_copy_button" in b && t(7, p = b.show_copy_button), "disabled" in b && t(8, T = b.disabled);
+  return n.$$set = (g) => {
+    "value" in g && t(17, i = g.value), "value_is_output" in g && t(18, o = g.value_is_output), "label" in g && t(0, s = g.label), "legend_label" in g && t(1, r = g.legend_label), "info" in g && t(2, f = g.info), "show_label" in g && t(3, a = g.show_label), "show_legend" in g && t(4, _ = g.show_legend), "show_legend_label" in g && t(5, u = g.show_legend_label), "container" in g && t(6, c = g.container), "color_map" in g && t(19, m = g.color_map), "show_copy_button" in g && t(7, p = g.show_copy_button), "disabled" in g && t(8, T = g.disabled);
   }, n.$$.update = () => {
     n.$$.dirty[0] & /*marked_el_text*/
     512 && U();
-  }, z(), Q(), [
+  }, Q(), E(!0), [
     s,
     r,
     f,
@@ -1646,10 +1646,10 @@ function Wn(n, e, t) {
     S,
     L,
     M,
-    g,
+    b,
     se,
     D,
-    V,
+    A,
     i,
     o,
     m,
@@ -2610,17 +2610,17 @@ async function Ti(n, e = !0) {
   }
 }
 function Fi(n, e, t) {
-  let l, { $$slots: i = {}, $$scope: o } = e, { i18n: s } = e, { eta: r = null } = e, { queue_position: f } = e, { queue_size: a } = e, { status: _ } = e, { scroll_to_output: u = !1 } = e, { timer: c = !0 } = e, { show_progress: m = "full" } = e, { message: p = null } = e, { progress: T = null } = e, { variant: S = "default" } = e, { loading_text: L = "Loading..." } = e, { absolute: C = !0 } = e, { translucent: d = !1 } = e, { border: y = !1 } = e, { autoscroll: M } = e, g, B = !1, Q = 0, z = 0, R = null, U = null, se = 0, D = null, x, V = null, de = !0;
+  let l, { $$slots: i = {}, $$scope: o } = e, { i18n: s } = e, { eta: r = null } = e, { queue_position: f } = e, { queue_size: a } = e, { status: _ } = e, { scroll_to_output: u = !1 } = e, { timer: c = !0 } = e, { show_progress: m = "full" } = e, { message: p = null } = e, { progress: T = null } = e, { variant: S = "default" } = e, { loading_text: L = "Loading..." } = e, { absolute: C = !0 } = e, { translucent: d = !1 } = e, { border: y = !1 } = e, { autoscroll: M } = e, b, B = !1, Q = 0, E = 0, R = null, U = null, se = 0, D = null, x, A = null, de = !0;
   const h = () => {
-    t(0, r = t(26, R = t(19, me = null))), t(24, Q = performance.now()), t(25, z = 0), B = !0, Fe();
+    t(0, r = t(26, R = t(19, me = null))), t(24, Q = performance.now()), t(25, E = 0), B = !0, Fe();
   };
   function Fe() {
     requestAnimationFrame(() => {
-      t(25, z = (performance.now() - Q) / 1e3), B && Fe();
+      t(25, E = (performance.now() - Q) / 1e3), B && Fe();
     });
   }
   function Me() {
-    t(25, z = 0), t(0, r = t(26, R = t(19, me = null))), B && (B = !1);
+    t(25, E = 0), t(0, r = t(26, R = t(19, me = null))), B && (B = !1);
   }
   mi(() => {
     B && Me();
@@ -2628,12 +2628,12 @@ function Fi(n, e, t) {
   let me = null;
   function Pe(w) {
     Ct[w ? "unshift" : "push"](() => {
-      V = w, t(16, V), t(7, T), t(14, D), t(15, x);
+      A = w, t(16, A), t(7, T), t(14, D), t(15, x);
     });
   }
   function Ze(w) {
     Ct[w ? "unshift" : "push"](() => {
-      g = w, t(13, g);
+      b = w, t(13, b);
     });
   }
   return n.$$set = (w) => {
@@ -2641,18 +2641,18 @@ function Fi(n, e, t) {
   }, n.$$.update = () => {
     n.$$.dirty[0] & /*eta, old_eta, timer_start, eta_from_start*/
     218103809 && (r === null && t(0, r = R), r != null && R !== r && (t(27, U = (performance.now() - Q) / 1e3 + r), t(19, me = U.toFixed(1)), t(26, R = r))), n.$$.dirty[0] & /*eta_from_start, timer_diff*/
-    167772160 && t(17, se = U === null || U <= 0 || !z ? null : Math.min(z / U, 1)), n.$$.dirty[0] & /*progress*/
+    167772160 && t(17, se = U === null || U <= 0 || !E ? null : Math.min(E / U, 1)), n.$$.dirty[0] & /*progress*/
     128 && T != null && t(18, de = !1), n.$$.dirty[0] & /*progress, progress_level, progress_bar, last_progress_level*/
     114816 && (T != null ? t(14, D = T.map((w) => {
       if (w.index != null && w.length != null)
         return w.index / w.length;
       if (w.progress != null)
         return w.progress;
-    })) : t(14, D = null), D ? (t(15, x = D[D.length - 1]), V && (x === 0 ? t(16, V.style.transition = "0", V) : t(16, V.style.transition = "150ms", V))) : t(15, x = void 0)), n.$$.dirty[0] & /*status*/
+    })) : t(14, D = null), D ? (t(15, x = D[D.length - 1]), A && (x === 0 ? t(16, A.style.transition = "0", A) : t(16, A.style.transition = "150ms", A))) : t(15, x = void 0)), n.$$.dirty[0] & /*status*/
     16 && (_ === "pending" ? h() : Me()), n.$$.dirty[0] & /*el, scroll_to_output, status, autoscroll*/
-    10493968 && g && u && (_ === "pending" || _ === "complete") && Ti(g, M), n.$$.dirty[0] & /*status, message*/
+    10493968 && b && u && (_ === "pending" || _ === "complete") && Ti(b, M), n.$$.dirty[0] & /*status, message*/
     4194320, n.$$.dirty[0] & /*timer_diff*/
-    33554432 && t(20, l = z.toFixed(1));
+    33554432 && t(20, l = E.toFixed(1));
   }, [
     r,
     s,
@@ -2667,10 +2667,10 @@ function Fi(n, e, t) {
     C,
     d,
     y,
-    g,
+    b,
     D,
     x,
-    V,
+    A,
     se,
     de,
     me,
@@ -2679,7 +2679,7 @@ function Fi(n, e, t) {
     p,
     M,
     Q,
-    z,
+    E,
     R,
     U,
     o,
@@ -2997,17 +2997,17 @@ function Oi(n) {
   };
 }
 function Ii(n, e, t) {
-  let { gradio: l } = e, { label: i = "Highlighted Textbox" } = e, { legend_label: o = "Highlights:" } = e, { info: s = void 0 } = e, { elem_id: r = "" } = e, { elem_classes: f = [] } = e, { visible: a = !0 } = e, { value: _ } = e, { show_label: u } = e, { show_legend: c } = e, { show_legend_label: m } = e, { color_map: p = {} } = e, { container: T = !0 } = e, { scale: S = null } = e, { min_width: L = void 0 } = e, { show_copy_button: C = !1 } = e, { loading_status: d = void 0 } = e, { value_is_output: y = !1 } = e, { combine_adjacent: M = !1 } = e, { interactive: g = !0 } = e;
+  let { gradio: l } = e, { label: i = "Highlighted Textbox" } = e, { legend_label: o = "Highlights:" } = e, { info: s = void 0 } = e, { elem_id: r = "" } = e, { elem_classes: f = [] } = e, { visible: a = !0 } = e, { value: _ } = e, { show_label: u } = e, { show_legend: c } = e, { show_legend_label: m } = e, { color_map: p = {} } = e, { container: T = !0 } = e, { scale: S = null } = e, { min_width: L = void 0 } = e, { show_copy_button: C = !1 } = e, { loading_status: d = void 0 } = e, { value_is_output: y = !1 } = e, { combine_adjacent: M = !1 } = e, { interactive: b = !0 } = e;
   const B = !1, Q = !0;
-  function z(h) {
+  function E(h) {
     _ = h, t(0, _), t(19, M);
   }
   function R(h) {
     y = h, t(2, y);
   }
-  const U = () => l.dispatch("change"), se = () => l.dispatch("input"), D = () => l.dispatch("submit"), x = () => l.dispatch("blur"), V = (h) => l.dispatch("select", h.detail), de = () => l.dispatch("focus");
+  const U = () => l.dispatch("change"), se = () => l.dispatch("input"), D = () => l.dispatch("submit"), x = () => l.dispatch("blur"), A = (h) => l.dispatch("select", h.detail), de = () => l.dispatch("focus");
   return n.$$set = (h) => {
-    "gradio" in h && t(3, l = h.gradio), "label" in h && t(4, i = h.label), "legend_label" in h && t(5, o = h.legend_label), "info" in h && t(6, s = h.info), "elem_id" in h && t(7, r = h.elem_id), "elem_classes" in h && t(8, f = h.elem_classes), "visible" in h && t(9, a = h.visible), "value" in h && t(0, _ = h.value), "show_label" in h && t(10, u = h.show_label), "show_legend" in h && t(11, c = h.show_legend), "show_legend_label" in h && t(12, m = h.show_legend_label), "color_map" in h && t(1, p = h.color_map), "container" in h && t(13, T = h.container), "scale" in h && t(14, S = h.scale), "min_width" in h && t(15, L = h.min_width), "show_copy_button" in h && t(16, C = h.show_copy_button), "loading_status" in h && t(17, d = h.loading_status), "value_is_output" in h && t(2, y = h.value_is_output), "combine_adjacent" in h && t(19, M = h.combine_adjacent), "interactive" in h && t(18, g = h.interactive);
+    "gradio" in h && t(3, l = h.gradio), "label" in h && t(4, i = h.label), "legend_label" in h && t(5, o = h.legend_label), "info" in h && t(6, s = h.info), "elem_id" in h && t(7, r = h.elem_id), "elem_classes" in h && t(8, f = h.elem_classes), "visible" in h && t(9, a = h.visible), "value" in h && t(0, _ = h.value), "show_label" in h && t(10, u = h.show_label), "show_legend" in h && t(11, c = h.show_legend), "show_legend_label" in h && t(12, m = h.show_legend_label), "color_map" in h && t(1, p = h.color_map), "container" in h && t(13, T = h.container), "scale" in h && t(14, S = h.scale), "min_width" in h && t(15, L = h.min_width), "show_copy_button" in h && t(16, C = h.show_copy_button), "loading_status" in h && t(17, d = h.loading_status), "value_is_output" in h && t(2, y = h.value_is_output), "combine_adjacent" in h && t(19, M = h.combine_adjacent), "interactive" in h && t(18, b = h.interactive);
   }, n.$$.update = () => {
     n.$$.dirty & /*color_map*/
     2 && !p && Object.keys(p).length && t(1, p), n.$$.dirty & /*value, combine_adjacent*/
@@ -3031,21 +3031,21 @@ function Ii(n, e, t) {
     L,
     C,
     d,
-    g,
+    b,
     M,
     B,
     Q,
-    z,
+    E,
     R,
     U,
     se,
     D,
     x,
-    V,
+    A,
     de
   ];
 }
-class Wi extends Ni {
+class Ui extends Ni {
   constructor(e) {
     super(), Pi(this, e, Ii, Oi, Bi, {
       gradio: 3,
@@ -3200,5 +3200,5 @@ class Wi extends Ni {
   }
 }
 export {
-  Wi as default
+  Ui as default
 };

src/demo/app.py

@@ -10,6 +10,19 @@ def convert_tagged_text_to_highlighted_text(
     )
 
 
+def convert_highlighted_text_to_tagged_text(
+    highlighted_text: dict[str, str | list[tuple[str, str | None]]],
+    tag_id: str,
+    tag_open: str,
+    tag_close: str,
+) -> str:
+    return HighlightedTextbox.tuples_to_tagged_text(
+        highlighted_text["data"], tag_id, tag_open, tag_close
+    )
+
+
+initial_text = "It is not something to be ashamed of: it is no different from the <h>personal fears</h> and <h>dislikes</h> of other things that <h>very many people</h> have."
+
 with gr.Blocks() as demo:
     tag_id = gr.Textbox(
         "Potential issue",
@@ -30,14 +43,17 @@ with gr.Blocks() as demo:
         info="Insert a tag to mark the end of a highlighted section.",
     )
     with gr.Row():
-        tagged = gr.Textbox(
-            "It is not something to be ashamed of: it is no different from the <h>personal fears</h> and <h>dislikes</h> of other things that <h>very many people</h> have.",
+        tagged_t2h = gr.Textbox(
+            initial_text,
             interactive=True,
             label="Input",
             show_label=True,
             info="Insert a text with <h>...</h> tags to mark spans that will be highlighted.",
         )
-        high = HighlightedTextbox(
+        high_t2h = HighlightedTextbox(
+            convert_tagged_text_to_highlighted_text(
+                tagged_t2h.value, tag_id.value, tag_open.value, tag_close.value
+            ),
             interactive=True,
             label="Output",
             info="Highlighted textbox.",
@@ -46,20 +62,42 @@ with gr.Blocks() as demo:
             legend_label="Legend:",
             show_legend_label=True,
         )
-    button = gr.Button("Submit")
-    button.click(
+    with gr.Row():
+        high_h2t = HighlightedTextbox(
+            convert_tagged_text_to_highlighted_text(
+                tagged_t2h.value, tag_id.value, tag_open.value, tag_close.value
+            ),
+            interactive=True,
+            label="Input",
+            info="The following text will be marked by spans according to its highlights.",
+            show_legend=True,
+            show_label=True,
+            legend_label="Legend:",
+            show_legend_label=True,
+        )
+        tagged_h2t = gr.Textbox(
+            initial_text,
+            interactive=True,
+            label="Output",
+            show_label=True,
+        )
+
+    # Functions
+
+    tagged_t2h.change(
         fn=convert_tagged_text_to_highlighted_text,
-        inputs=[tagged, tag_id, tag_open, tag_close],
-        outputs=high,
+        inputs=[tagged_t2h, tag_id, tag_open, tag_close],
+        outputs=high_t2h,
     )
-    # Initialization does not work
-    high = HighlightedTextbox(
-        convert_tagged_text_to_highlighted_text(
-            tagged.value, tag_id.value, tag_open.value, tag_close.value
-        ),
-        interactive=True,
-        label="Does not work",
-        show_label=True,
+    high_t2h.change(
+        fn=lambda x: x["data"],
+        inputs=high_t2h,
+        outputs=high_h2t,
+    )
+    high_h2t.change(
+        fn=convert_highlighted_text_to_tagged_text,
+        inputs=[high_h2t, tag_id, tag_open, tag_close],
+        outputs=tagged_h2t,
     )
 
 

src/frontend/HighlightedTextbox.svelte

@@ -3,7 +3,6 @@
 		beforeUpdate,
 		afterUpdate,
 		createEventDispatcher,
-		tick,
 	} from "svelte";
 	import { BlockTitle } from "@gradio/atoms";
 	import { Copy, Check } from "@gradio/icons";
@@ -54,8 +53,8 @@
 		_color_map = correct_color_map(current_color_map, browser, ctx);
 	}
 
-	function set_text_from_value(): void {
-		if (value.length > 0 && value_is_output) {
+	function set_text_from_value(as_output: boolean): void {
+		if (value.length > 0 && as_output) {
 			el_text = value.map(([text, _]) => text).join(" ");
 			marked_el_text = value.map(([text, category]) => {
 				if (category !== null) {
@@ -67,15 +66,15 @@
 		}
 	}
 
-	$: set_text_from_value();
 	$: set_color_map();
+	$: set_text_from_value(true);
 
 	const dispatch = createEventDispatcher<{
 		change: string;
 		submit: undefined;
 		blur: undefined;
 		select: SelectData;
-		input: undefined;
+		input: string;
 		focus: undefined;
 	}>();
 
@@ -92,7 +91,7 @@
 	}
 	afterUpdate(() => {
 		set_color_map();
-		set_text_from_value();
+		set_text_from_value(value_is_output);
 		value_is_output = false;
 	});
 	$: marked_el_text, handle_change();

src/pyproject.toml

@@ -8,7 +8,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "gradio_highlightedtextbox"
-version = "0.0.4"
+version = "0.0.5"
 description = "Editable Gradio textarea supporting highlighting"
 readme = "README.md"
 license = "mit"
@@ -35,8 +35,11 @@ classifiers = [
 [project.optional-dependencies]
 dev = ["build", "twine"]
 
+[project.urls]
+space = "https://huggingface.co/spaces/gsarti/gradio_highlightedtextbox"
+
 [tool.hatch.build]
-artifacts = ["/backend/gradio_highlightedtextbox/templates", "*.pyi", "backend/gradio_highlightedtextbox/templates", "backend/gradio_highlightedtextbox/templates", "Users/gsarti/Documents/projects/highlightedtextbox/backend/gradio_highlightedtextbox/templates", "Users/gsarti/Documents/projects/highlightedtextbox/backend/gradio_highlightedtextbox/templates", "backend/gradio_highlightedtextbox/templates", "backend/gradio_highlightedtextbox/templates", "backend/gradio_highlightedtextbox/templates", "backend/gradio_highlightedtextbox/templates", "backend/gradio_highlightedtextbox/templates"]
+artifacts = ["/backend/gradio_highlightedtextbox/templates", "*.pyi", "backend/gradio_highlightedtextbox/templates", "backend/gradio_highlightedtextbox/templates", "Users/gsarti/Documents/projects/highlightedtextbox/backend/gradio_highlightedtextbox/templates", "Users/gsarti/Documents/projects/highlightedtextbox/backend/gradio_highlightedtextbox/templates", "backend/gradio_highlightedtextbox/templates", "backend/gradio_highlightedtextbox/templates", "backend/gradio_highlightedtextbox/templates", "backend/gradio_highlightedtextbox/templates", "backend/gradio_highlightedtextbox/templates", "backend/gradio_highlightedtextbox/templates", "backend/gradio_highlightedtextbox/templates"]
 
 [tool.hatch.build.targets.wheel]
 packages = ["/backend/gradio_highlightedtextbox"]