Gradio Agents & MCP Hackathon

Winners
Gradio logo
  1. Components
  2. Navbar

New to Gradio? Start here: Getting Started

See the Release History

←

MultimodalTextbox

Number

β†’

Navbar

gradio.Navbar(Β·Β·Β·)

Description

Creates a navigation bar component for multipage Gradio apps. The navbar component allows customizing the appearance of the navbar for that page. Only one Navbar component can exist per page in a Blocks app, and it can be placed anywhere within the page.
The Navbar component is designed to control the appearance of the navigation bar in multipage applications. When present in a Blocks app, its properties override the default navbar behavior.

Behavior

As input component: The preprocessed input data sent to the user's function in the backend.

Your function should accept one of these types:
def predict(
	value: list[tuple[str, str]] | None
)
	...

As output component: The output data received by the component from the user's function in the backend.

Your function should return one of these types:
def predict(Β·Β·Β·) -> list[tuple[str, str]] | None
	...	
	return value

Initialization

Parameters
πŸ”— 
value: list[tuple[str, str]] | None
default = None

If a list of tuples of (page_name, page_path) are provided, these additional pages will be added to the navbar alongside the existing pages defined in the Blocks app. The page_path can be either a relative path for internal Gradio app pages (e.g., "analytics") or an absolute URL for external links (e.g., "https://twitter.com/username"). Otherwise, only the pages defined using the `Blocks.route` method will be displayed. Example: [("Dashboard", "dashboard"), ("About", "https://twitter.com/abidlabs")]

πŸ”— 
visible: bool
default = True

If True, the navbar will be visible. If False, the navbar will be hidden.

πŸ”— 
main_page_name: str | Literal[False]
default = "Home"

The title to display in the navbar for the main page of the Gradio. If False, the main page will not be displayed in the navbar.

πŸ”— 
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.

Shortcuts

Class Interface String Shortcut Initialization

gradio.Navbar

"navbar"

 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 Navbar component supports the following event listeners. Each event listener takes the same parameters, which are listed in the Event Parameters table below.

Listener Description

Navbar.change(fn, Β·Β·Β·)

Triggered when the value of the Navbar changes either because of user input (e.g. a user types in a textbox) OR because of a function update (e.g. an image receives a value from the output of an event trigger). See .input() for a listener that is only triggered by user input.

Event Parameters

Parameters
πŸ”— 
fn: Callable | None | Literal['decorator']
default = "decorator"

the function to call when this event is triggered. 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 | BlockContext | list[Component | BlockContext] | Set[Component | BlockContext] | 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 | BlockContext | list[Component | BlockContext] | Set[Component | BlockContext] | 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 set to a string, the endpoint will be exposed in the API docs with the given name. If None (default), the name of the function will be used as the API endpoint. If False, the endpoint will not be exposed in the API docs and downstream apps (including those that `gr.load` this app) will not be able to use this event.

πŸ”— 
api_description: str | None | Literal[False]
default = None

Description of the API endpoint. Can be a string, None, or False. If set to a string, the endpoint will be exposed in the API docs with the given description. If None, the function's docstring will be used as the API endpoint description. If False, then no description will be displayed in the API docs.

πŸ”— 
scroll_to_output: bool
default = False

If True, will scroll to output component on completion

πŸ”— 
show_progress: Literal['full', 'minimal', 'hidden']
default = "full"

how to show the progress animation while event is running: "full" shows a spinner which covers the output component area as well as a runtime display in the upper right corner, "minimal" only shows the runtime display, "hidden" shows no progress animation at all

πŸ”— 
show_progress_on: Component | list[Component] | None
default = None

Component or list of components to show the progress animation on. If None, will show the progress animation on all of the output components.

πŸ”— 
queue: bool
default = True

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.

πŸ”— 
trigger_mode: Literal['once', 'multiple', 'always_last'] | None
default = None

If "once" (default for all events except `.change()`) would not allow any submissions while an event is pending. If set to "multiple", unlimited submissions are allowed while pending, and "always_last" (default for `.change()` and `.key_up()` events) would allow a second submission after the pending event is complete.

πŸ”— 
js: str | Literal[True] | None
default = None

Optional frontend js method to run before running 'fn'. Input arguments for js method are values of 'inputs' and 'outputs', return should be a list of values for output components.

πŸ”— 
concurrency_limit: int | None | Literal['default']
default = "default"

If set, this is the maximum number of this event that can be running simultaneously. Can be set to None to mean no concurrency_limit (any number of this event can be running simultaneously). Set to "default" to use the default concurrency limit (defined by the `default_concurrency_limit` parameter in `Blocks.queue()`, which itself is 1 by default).

πŸ”— 
concurrency_id: str | None
default = None

If set, this is the id of the concurrency group. Events with the same concurrency_id will be limited by the lowest set concurrency_limit.

πŸ”— 
show_api: bool
default = True

whether to show this event in the "view API" page of the Gradio app, or in the ".view_api()" method of the Gradio clients. Unlike setting api_name to False, setting show_api to False will still allow downstream apps as well as the Clients to use this event. If fn is None, show_api will automatically be set to False.

πŸ”— 
time_limit: int | None
default = None
πŸ”— 
stream_every: float
default = 0.5
πŸ”— 
like_user_message: bool
default = False
πŸ”— 
key: int | str | tuple[int | str, ...] | None
default = None

A unique key for this event listener to be used in @gr.render(). If set, this value identifies an event as identical across re-renders when the key is identical.

πŸ”— 
validator: Callable | None
default = None

Optional validation function to run before the main function. If provided, this function will be executed first with queue=False, and only if it completes successfully will the main function be called. The validator receives the same inputs as the main function and should return a `gr.validate()` for each input value.

←

MultimodalTextbox

Number

β†’