metadata

tags:
  - gradio-custom-component
  - gradio-template-Column
  - Modal
  - Popup
title: gradio_modal V0.0.3
colorFrom: red
colorTo: gray
sdk: docker
pinned: false
license: apache-2.0

`gradio_modal`

A popup modal component

Installation

pip install gradio_modal

Usage

import gradio as gr
from gradio_modal import Modal

with gr.Blocks() as demo:
    with gr.Tab("Tab 1"):
        text_1 = gr.Textbox(label="Input 1")
        text_2 = gr.Textbox(label="Input 2")
        text_1.submit(lambda x:x, text_1, text_2)
        show_btn = gr.Button("Show Modal")
        show_btn2 = gr.Button("Show Modal 2")
        gr.Examples(
            [["Text 1", "Text 2"], ["Text 3", "Text 4"]],
            inputs=[text_1, text_2],
        )
    with gr.Tab("Tab 2"):
        gr.Markdown("This is tab 2")
    with Modal(visible=False) as modal:
        for i in range(5):
            gr.Markdown("Hello world!")
    with Modal(visible=False) as modal2:
        for i in range(100):
            gr.Markdown("Hello world!")
    show_btn.click(lambda: Modal(visible=True), None, modal)
    show_btn2.click(lambda: Modal(visible=True), None, modal2)

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

`Modal`

Initialization

name	type	default	description
`visible`	`bool`	`False`	If False, modal will be hidden.
`elem_id`	`str \| None`	`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`	`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.
`allow_user_close`	`bool`	`True`	If True, user can close the modal (by clicking outside, clicking the X, or the escape key).
`render`	`bool`	`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.

Events

name	description
`blur`	This listener is triggered when the Modal is unfocused/blurred.