Render decorator documentation (#8409)

* changes

* changes

* add changeset

* fix dependency loop and documentation group

* add changeset

* changes

* fix numbered list

* changes

* changes

---------

Co-authored-by: Ali Abid <[email protected]>
Co-authored-by: gradio-pr-bot <[email protected]>
Co-authored-by: aliabd <[email protected]>

.changeset/rare-places-help.md

@@ -0,0 +1,7 @@
+---
+"@gradio/statustracker": minor
+"gradio": minor
+"gradio_client": minor
+---
+
+feat:Render decorator documentation

client/python/gradio_client/documentation.py

@@ -58,6 +58,7 @@ def extract_instance_attr_doc(cls, attr):
     ("gradio.theme", "themes"),
     ("gradio_client.", "py-client"),
     ("gradio.utils", "helpers"),
+    ("gradio.renderable", "renderable"),
 ]
 
 

demo/audio_mixer/run.ipynb

@@ -0,0 +1 @@
+{"cells": [{"cell_type": "markdown", "id": "302934307671667531413257853548643485645", "metadata": {}, "source": ["# Gradio Demo: audio_mixer"]}, {"cell_type": "code", "execution_count": null, "id": "272996653310673477252411125948039410165", "metadata": {}, "outputs": [], "source": ["!pip install -q gradio "]}, {"cell_type": "code", "execution_count": null, "id": "288918539441861185822528903084949547379", "metadata": {}, "outputs": [], "source": ["import gradio as gr\n", "\n", "with gr.Blocks() as demo:\n", "    track_count = gr.State(1)\n", "    add_track_btn = gr.Button(\"Add Track\")\n", "\n", "    @gr.render(inputs=track_count)\n", "    def render_tracks(count):\n", "        tracks = []\n", "        with gr.Row():\n", "            for i in range(count):\n", "                with gr.Column(variant=\"panel\", scale=0):\n", "                    track_name = gr.Textbox(placeholder=\"Track Name\", key=f\"name-{i}\", show_label=False)\n", "                    track_audio = gr.Audio(label=f\"Track {i}\", key=f\"track-{i}\")\n", "                    track_volume = gr.Slider(0, 1, step=0.01, label=\"Volume\", key=f\"volume-{i}\")\n", "\n", "if __name__ == \"__main__\":\n", "    demo.launch()"]}], "metadata": {}, "nbformat": 4, "nbformat_minor": 5}

demo/audio_mixer/run.py

@@ -0,0 +1,18 @@
+import gradio as gr
+
+with gr.Blocks() as demo:
+    track_count = gr.State(1)
+    add_track_btn = gr.Button("Add Track")
+
+    @gr.render(inputs=track_count)
+    def render_tracks(count):
+        tracks = []
+        with gr.Row():
+            for i in range(count):
+                with gr.Column(variant="panel", scale=0):
+                    track_name = gr.Textbox(placeholder="Track Name", key=f"name-{i}", show_label=False)
+                    track_audio = gr.Audio(label=f"Track {i}", key=f"track-{i}")
+                    track_volume = gr.Slider(0, 1, step=0.01, label="Volume", key=f"volume-{i}")
+
+if __name__ == "__main__":
+    demo.launch()

demo/render_merge/run.ipynb

