New to Gradio? Start here: Getting Started
See the Release History
ClearButton
gradio.ClearButton(···)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: passes the button value as a str into the function
As output: expects a str to be returned from a function, which is set as the label of the button
Initialization
| Parameter | Description |
|---|---|
components
None | list[Component] | Component default: None |
|
value
str default: "Clear" |
Default text for the button to display. If callable, the function will be called whenever the app loads to set the initial value of the component. |
variant
Literal[('primary', 'secondary', 'stop')] default: "secondary" |
'primary' for main call-to-action, 'secondary' for a more subdued style, 'stop' for a stop button. |
size
Literal[('sm', 'lg')] | None default: None |
Size of the button. Can be "sm" or "lg". |
icon
str | None default: None |
URL or path to the icon file to display within the button. If None, no icon will be displayed. Must be within the working directory of the Gradio app or an external URL. |
link
str | None default: None |
URL to open when the button is clicked. If None, no link will be used. |
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. |
scale
int | None default: None |
relative width compared to adjacent Components in a Row. For example, if Component A has scale=2, and Component B has scale=1, A will be twice as wide as B. Should be an integer. |
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. |
Shortcuts
| Class | Interface String Shortcut | Initialization |
|---|---|---|
|
"clearbutton" |
Uses default values |
Event Listeners
Description
Event listeners allow you to capture and 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 Arguments table below.
| Listener | Description |
|---|---|
|
Adds a component or list of components to the list of components that will be cleared when the button is clicked. |
|
This listener is triggered when the component (e.g. a button) is clicked. |
Event Arguments
| Parameter | Description |
|---|---|
components
None | Component | list[Component] required |