Gradio Agents & MCP Hackathon · Virtual, June 2-8 · $10k+ in prizes

Register Now
Gradio logo
  1. Components
  2. ClearButton

New to Gradio? Start here: Getting Started

See the Release History

←

CheckboxGroup

Code

→

ClearButton

gradio.ClearButton(···)
import gradio as gr with gr.Blocks() as demo: textbox = gr.Textbox(value="This is some text") gr.ClearButton(textbox) demo.launch()

Description

Button that clears the value of a component or a list of components when clicked. It is instantiated with the list of components to clear.

Behavior

As input component: (Rarely used) the str corresponding to the button label when the button is clicked

Your function should accept one of these types:
def predict(
	value: str | None
)
	...

As output component: string corresponding to the button label

Your function should return one of these types:
def predict(···) -> str | None
	...	
	return value

Initialization

Parameters
🔗 
components: None | list[Component] | Component
default = None
🔗 
value: str
default = "Clear"

default text for the button to display. If a function is provided, the function will be called each time the app loads to set the initial value of this component.

🔗 
every: Timer | float | None
default = None

continuously calls `value` to recalculate it if `value` is a function (has no effect otherwise). Can provide a Timer whose tick resets `value`, or a float that provides the regular interval for the reset Timer.

🔗 
inputs: Component | list[Component] | set[Component] | None
default = None

components that are used as inputs to calculate `value` if `value` is a function (has no effect otherwise). `value` is recalculated any time the inputs change.

🔗 
variant: Literal['primary', 'secondary', 'stop']
default = "secondary"

sets the background and text color of the button. Use 'primary' for main call-to-action buttons, 'secondary' for a more subdued style, 'stop' for a stop button, 'huggingface' for a black background with white text, consistent with Hugging Face's button styles.

🔗 
size: Literal['sm', 'md', 'lg']
default = "lg"

size of the button. Can be "sm", "md", or "lg".

🔗 
icon: str | Path | None
default = None

URL or path to the icon file to display within the button. If None, no icon will be displayed.

🔗 
visible: bool
default = True

if False, component will be hidden.

🔗 
interactive: bool
default = True

if False, the Button will be in a disabled state.

🔗 
elem_id: str | None
default = None

an optional string that is assigned as the id of this component in the HTML DOM. Can be used for targeting CSS styles.

🔗 
elem_classes: list[str] | str | None
default = None

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.

🔗 
render: bool
default = True

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.

🔗 
key: int | str | tuple[int | str, ...] | None
default = None

in a gr.render, Components with the same key across re-renders are treated as the same component, not a new component. Properties set in 'preserved_by_key' are not reset across a re-render.

🔗 
preserved_by_key: list[str] | str | None
default = "value"

A list of parameters from this component's constructor. Inside a gr.render() function, if a component is re-rendered with the same key, these (and only these) parameters will be preserved in the UI (if they have been changed by the user or an event listener) instead of re-rendered based on the values provided during constructor.

🔗 
scale: int | None
default = None

relative size compared to adjacent Components. For example if Components A and B are in a Row, and A has scale=2, and B has scale=1, A will be twice as wide as B. Should be an integer. scale applies in Rows, and to top-level Components in Blocks where fill_height=True.

🔗 
min_width: int | None
default = None

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.

🔗 
api_name: str | None | Literal['False']
default = None
🔗 
show_api: bool
default = False

Shortcuts

Class Interface String Shortcut Initialization

gradio.ClearButton

"clearbutton"

 Uses default values

Event Listeners

Description

Event listeners allow you to respond to user interactions with the UI components you've defined in a Gradio Blocks app. When a user interacts with an element, such as changing a slider value or uploading an image, a function is called.

Supported Event Listeners

The ClearButton component supports the following event listeners. Each event listener takes the same parameters, which are listed in the Event Parameters table below.

Listener Description

ClearButton.add(fn, ···)

Adds a component or list of components to the list of components that will be cleared when the button is clicked.

ClearButton.click(fn, ···)

Triggered when the Button is clicked.

Event Parameters

Parameters
🔗 
components: None | Component | list[Component]
←

CheckboxGroup

Code

→