Fix readme

src/README.md

@@ -1,25 +1,502 @@
----
-tags:
-- gradio-custom-component
-- gradio-template-SimpleTextbox
-- highlight
-- textbox
-- editing
-- color
-title: gradio_highlightedtextbox
-colorFrom: indigo
-colorTo: green
-sdk: docker
-pinned: false
-license: apache-2.0
-python_version: 3.11
-emoji: 🔤🖌️
-short_description: Gradio component - Editable textarea supporting highlighting
----
-
-
-# Name: gradio_highlightedtextbox
-
-Description: Editable Gradio textarea supporting highlighting
-
-Install with: pip install gradio_highlightedtextbox
+
+
+# `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>
+
+Editable Gradio textarea supporting highlighting
+
+## Installation
+
+```bash
+pip install gradio_highlightedtextbox
+```
+
+## Usage
+
+```python
+import gradio as gr
+from ..backend.gradio_highlightedtextbox import HighlightedTextbox
+
+
+def convert_tagged_text_to_highlighted_text(
+    tagged_text: str,
+    tag_id: str | list[str],
+    tag_open: str | list[str],
+    tag_close: str | list[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 | list[str],
+    tag_open: str | list[str],
+    tag_close: str | list[str],
+) -> str:
+    return HighlightedTextbox.tuples_to_tagged_text(
+        highlighted_text["data"], tag_id, tag_open, tag_close
+    )
+
+
+def show_info(
+    highlighted_text: dict[str, str | list[tuple[str, str | None]]],
+    tag_id: str | list[str],
+    tag_open: str | list[str],
+    tag_close: str | list[str],
+    msg: str,
+) -> None:
+    gr.Info(
+        f"{msg}: {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 <a>personal fears</a> and <b>dislikes</b> of other things that <c>manny peopl</c> have."
+
+with gr.Blocks() as demo:
+    gr.Markdown("### Parameters to control the highlighted textbox:")
+    with gr.Row():
+        tag_id = gr.Dropdown(
+            choices=["Error A", "Error B", "Error C"],
+            value=["Error A", "Error B", "Error C"],
+            multiselect=True,
+            allow_custom_value=True,
+            label="Tag ID",
+            show_label=True,
+            info="Insert one or more tag IDs to use in the highlighted textbox.",
+        )
+        tag_open = gr.Dropdown(
+            choices=["<a>", "<b>", "<c>"],
+            value=["<a>", "<b>", "<c>"],
+            multiselect=True,
+            allow_custom_value=True,
+            label="Tag open",
+            show_label=True,
+            info="Insert one or more tags to mark the beginning of a highlighted section.",
+        )
+        tag_close = gr.Dropdown(
+            choices=["</a>", "</b>", "</c>"],
+            value=["</a>", "</b>", "</c>"],
+            multiselect=True,
+            allow_custom_value=True,
+            label="Tag close",
+            show_label=True,
+            info="Insert one or more tags to mark the end of a highlighted section.",
+        )
+    gr.Markdown(
+        """
+### Example:
+
+The following text is tagged using the parameters above to mark spans that will be highlighted.
+
+Both the tagged text and the highlighted text are editable, so you can see how the changes in one affect the other.
+
+Highlights will disappear if the highlighted text is edited. Modals will appear upon focus, change, and blur events on the highlighted text.
+"""
+    )
+    with gr.Row():
+        tagged = gr.Textbox(
+            initial_text,
+            interactive=True,
+            label="Tagged text",
+            show_label=True,
+            info="Tagged text using the format above to mark spans that will be highlighted.",
+        )
+        high = HighlightedTextbox(
+            convert_tagged_text_to_highlighted_text(
+                tagged.value, tag_id.value, tag_open.value, tag_close.value
+            ),
+            interactive=True,
+            label="Highlighted text",
+            info="Textbox containing editable text with custom highlights.",
+            show_legend=True,
+            show_label=True,
+            legend_label="Legend:",
+            show_legend_label=True,
+            show_remove_tags_button=True,
+            show_copy_button=False,
+            color_map={"Error A": "blue", "Error B": "red", "Error C": "green"},
+        )
+
+    # Functions
+
+    tagged.input(
+        fn=convert_tagged_text_to_highlighted_text,
+        inputs=[tagged, tag_id, tag_open, tag_close],
+        outputs=high,
+    )
+    high.input(
+        fn=convert_highlighted_text_to_tagged_text,
+        inputs=[high, tag_id, tag_open, tag_close],
+        outputs=tagged,
+    )
+    high.focus(
+        fn=show_info,
+        inputs=[high, tag_id, tag_open, tag_close, gr.State("Focus")],
+        outputs=None,
+    )
+    high.blur(
+        fn=show_info,
+        inputs=[high, tag_id, tag_open, tag_close, gr.State("Blur")],
+        outputs=None,
+    )
+    high.clear(
+        fn=show_info,
+        inputs=[high, tag_id, tag_open, tag_close, gr.State("Remove tags")],
+        outputs=None,
+    )
+
+if __name__ == "__main__":
+    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
+list[tuple[str, str | None]] | 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>
+
+<tr>
+<td align="left"><code>show_remove_tags_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 button to remove all tags from the text.</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. |
+| `clear` | This listener is triggered when the user clears the HighlightedTextbox using the X button for the component. |
+
+
+
+### 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 output:** Is passed, the preprocessed input data sent to the user's function in the backend.
+- **As input:** Should return, list of (word, category) tuples, or a dictionary of two keys: "id", and "data", which is a list of (word, category) tuples.
+
+ ```python
+ def predict(
+     value: dict
+ ) -> list[tuple[str, str | None]] | dict | None:
+     return value
+ ```
+