Address comments

Author: freddyaboulton

demo/deep_link/run.ipynb

@@ -0,0 +1 @@
+{"cells": [{"cell_type": "markdown", "id": "302934307671667531413257853548643485645", "metadata": {}, "source": ["# Gradio Demo: deep_link"]}, {"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", "import random\n", "\n", "def random_response(message, history):\n", "    return random.choice([\"Hi!\", \"Hello!\", \"Greetings!\"])\n", "\n", "with gr.Blocks() as demo:\n", "    gr.ChatInterface(\n", "        random_response,\n", "        title=\"Greeting Bot\",\n", "        description=\"Ask anything and receive a nice greeting!\",\n", "    )\n", "    gr.DeepLinkButton()\n", "\n", "if __name__ == \"__main__\":\n", "    demo.launch(share=True)\n"]}], "metadata": {}, "nbformat": 4, "nbformat_minor": 5}

demo/deep_link/run.py

@@ -0,0 +1,16 @@
+import gradio as gr
+import random
+
+def random_response(message, history):
+    return random.choice(["Hi!", "Hello!", "Greetings!"])
+
+with gr.Blocks() as demo:
+    gr.ChatInterface(
+        random_response,
+        title="Greeting Bot",
+        description="Ask anything and receive a nice greeting!",
+    )
+    gr.DeepLinkButton()
+
+if __name__ == "__main__":
+    demo.launch(share=True)

gradio/components/deep_link_button.py

@@ -107,7 +107,9 @@ def get_share_link(
                 .then(data => {
                     const currentUrl = new URL(window.location.href);
                     const cleanData = data.replace(/^"|"$/g, '');
-                    currentUrl.searchParams.set('deep_link', cleanData);
+                    if (cleanData) {
+                        currentUrl.searchParams.set('deep_link', cleanData);
+                    }
                     navigator.clipboard.writeText(currentUrl.toString());
                 })
                 .catch(error => {

gradio/interface.py

@@ -145,7 +145,7 @@ def __init__(
         | None = None,
         time_limit: int | None = 30,
         stream_every: float = 0.5,
-        deep_link: str | DeepLinkButton | None = None,
+        deep_link: str | DeepLinkButton | bool | None = None,
         **kwargs,
     ):
         """
@@ -188,6 +188,7 @@ def __init__(
             fill_width: whether to horizontally expand to fill container fully. If False, centers and constrains app to a maximum width.
             time_limit: The time limit for the stream to run. Default is 30 seconds. Parameter only used for streaming images or audio if the interface is live and the input components are set to "streaming=True".
             stream_every: The latency (in seconds) at which stream chunks are sent to the backend. Defaults to 0.5 seconds. Parameter only used for streaming images or audio if the interface is live and the input components are set to "streaming=True".
+            deep_link: a string or `gr.DeepLinkButton` object that creates a unique URL you can use to share your app and all components **as they currently are** with others. Automatically enabled on Hugging Face Spaces unless explicitly set to False.
         """
         super().__init__(
             analytics_enabled=analytics_enabled,
@@ -205,9 +206,11 @@ def __init__(
         )
         if isinstance(deep_link, str):
             deep_link = DeepLinkButton(value=deep_link)
-        if utils.get_space() and not deep_link:
+        elif deep_link is True:
             deep_link = DeepLinkButton()
-        if wasm_utils.IS_WASM:
+        if utils.get_space() and deep_link is None:
+            deep_link = DeepLinkButton()
+        if wasm_utils.IS_WASM or deep_link is False:
             deep_link = None
         self.deep_link = deep_link
         self.time_limit = time_limit

gradio/routes.py

@@ -661,7 +661,7 @@ def deep_link(session_hash: str):
                     f.write(components_json)
                 return deep_link
             else:
-                return "Error"
+                return ""
 
         @router.get("/info/", dependencies=[Depends(login_check)])
         @router.get("/info", dependencies=[Depends(login_check)])

guides/04_additional-features/07_sharing-your-app.md

@@ -56,7 +56,7 @@ After you have [created a free Hugging Face account](https://huggingface.co/join
 
 ## Sharing Deep Links
 
-You can add a button to your Gradio app that creates a unique URL you can use to share your app **as it currently is** with others. This is useful for sharing unique and interesting generations from your application , or for saving a snapshot of your app at a particular point in time.
+You can add a button to your Gradio app that creates a unique URL you can use to share your app and all components **as they currently are** with others. This is useful for sharing unique and interesting generations from your application , or for saving a snapshot of your app at a particular point in time.
 
 To add a deep link button to your app, place the `gr.DeepLinkButton` component anywhere in your app.
 For the URL to be accessible to others, your app must be available at a public URL. So be sure to host your app like Hugging Face Spaces or use the `share=True` parameter when launching your app.