Skip to contents

Start a modal screen pause.

Usage

FM_pause_screen(state, session, message)

Arguments

state

Current module state after yaml file has been read.

session

Shiny session variable.

message

Optional message for the pause.

Value

Pauses the screen and has no return value.

Examples

# We need a module state object and Shiny session objects to use this function:
sess_res = UD_test_mksession(session=list())
#> → UD: including file
#> → UD:   source: file.path(system.file(package="onbrand"), "templates", "report.docx")
#> → UD:   dest:   file.path("config","report.docx")
#> → UD: including file
#> → UD:   source: file.path(system.file(package="onbrand"), "templates", "report.pptx")
#> → UD:   dest:   file.path("config","report.pptx")
#> → UD: including file
#> → UD:   source: file.path(system.file(package="onbrand"), "templates", "report.yaml")
#> → UD:   dest:   file.path("config","report.yaml")
#> → UD: State initialized
#> → UD: module checksum updated:897d952fecbc804999396a96f9df4b20
session = sess_res$session
state = sess_res$state
FM_pause_screen(state, session)
#> NULL
FM_resume_screen(state, session)
#> NULL