@@ -1 +1 @@
-{"cells": [{"cell_type": "markdown", "id": "302934307671667531413257853548643485645", "metadata": {}, "source": ["# Gradio Demo: render_merge"]}, {"cell_type": "code", "execution_count": null, "id": "272996653310673477252411125948039410165", "metadata": {}, "outputs": [], "source": ["!pip install -q gradio "]}, {"cell_type": "code", "execution_count": null, "id": "288918539441861185822528903084949547379", "metadata": {}, "outputs": [], "source": ["import gradio as gr\n", "\n", "with gr.Blocks() as demo:\n", "    text_count = gr.Slider(1, 5, step=1, label=\"Textbox Count\")\n", "\n", "    @gr.render(inputs=text_count)\n", "    def render_count(count):\n", "        boxes = []\n", "        for i in range(count):\n", "            box = gr.Textbox(key=i, label=f\"Box {i}\")\n", "            boxes.append(box)\n", "\n", "        def merge(*args):\n", "            return \" \".join(args)\n", "        \n", "        merge_btn.click(merge, boxes, output)\n", "\n", "        def clear():\n", "            return [\"\"] * count\n", "                \n", "        clear_btn.click(clear, None, boxes)\n", "\n", "        def countup():\n", "            return [i for i in range(count)]\n", "        \n", "        count_btn.click(countup, None, boxes, queue=False)\n", "\n", "    with gr.Row():\n", "        merge_btn = gr.Button(\"Merge\")\n", "        clear_btn = gr.Button(\"Clear\")\n", "        count_btn = gr.Button(\"Count\")\n", "        \n", "    output = gr.Textbox()\n", "\n", "if __name__ == \"__main__\":\n", "    demo.launch()"]}], "metadata": {}, "nbformat": 4, "nbformat_minor": 5}
+{"cells": [{"cell_type": "markdown", "id": "302934307671667531413257853548643485645", "metadata": {}, "source": ["# Gradio Demo: render_merge"]}, {"cell_type": "code", "execution_count": null, "id": "272996653310673477252411125948039410165", "metadata": {}, "outputs": [], "source": ["!pip install -q gradio "]}, {"cell_type": "code", "execution_count": null, "id": "288918539441861185822528903084949547379", "metadata": {}, "outputs": [], "source": ["import gradio as gr\n", "\n", "with gr.Blocks() as demo:\n", "    text_count = gr.Slider(1, 5, step=1, label=\"Textbox Count\")\n", "\n", "    @gr.render(inputs=text_count)\n", "    def render_count(count):\n", "        boxes = []\n", "        for i in range(count):\n", "            box = gr.Textbox(key=i, label=f\"Box {i}\")                \n", "            boxes.append(box)\n", "\n", "        def merge(*args):\n", "            return \" \".join(args)\n", "        \n", "        merge_btn.click(merge, boxes, output)\n", "\n", "        def clear():\n", "            return [\"\"] * count\n", "                \n", "        clear_btn.click(clear, None, boxes)\n", "\n", "        def countup():\n", "            return [i for i in range(count)]\n", "        \n", "        count_btn.click(countup, None, boxes, queue=False)\n", "\n", "    with gr.Row():\n", "        merge_btn = gr.Button(\"Merge\")\n", "        clear_btn = gr.Button(\"Clear\")\n", "        count_btn = gr.Button(\"Count\")\n", "        \n", "    output = gr.Textbox()\n", "\n", "if __name__ == \"__main__\":\n", "    demo.launch()"]}], "metadata": {}, "nbformat": 4, "nbformat_minor": 5}

demo/render_merge/run.py

@@ -7,7 +7,7 @@
     def render_count(count):
         boxes = []
         for i in range(count):
-            box = gr.Textbox(key=i, label=f"Box {i}")
+            box = gr.Textbox(key=i, label=f"Box {i}")                
             boxes.append(box)
 
         def merge(*args):

demo/render_merge_simple/run.ipynb

@@ -0,0 +1 @@
+{"cells": [{"cell_type": "markdown", "id": "302934307671667531413257853548643485645", "metadata": {}, "source": ["# Gradio Demo: render_merge_simple"]}, {"cell_type": "code", "execution_count": null, "id": "272996653310673477252411125948039410165", "metadata": {}, "outputs": [], "source": ["!pip install -q gradio "]}, {"cell_type": "code", "execution_count": null, "id": "288918539441861185822528903084949547379", "metadata": {}, "outputs": [], "source": ["import gradio as gr\n", "\n", "with gr.Blocks() as demo:\n", "    text_count = gr.State(1)\n", "    add_btn = gr.Button(\"Add Box\")\n", "    add_btn.click(lambda x: x + 1, text_count, text_count)\n", "\n", "    @gr.render(inputs=text_count)\n", "    def render_count(count):\n", "        boxes = []\n", "        for i in range(count):\n", "            box = gr.Textbox(key=i, label=f\"Box {i}\")\n", "            boxes.append(box)\n", "\n", "        def merge(*args):\n", "            return \" \".join(args)\n", "        \n", "        merge_btn.click(merge, boxes, output)\n", "\n", "\n", "    merge_btn = gr.Button(\"Merge\")\n", "    output = gr.Textbox(label=\"Merged Output\")\n", "\n", "if __name__ == \"__main__\":\n", "    demo.launch()"]}], "metadata": {}, "nbformat": 4, "nbformat_minor": 5}

demo/render_merge_simple/run.py

