gradio_topbar

A TopBar for Gradio Interface

TopBar Demo

This demo shows the TopBar with width="50%" and bring_to_front=True. Notice how the bar is now horizontally centered and no longer full-width.

{}

🤖 Chat Interface

Installation

pip install gradio_topbar

Usage

# demo/app.py

import gradio as gr
import time
from gradio_topbar import TopBar

def chat_response(message, history):
    history = history or ""
    history += f"You: {message}
"
    time.sleep(1) # Simulate thinking
    history += f"Bot: Thanks for the message! You said: '{message}'
"
    return history, ""

def update_label(value):
    return f"Current temperature is: {value}"

with gr.Blocks(theme=gr.themes.Ocean(), title="Full Layout Demo") as demo:
    gr.Markdown(
        """
        # TopBar Demo
        This demo shows the `TopBar` with `width="50%"` and `bring_to_front=True`.
        Notice how the bar is now horizontally centered and no longer full-width.
        """
    )

    with TopBar(open=True, height=180, width="50%", bring_to_front=True, rounded_borders=True):
        with gr.Row():
            message_box = gr.Textbox(
                show_label=False,
                placeholder="Type your message here...",
                elem_id="message-input",
                scale=7
            )
            send_button = gr.Button("Send", variant="primary", scale=1)
        with gr.Row():
            gr.Button("Upload File")
            gr.Button("Record Audio")
            gr.ClearButton([message_box])

    with gr.Row(equal_height=True):
        with gr.Column(scale=3):
            gr.Markdown("### 🤖 Chat Interface")
            chatbot_display = gr.Textbox(
                label="Chat History",
                lines=25,
                interactive=False
            )

    send_button.click(
        fn=chat_response,
        inputs=[message_box, chatbot_display],
        outputs=[chatbot_display, message_box]
    )
    message_box.submit(
        fn=chat_response,
        inputs=[message_box, chatbot_display],
        outputs=[chatbot_display, message_box]
    )

if __name__ == "__main__":
    demo.launch(debug=True)

TopBar

Initialization

Parameters
label: str | gradio.i18n.I18nData | None
default = None

name of the top bar. Not displayed to the user.

open: bool
default = True

if True, top bar is open by default.

visible: bool
default = True

If False, the component 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.

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

An optional string or list of strings that are assigned as the class of this component in the HTML DOM. Can be used for targeting CSS styles.

render: bool
default = True

If False, this layout will not be rendered in the Blocks context. Should be used if the intention is to assign event listeners now but render the component later.

height: int | str
default = 320

The height of the top bar, specified in pixels if a number is passed, or in CSS units if a string is passed.

width: int | str
default = "100%"

The width of the top bar, specified in pixels if a number is passed, or in CSS units (like "80%") if a string is passed. The bar will be horizontally centered.

bring_to_front: bool
default = False

If True, the TopBar will be rendered on top of all other elements with a higher z-index. Defaults to False.

rounded_borders: bool
default = False

If True, applies rounded borders to the bottom edges of the TopBar panel.

key: int | str | tuple[int | str, Ellipsis] | 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 = None

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.

Events

Parameters
expand

This listener is triggered when the TopBar is expanded.

collapse

This listener is triggered when the TopBar is collapsed.