ui.modal_remove
ui.modal_remove(session=None)
Remove a modal dialog box.
modal_remove provides a way to remove a modal programmatically. Modals can also be removed manually by the user if a modal_button is provided, or if the modal is created with easy_close=True
.
Parameters
session: Optional[
Session
] = None-
The Session instance that contains the modal to remove. If not provided, the session is inferred via get_current_session.
See Also
Examples
#| standalone: true
#| components: [editor, viewer]
#| layout: vertical
#| viewerHeight: 400
## file: app.py
from shiny import App, Inputs, Outputs, Session, reactive, ui
def run_model(delay=10.0):
import time
# Pretend to run a model for `delay` seconds
start_time = time.time()
while time.time() - start_time < delay:
pass
return time.time()
def the_modal():
return ui.modal(
"The model is running, please wait.",
title="Running model",
easy_close=False,
footer=None,
)
app_ui = ui.page_fluid(
ui.input_action_button("run", "Run Model"),
)
def server(input: Inputs, output: Outputs, session: Session):
model_result = reactive.value()
@reactive.effect
@reactive.event(input.run)
def do_run_model():
# Show the modal, blocking interaction with the UI
ui.modal_show(the_modal())
result = run_model(delay=4)
# Now that we have model results, remove the modal
# and update the model result reactive value
ui.modal_remove()
model_result.set(result)
app = App(app_ui, server)