@@ -0,0 +1,25 @@
+import gradio as gr
+
+with gr.Blocks() as demo:
+    text_count = gr.State(1)
+    add_btn = gr.Button("Add Box")
+    add_btn.click(lambda x: x + 1, text_count, text_count)
+
+    @gr.render(inputs=text_count)
+    def render_count(count):
+        boxes = []
+        for i in range(count):
+            box = gr.Textbox(key=i, label=f"Box {i}")
+            boxes.append(box)
+
+        def merge(*args):
+            return " ".join(args)
+
+        merge_btn.click(merge, boxes, output)
+
+
+    merge_btn = gr.Button("Merge")
+    output = gr.Textbox(label="Merged Output")
+
+if __name__ == "__main__":
+    demo.launch()

demo/render_split_simple/run.ipynb

@@ -0,0 +1 @@
+{"cells": [{"cell_type": "markdown", "id": "302934307671667531413257853548643485645", "metadata": {}, "source": ["# Gradio Demo: render_split_simple"]}, {"cell_type": "code", "execution_count": null, "id": "272996653310673477252411125948039410165", "metadata": {}, "outputs": [], "source": ["!pip install -q gradio "]}, {"cell_type": "code", "execution_count": null, "id": "288918539441861185822528903084949547379", "metadata": {}, "outputs": [], "source": ["import gradio as gr\n", "\n", "with gr.Blocks() as demo:\n", "    input_text = gr.Textbox(label=\"input\")\n", "\n", "    @gr.render(inputs=input_text)\n", "    def show_split(text):\n", "        if len(text) == 0:\n", "            gr.Markdown(\"## No Input Provided\")\n", "        else:\n", "            for letter in text:\n", "                gr.Textbox(letter)\n", "\n", "if __name__ == \"__main__\":\n", "    demo.launch()"]}], "metadata": {}, "nbformat": 4, "nbformat_minor": 5}

demo/render_split_simple/run.py

@@ -0,0 +1,15 @@
+import gradio as gr
+
+with gr.Blocks() as demo:
+    input_text = gr.Textbox(label="input")
+
+    @gr.render(inputs=input_text)
+    def show_split(text):
+        if len(text) == 0:
+            gr.Markdown("## No Input Provided")
+        else:
+            for letter in text:
+                gr.Textbox(letter)
+
+if __name__ == "__main__":
+    demo.launch()

gradio/renderable.py

@@ -2,6 +2,8 @@
 
 from typing import Callable, Literal
 
+from gradio_client.documentation import document
+
 from gradio.blocks import Block
 from gradio.components import Component
 from gradio.context import Context, LocalContext
@@ -72,14 +74,48 @@ def apply(self, *args, **kwargs):
             LocalContext.renderable.set(None)
 
 
+@document()
 def render(
     inputs: list[Component] | None = None,
     triggers: list[EventListener] | EventListener | None = None,
+    *,
+    queue: bool = True,
+    trigger_mode: Literal["once", "multiple", "always_last"] | None = "always_last",
     concurrency_limit: int | None | Literal["default"] = None,
     concurrency_id: str | None = None,
-    trigger_mode: Literal["once", "multiple", "always_last"] | None = "always_last",
-    queue: bool = True,
 ):
+    """
+    The render decorator allows Gradio Blocks apps to have dynamic layouts, so that the components and event listeners in your app can change depending on custom logic.
+    Attaching a @gr.render decorator to a function will cause the function to be re-run whenever the inputs are changed (or specified triggers are activated). The function contains the components and event listeners that will update based on the inputs.
+
+    The basic usage of @gr.render is as follows:
+    1) Create a function and attach the @gr.render decorator to it.
+    2) Add the input components to the `inputs=` argument of @gr.render, and create a corresponding argument in your function for each component.
+    3) Add all components inside the function that you want to update based on the inputs. Any event listeners that use these components should also be inside this function.
+    Parameters:
+        inputs: List of gradio.components to use as inputs. If the function takes no inputs, this should be an empty list.
+        triggers: List of triggers to listen to, e.g. [btn.click, number.change]. If None, will listen to changes to any inputs.
+        queue: If True, will place the request on the queue, if the queue has been enabled. If False, will not put this event on the queue, even if the queue has been enabled. If None, will use the queue setting of the gradio app.
+        trigger_mode: If "once" (default for all events except `.change()`) would not allow any submissions while an event is pending. If set to "multiple", unlimited submissions are allowed while pending, and "always_last" (default for `.change()` and `.key_up()` events) would allow a second submission after the pending event is complete.
+        concurrency_limit: If set, this is the maximum number of this event that can be running simultaneously. Can be set to None to mean no concurrency_limit (any number of this event can be running simultaneously). Set to "default" to use the default concurrency limit (defined by the `default_concurrency_limit` parameter in `Blocks.queue()`, which itself is 1 by default).
+        concurrency_id: If set, this is the id of the concurrency group. Events with the same concurrency_id will be limited by the lowest set concurrency_limit.
+    Example:
+        import gradio as gr
+
+        with gr.Blocks() as demo:
+            input_text = gr.Textbox()
+
+            @gr.render(inputs=input_text)
+            def show_split(text):
+                if len(text) == 0:
+                    gr.Markdown("## No Input Provided")
+                else:
+                    for letter in text:
+                        with gr.Row():
+                            text = gr.Textbox(letter)
+                            btn = gr.Button("Clear")
+                            btn.click(lambda: gr.Textbox(value=""), None, text)
+    """
     if Context.root_block is None:
         raise ValueError("Reactive render must be inside a Blocks context.")
 

