Migrate DownloadButton

[freddyaboulton]

Description

Test with this demo

import gradio as gr
import tempfile
from pathlib import Path


def create_download_file():
    """Create a temporary file to download"""
    temp_file = tempfile.NamedTemporaryFile(mode='w', delete=False, suffix='.txt')
    temp_file.write("This is a sample download file.\nYou can download this file by clicking the button.")
    temp_file.close()
    return temp_file.name


def downloadbutton_identity(file_path):
    if file_path:
        return f"File ready for download: {file_path}", file_path
    return "No file selected", None


with gr.Blocks() as demo:
    with gr.Row():
        with gr.Column():
            # Create a sample file
            sample_file = create_download_file()

            download_button_input = gr.DownloadButton(
                label="Download Input",
                value=sample_file,
                variant="secondary",
                size="lg",
            )
            submit = gr.Button("Submit", variant="primary")
        with gr.Column():
            download_button_output_text = gr.Textbox(label="Download Button Output Info")
            download_button_output = gr.DownloadButton(
                label="Download Output",
                variant="primary",
                size="lg",
            )

    submit.click(
        fn=downloadbutton_identity,
        inputs=download_button_input,
        outputs=[download_button_output_text, download_button_output],
    )

    # Event handlers for download buttons
    with gr.Row():
        with gr.Column():
            input_button_click_event = gr.Textbox(label="Input Button Click Event")
            input_button_click_count = gr.Textbox(label="Input Button Click Count")
        with gr.Column():
            output_button_click_event = gr.Textbox(label="Output Button Click Event")
            output_button_click_count = gr.Textbox(label="Output Button Click Count")

    click_count_input = gr.State(value=0)
    click_count_output = gr.State(value=0)

    def on_input_click():
        count = click_count_input.value + 1
        click_count_input.value = count
        return f"Input button click event triggered", str(count)

    def on_output_click():
        count = click_count_output.value + 1
        click_count_output.value = count
        return f"Output button click event triggered", str(count)

    download_button_input.click(
        fn=on_input_click,
        outputs=[input_button_click_event, input_button_click_count],
    )

    download_button_output.click(
        fn=on_output_click,
        outputs=[output_button_click_event, output_button_click_count],
    )

    # Property update handlers
    with gr.Row():
        with gr.Column():
            button_variant = gr.Dropdown(
                label="Button Variant",
                choices=["primary", "secondary", "stop"],
                value="secondary",
            )
            button_size = gr.Dropdown(
                label="Button Size",
                choices=["sm", "lg"],
                value="lg",
            )
        with gr.Column():
            button_label = gr.Textbox(
                label="Button Label",
                value="Download Input",
            )
            make_interactive = gr.Button("Make Button Non-Interactive")
            make_interactive2 = gr.Button("Make Button Interactive")

    def update_button_variant(variant):
        return gr.DownloadButton(variant=variant)

    button_variant.change(
        fn=update_button_variant,
        inputs=[button_variant],
        outputs=[download_button_input],
    )

    def update_button_size(size):
        return gr.DownloadButton(size=size)

    button_size.change(
        fn=update_button_size,
        inputs=[button_size],
        outputs=[download_button_input],
    )

    def update_button_label(label):
        return gr.DownloadButton(label=label)

    button_label.change(
        fn=update_button_label,
        inputs=[button_label],
        outputs=[download_button_input],
    )

    make_interactive.click(lambda: gr.DownloadButton(interactive=False), None, download_button_input)
    make_interactive2.click(lambda: gr.DownloadButton(interactive=True), None, download_button_input)


if __name__ == "__main__":
    demo.launch()

AI Disclosure

We encourage the use of AI tooling in creating PRs, but the any non-trivial use of AI needs be disclosed. E.g. if you used Claude to write a first draft, you should mention that. Trivial tab-completion doesn't need to be disclosed. You should self-review all PRs, especially if they were generated with AI.

• I used AI to... [fill here]
• I did not use AI

🎯 PRs Should Target Issues

Before your create a PR, please check to see if there is an existing issue for this change. If not, please create an issue before you create this PR, unless the fix is very small.

Not adhering to this guideline will result in the PR being closed.

Testing and Formatting Your Code

1. PRs will only be merged if tests pass on CI. We recommend at least running the backend tests locally, please set up your Gradio environment locally and run the backed tests: bash scripts/run_backend_tests.sh

2. Please run these bash scripts to automatically format your code: bash scripts/format_backend.sh, and (if you made any changes to non-Python files) bash scripts/format_frontend.sh