diff --git a/main/404.html b/main/404.html index 920af6a50a..b690be052c 100644 --- a/main/404.html +++ b/main/404.html @@ -25,7 +25,7 @@ teal - 0.14.0.9014 + 0.14.0.9015
part of NESTpharmaverse
+ + + + + +
+
+
+

Landing Popup Module

+ Source: R/landing_popup_module.R +
landing_popup_module.Rd
+
+ +
+

Creates a landing welcome popup for teal applications.

+

This module is used to display a popup dialog when the application starts. +The dialog blocks the access to the application and must be closed with a button before the application is viewed.

+
+ +
+

Usage

+ 
landing_popup_module(
+  label = "Landing Popup",
+  title = NULL,
+  content = NULL,
+  buttons = modalButton("Accept")
+)
+
+ +
+

Arguments

+
label
+

character(1) the label of the module.

+ + +
title
+

character(1) the text to be displayed as a title of the popup.

+ + +
content
+

The content of the popup. Passed to ... of shiny::modalDialog. Can be a character +or a list of shiny.tags. See examples.

+ + +
buttons
+

shiny.tag or a list of tags (tagList). Typically a modalButton or actionButton. See examples.

+ +
+
+

Value

+ + +

A teal_module (extended with teal_landing_module class) to be used in teal applications.

+
+ +
+

Examples

+ 
app1 <- teal::init(
+  data = teal.data::dataset("iris", iris),
+  modules = teal::modules(
+    teal::landing_popup_module(
+      content = "A place for the welcome message or a disclaimer statement.",
+      buttons = modalButton("Proceed")
+    ),
+    example_module()
+  )
+)
+#> [INFO] 2023-10-25 14:27:28.9447 pid:889 token:[] teal Initializing landing_popup_module
+#> module "Landing Popup" server function takes no data so "datanames" will be ignored
+if (interactive()) {
+  shinyApp(app1$ui, app1$server)
+}
+
+app2 <- teal::init(
+  data = teal.data::dataset("iris", iris),
+  modules = teal::modules(
+    teal::landing_popup_module(
+      title = "Welcome",
+      content = tags$b(
+        "A place for the welcome message or a disclaimer statement.",
+        style = "color: red;"
+      ),
+      buttons = tagList(
+        modalButton("Proceed"),
+        actionButton("read", "Read more",
+          onclick = "window.open('http://google.com', '_blank')"
+        ),
+        actionButton("close", "Reject", onclick = "window.close()")
+      )
+    ),
+    example_module()
+  )
+)
+#> [INFO] 2023-10-25 14:27:29.0210 pid:889 token:[] teal Initializing landing_popup_module
+#> module "Landing Popup" server function takes no data so "datanames" will be ignored
+
+if (interactive()) {
+  shinyApp(app2$ui, app2$server)
+}
+
+
+
+
+ + +
+ + + + + + + diff --git a/main/reference/matrix_to_mapping.html b/main/reference/matrix_to_mapping.html index 24bd5e40d0..c66290afae 100644 --- a/main/reference/matrix_to_mapping.html +++ b/main/reference/matrix_to_mapping.html @@ -16,7 +16,7 @@ teal - 0.14.0.9014 + 0.14.0.9015
part of NESTpharmaverse
+ + + + + +
+
+
+

Extract/Remove module(s) of specific class

+ Source: R/modules.R +
module_management.Rd
+
+ +
+

Given a teal_module or a teal_modules, return the elements of the structure according to class.

+
+ +
+

Usage

+ 
extract_module(modules, class)
+
+drop_module(modules, class)
+
+ +
+

Arguments

+
modules
+

teal_modules

+ + +
class
+

The class name of teal_module to be extracted or dropped.

+ +
+
+

Value

+ + +

For extract_module, a teal_module of class class or teal_modules containing modules of class class. +For drop_module, the opposite, which is all teal_modules of class other than class.

+ + +

teal_modules

+ + +
+ +
+ + +
+ + + + + + + diff --git a/main/reference/module_nested_tabs.html b/main/reference/module_nested_tabs.html index fa7e27d236..1e0a9c3433 100644 --- a/main/reference/module_nested_tabs.html +++ b/main/reference/module_nested_tabs.html @@ -10,7 +10,7 @@ teal - 0.14.0.9014 + 0.14.0.9015
part of NESTpharmaverse