guides/04_building-with-blocks/04_dynamic-apps-with-render-decorator.md

@@ -0,0 +1,46 @@
+# Dynamic Apps with the Render Decorator
+
+The components and event listeners you define in a Blocks so far have been fixed - once the demo was launched, new components and listeners could not be added, and existing one could not be removed. 
+
+The `@gr.render` decorator introduces the ability to dynamically change this. Let's take a look. 
+
+## Dynamic Number of Components
+
+In the example below, we will create a variable number of Textboxes. When the user edits the input Textbox, we create a Textbox for each letter in the input. Try it out below:
+
+$code_render_split_simple
+$demo_render_split_simple
+
+See how we can now create a variable number of Textboxes using our custom logic - in this case, a simple `for` loop. The `@gr.render` decorator enables this with the following steps:
+
+1. Create a function and attach the @gr.render decorator to it.
+2. Add the input components to the `inputs=` argument of @gr.render, and create a corresponding argument in your function for each component. This function will automatically re-run on any change to a component.
+3. Add all components inside the function that you want to render based on the inputs.
+
+Now whenever the inputs change, the funciton re-runs, and replaces the components created from the previous funciton run with the latest run. Pretty straightforward! Let's add a little more complexity to this app:
+
+$code_render_split
+$demo_render_split
+
+By default, `@gr.render` re-runs are triggered by the `.load` listener to the app and the `.change` listener to any input component provided. We can override this by explicitly setting the triggers in the decorator, as we have in this app to only trigger on `input_text.submit` instead. 
+If you are setting custom triggers, and you also want an automatic render at the start of the app, make sure to add `demo.load` to your list of triggers.
+
+## Dynamic Event Listeners
+
+If you're creating components, you probably want to attach event listeners to them as well. Let's take a look at an example that takes in a variable number of Textbox as input, and merges all the text into a single box.
+
+$code_render_merge_simple
+$demo_render_merge_simple
+
+Let's take a look at what's happening here:
+
+1) The state variable `text_count` is keeping track of the number of Textboxes to create. By increasing it via the Add button, we trigger re-renders as `text_count` is an input to the render decorator.
+2) Note that in every single Textbox we create in the render function, we explicitly set a `key=` argument. This key allows us to preserve the value of this Component between re-renders. If you type in a value in a textbox, and then click the Add button, all the Textboxes re-render, but their values aren't cleared because the `key=` maintains the the value of a Component across a render.
+3) We've stored the Textboxes created in a list, and provide this list as input to the merge button event listener. Note that **all event listeners that use Components created inside a render function must also be defined inside that render function**. The event listener can still reference Components outside the render function, as we do here by referencing `merge_btn` and `output` which are both defined outside the render function.
+
+Just as with Components, whenever a function re-renders, the event listeners created from the previous render are cleared and the new event listeners from the latest run are attached. 
+
+This allows us to create highly customizable and complex interactions! Take a look at the example below, which spices up the previous example with a lot more event listeners:
+
+$code_render_merge
+$demo_render_merge

js/statustracker/package.json

@@ -16,7 +16,6 @@
 	},
 	"dependencies": {
 		"@gradio/atoms": "workspace:^",
-		"@gradio/column": "workspace:^",
 		"@gradio/icons": "workspace:^",
 		"@gradio/utils": "workspace:^"
 	},