Button

The Button component creates a clickable button that triggers events.

Basic usage

import gradio as gr

def greet():
    return "Hello!"

with gr.Blocks() as demo:
    output = gr.Textbox()
    btn = gr.Button("Click me")
    btn.click(fn=greet, outputs=output)
    
demo.launch()

Constructor

str | Callable

default:"'Run'"

Button label text

Literal['primary', 'secondary', 'stop', 'huggingface']

default:"'secondary'"

Button style:

"primary" - Main call-to-action
"secondary" - Subdued style
"stop" - Stop button
"huggingface" - HF branded style

Literal['sm', 'md', 'lg']

default:"'lg'"

Button size

str | Path | None

default:"None"

URL or path to icon file to display

str | None

default:"None"

URL to open when clicked

Literal['_self', '_blank', '_parent', '_top']

default:"'_self'"

Where to open the linked URL

bool

default:"True"

Whether button is clickable

Events

click - Triggered when button is clicked

Examples

Primary button

import gradio as gr

btn = gr.Button("Submit", variant="primary")

With icon

import gradio as gr

btn = gr.Button(
    "Download",
    icon="https://huggingface.co/favicon.ico"
)

As link

import gradio as gr

btn = gr.Button(
    "Visit Gradio",
    link="https://gradio.app",
    link_target="_blank"
)

Overview

Input Components

Output Components

Layout Components

Control Components

Special Components

Basic usage

Constructor

Events

Examples

Primary button

With icon

As link

​Basic usage

​Constructor

​Events

​Examples

​Primary button

​With icon

​As link

Basic usage

Constructor

Events

Examples

Primary button

With icon

As link