gradio_banner

A banner component for displaying important information, alerts, notifications, and types of messages within a Gradio Blocks.

Installation

pip install gradio_banner

Usage

import gradio as gr
from gradio_banner import Banner

with gr.Blocks() as demo:
    with gr.Row():
        Banner(value="Large info banner *with* **markdown** `value`", variant="info")
    with gr.Row():
        Banner(variant="success", size="sm")
    with gr.Row():
        Banner(value="Large warning banner with default label and specified value", variant="warning")
    with gr.Row():
        Banner(variant="error", show_close_button=True)
    with gr.Row():
        with gr.Column():
            with gr.Row():
                Banner(value="Small info banner with close button and without label", size="sm", show_close_button=True, show_label=False)
            with gr.Row():
                Banner(label="Custom label and icon", value="Large info banner with custom icon", icon="https://i.pinimg.com/originals/e9/ab/30/e9ab30fdcadf40bdc095a1e317f3851c.gif")
        with gr.Column():
            Banner(value="Large success banner with specified value", variant="success")

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

Initialization

str | Callable | None

str

str | None

str | None

Literal["sm", "lg"] | None

bool

bool

Timer | float | None

Component | list[Component] | set[Component] | None

bool | None

int | None

int

bool

bool

str | None

list[str] | str | None

bool

int | str | None

Events

User function

The impact on the users predict function varies depending on whether the component is used as an input or output for an event (or both).

• When used as an Input, the component only impacts the input signature of the user function.
• When used as an output, the component only impacts the return signature of the user function.

The code snippet below is accurate in cases where the component is used as both an input and an output.

• As output: Is passed, passes text value as a {str} into the function.
• As input: Should return, expects a {str} returned from function and sets textarea value to it.

def predict(
    value: str | None
) -> str | None:
    return value