New to Gradio? Start here: Getting Started
See the Release History
Block Layouts
Description
Customize the layout of your Blocks UI with the layout classes below.
Row
with gradio.Row():Description
Row is a layout element within Blocks that renders all children horizontally.
Example Usage
with gr.Blocks() as demo:
with gr.Row():
gr.Image("lion.jpg", scale=2)
gr.Image("tiger.jpg", scale=1)
demo.launch()Initialization
| Parameter | Description |
|---|---|
variant
Literal['default', 'panel', 'compact'] default: "default" |
row type, 'default' (no background), 'panel' (gray background color and rounded corners), or 'compact' (rounded corners and no internal gap). |
visible
bool default: True |
If False, row will be hidden. |
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. |
equal_height
bool default: True |
If True, makes every child element have equal height |
Guides
Column
with gradio.Column():Description
Column is a layout element within Blocks that renders all children vertically. The widths of columns can be set through the `scale` and `min_width` parameters. If a certain scale results in a column narrower than min_width, the min_width parameter will win.
Example Usage
with gr.Blocks() as demo:
with gr.Row():
with gr.Column(scale=1):
text1 = gr.Textbox()
text2 = gr.Textbox()
with gr.Column(scale=4):
btn1 = gr.Button("Button 1")
btn2 = gr.Button("Button 2")Initialization
| Parameter | Description |
|---|---|
scale
int default: 1 |
relative width compared to adjacent Columns. For example, if Column A has scale=2, and Column B has scale=1, A will be twice as wide as B. |
min_width
int default: 320 |
minimum pixel width of Column, will wrap if not sufficient screen space to satisfy this value. If a certain scale value results in a column narrower than min_width, the min_width parameter will be respected first. |
variant
Literal['default', 'panel', 'compact'] default: "default" |
column type, 'default' (no background), 'panel' (gray background color and rounded corners), or 'compact' (rounded corners and no internal gap). |
visible
bool default: True |
If False, column will be hidden. |
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. |
Guides
Group
with gradio.Group():Description
Group is a layout element within Blocks which groups together children so that they do not have any padding or margin between them.
Example Usage
with gr.Group():
gr.Textbox(label="First")
gr.Textbox(label="Last")Initialization
| Parameter | Description |
|---|---|
visible
bool default: True |
If False, group will be hidden. |
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. |
Tab
with gradio.Tab():Description
Tab (or its alias TabItem) is a layout element. Components defined within the Tab will be visible when this tab is selected tab.
Example Usage
with gr.Blocks() as demo:
with gr.Tab("Lion"):
gr.Image("lion.jpg")
gr.Button("New Lion")
with gr.Tab("Tiger"):
gr.Image("tiger.jpg")
gr.Button("New Tiger")Initialization
| Parameter | Description |
|---|---|
label
str required |
The visual label for the tab |
id
int | str | None default: None |
An optional identifier for the tab, required if you wish to control the selected tab from a predict function. |
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. |
Methods
select
gradio.Tab.select(fn, ···)Description
This listener is triggered when the user selects from within the Component. This event has EventData of type gradio.SelectData that carries information, accessible through SelectData.index and SelectData.value. See EventData documentation on how to use this event data.
Agruments
| Parameter | Description |
|---|---|
fn
Callable | None required |
the function to wrap an interface around. Often a machine learning model's prediction function. Each parameter of the function corresponds to one input component, and the function should return a single value or a tuple of values, with each element in the tuple corresponding to one output component. |
inputs
Component | list[Component] | set[Component] | None default: None |
List of gradio.components to use as inputs. If the function takes no inputs, this should be an empty list. |
outputs
Component | list[Component] | None default: None |
List of gradio.components to use as outputs. If the function returns no outputs, this should be an empty list. |
api_name
str | None | Literal[False] default: None |
Defines how the endpoint appears in the API docs. Can be a string, None, or False. If False, the endpoint will not be exposed in the api docs. If set to None, the endpoint will be exposed in the api docs as an unnamed endpoint, although this behavior will be changed in Gradio 4.0. If set to a string, the endpoint will be exposed in the api docs with the given name. |
status_tracker
None default: None |
|
scroll_to_output
bool default: False |
If True, will scroll to output component on completion |
show_progress
Literal['full', 'minimal', 'hidden'] default: "full" |
If True, will show progress animation while pending |
queue
bool | None default: None |
If True, will place the request on the queue, if the queue has been enabled. If False, will not put this event on the queue, even if the queue has been enabled. If None, will use the queue setting of the gradio app. |
batch
bool default: False |
If True, then the function should process a batch of inputs, meaning that it should accept a list of input values for each parameter. The lists should be of equal length (and be up to length `max_batch_size`). The function is then *required* to return a tuple of lists (even if there is only 1 output component), with each list in the tuple corresponding to one output component. |
max_batch_size
int default: 4 |
Maximum number of inputs to batch together if this is called from the queue (only relevant if batch=True) |
preprocess
bool default: True |
If False, will not run preprocessing of component data before running 'fn' (e.g. leaving it as a base64 string if this method is called with the `Image` component). |
postprocess
bool default: True |
If False, will not run postprocessing of component data before returning 'fn' output to the browser. |
cancels
dict[str, Any] | list[dict[str, Any]] | None default: None |
A list of other events to cancel when This listener is triggered. For example, setting cancels=[click_event] will cancel the click_event, where click_event is the return value of another components .click method. Functions that have not yet run (or generators that are iterating) will be cancelled, but functions that are currently running will be allowed to finish. |
every
float | None default: None |
Run this event 'every' number of seconds while the client connection is open. Interpreted in seconds. Queue must be enabled. |
Guides
Box
with gradio.Box():Description
Box is a a layout element which places children in a box with rounded corners and some padding around them.
Example Usage
with gr.Box():
gr.Textbox(label="First")
gr.Textbox(label="Last")Initialization
| Parameter | Description |
|---|---|
visible
bool default: True |
If False, box will be hidden. |
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. |
Accordion
gradio.Accordion(label, ···)Description
Accordion is a layout element which can be toggled to show/hide the contained content.
Example Usage
with gr.Accordion("See Details"):
gr.Markdown("lorem ipsum")Initialization
| Parameter | Description |
|---|---|
label
<class 'inspect._empty'> required |
name of accordion section. |
open
bool default: True |
if True, accordion is open by default. |
visible
bool default: True |
|
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. |