Components

Introduction

Gradio includes pre-built components that can be used as inputs or outputs in your Interface or Blocks with a single line of code. Components include preprocessing steps that convert user data submitted through browser to something that be can used by a Python function, and postprocessing steps to convert values returned by a Python function into something that can be displayed in a browser.

Consider an example with three inputs (Textbox, Number, and Image) and two outputs (Number and Gallery), below is a diagram of what our preprocessing will send to the function and what our postprocessing will require from it.

Events

Components also come with certain events that they support. These are methods that are triggered with user actions. Below is a table showing which events are supported for each component. All events are also listed (with parameters) in the component’s docs.

	example_select	stream	upload	clear	focus	option_select	undo	start_recording	edit	submit	key_up	release	delete	pause	play	tick	change	copy	stop_recording	select	input	download	apply	pause_recording	like	preview_open	double_click	retry	stop	end	preview_close	blur	click
AnnotatedImage	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✓	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕
Audio	✕	✓	✓	✓	✕	✕	✕	✓	✕	✕	✕	✕	✕	✓	✓	✕	✓	✕	✓	✕	✓	✕	✕	✓	✕	✕	✕	✕	✓	✕	✕	✕	✕
BrowserState	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✓	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕
Button	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✓
Chatbot	✓	✕	✕	✓	✕	✓	✓	✕	✓	✕	✕	✕	✕	✕	✕	✕	✓	✓	✕	✓	✕	✕	✕	✕	✓	✕	✕	✓	✕	✕	✕	✕	✕
Checkbox	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✓	✕	✕	✓	✓	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕
CheckboxGroup	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✓	✕	✕	✓	✓	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕
ClearButton	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✓
Code	✕	✕	✕	✕	✓	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✓	✕	✕	✕	✓	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✓	✕
ColorPicker	✕	✕	✕	✕	✓	✕	✕	✕	✕	✓	✕	✕	✕	✕	✕	✕	✓	✕	✕	✕	✓	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✓	✕
Dataframe	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✓	✕	✕	✓	✓	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕
Dataset	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✓	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✓
DateTime	✕	✕	✕	✕	✕	✕	✕	✕	✕	✓	✕	✕	✕	✕	✕	✕	✓	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕
DeepLinkButton	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✓
DownloadButton	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✓
Dropdown	✕	✕	✕	✕	✓	✕	✕	✕	✕	✕	✓	✕	✕	✕	✕	✕	✓	✕	✕	✓	✓	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✓	✕
DuplicateButton	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✓
File	✕	✕	✓	✓	✕	✕	✕	✕	✕	✕	✕	✕	✓	✕	✕	✕	✓	✕	✕	✓	✕	✓	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕
FileExplorer	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✓	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕
Gallery	✕	✕	✓	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✓	✕	✕	✓	✕	✕	✕	✕	✕	✓	✕	✕	✕	✕	✓	✕	✕
HighlightedText	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✓	✕	✕	✓	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕
HTML	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✓	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✓
ImageEditor	✕	✕	✓	✓	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✓	✕	✕	✓	✓	✕	✓	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕
Image	✕	✓	✓	✓	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✓	✕	✕	✓	✓	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕
ImageSlider	✕	✓	✓	✓	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✓	✕	✕	✓	✓	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕
JSON	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✓	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕
Label	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✓	✕	✕	✓	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕
LoginButton	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✓
Markdown	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✓	✓	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕
Model3D	✕	✕	✓	✓	✕	✕	✕	✕	✓	✕	✕	✕	✕	✕	✕	✕	✓	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕
MultimodalTextbox	✕	✕	✕	✕	✓	✕	✕	✕	✕	✓	✕	✕	✕	✕	✕	✕	✓	✕	✕	✓	✓	✕	✕	✕	✕	✕	✕	✕	✓	✕	✕	✓	✕
BarPlot	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✓	✕	✕	✕	✕	✕	✕	✓	✕	✕	✕	✕	✕	✕
LinePlot	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✓	✕	✕	✕	✕	✕	✕	✓	✕	✕	✕	✕	✕	✕
ScatterPlot	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✓	✕	✕	✕	✕	✕	✕	✓	✕	✕	✕	✕	✕	✕
Number	✕	✕	✕	✕	✓	✕	✕	✕	✕	✓	✕	✕	✕	✕	✕	✕	✓	✕	✕	✕	✓	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✓	✕
ParamViewer	✕	✕	✓	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✓	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕
Plot	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✓	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕
Radio	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✓	✕	✕	✓	✓	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕
Slider	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✓	✕	✕	✕	✕	✓	✕	✕	✕	✓	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕
State	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✓	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕
Textbox	✕	✕	✕	✕	✓	✕	✕	✕	✕	✓	✕	✕	✕	✕	✕	✕	✓	✓	✕	✓	✓	✕	✕	✕	✕	✕	✕	✕	✓	✕	✕	✓	✕
Timer	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✓	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕
UploadButton	✕	✕	✓	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✓
Video	✕	✕	✓	✓	✕	✕	✕	✓	✕	✕	✕	✕	✕	✓	✓	✕	✓	✕	✓	✕	✕	✕	✕	✕	✕	✕	✕	✕	✓	✓	✕	✕	✕
SimpleImage	✕	✕	✓	✓	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✓	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕	✕

←

Tab

AnnotatedImage

→