A popup modal component
## Installation
```bash
pip install gradio_modal
```
## Usage
```python
import gradio as gr
from gradio_modal import Modal
with gr.Blocks() as demo:
gr.Markdown("### Main Page")
gr.Textbox("lorem ipsum " * 1000, lines=10)
with Modal(visible=True) as modal:
gr.Markdown("# License Agreement")
gr.Textbox(value="This is the license agreement. Please read it carefully. " * 5, lines=12)
close_btn = gr.Button("Close Modal")
close_btn.click(lambda: Modal(visible=False), None, modal)
show_btn = gr.Button("Show Modal")
show_btn.click(lambda: Modal(visible=True), None, modal)
if __name__ == "__main__":
demo.launch()
```
## `Modal`
### Initialization
| name | type | default | description |
|---|---|---|---|
visible |
```python bool ``` | False |
If False, column will be hidden. |
elem_id |
```python 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 |
```python 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 |
```python bool ``` | True |
If True, user can close the modal (by clicking outside, clicking the X, or the escape key). |
render |
```python 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. |