| Title: | Bootstrap Landing Home Pages for Shiny Applications |
|---|---|
| Description: | Provides functions that wrap HTML Bootstrap components code to enable the design and layout of informative landing home pages for Shiny applications. This can lead to a better user experience for the users and writing less HTML for the developer. |
| Authors: | Jasmine Daly [aut, cre] |
| Maintainer: | Jasmine Daly <[email protected]> |
| License: | MIT + file LICENSE |
| Version: | 1.1.3 |
| Built: | 2025-03-04 04:39:52 UTC |
| Source: | https://github.com/jasdumas/shinylp |
Add an iframe An iframe can contain a video for additional instructions within a Modal object
iframe(width, height, url_link)iframe(width, height, url_link)
width |
a object of class character |
height |
a object of class character |
url_link |
a object of class character, indicating content to display |
a HTML object to be included in the ui section of a shiny app
iframe(width = "560", height = "315", url_link = "https://www.youtube.com/embed/0fKg7e37bQE")iframe(width = "560", height = "315", url_link = "https://www.youtube.com/embed/0fKg7e37bQE")
Add a Jumbotron to showcase key content
jumbotron(header, content, button = TRUE, ...)jumbotron(header, content, button = TRUE, ...)
header |
a object of class character, indicating header title |
content |
a object of class character, indicating text content |
button |
a object of class logical, to include a button or not |
... |
optional parameters for including a button label if needed |
a HTML object to be included in the ui section of a shiny app
jumbotron("Hi Shiny!", "text to show", buttonLabel = "Click Me")jumbotron("Hi Shiny!", "text to show", buttonLabel = "Click Me")
Add a Single List Group Component A flexible method for displaying simple list elements as a group.
list_group(list_items)list_group(list_items)
list_items |
a vector of content generated from the list_item function |
a HTML object to be included in the ui section of a shiny app
list_group(list_item("Howdy Title", badge_value = 27))list_group(list_item("Howdy Title", badge_value = 27))
Add a Single List Item Component A flexible method for displaying simple list elements.
list_item(content, badge = TRUE, badge_value)list_item(content, badge = TRUE, badge_value)
content |
a object of class character |
badge |
a object of class logical |
badge_value |
if the badge object is true provide an arguement object of class numeric, named badge_value. |
a HTML object to be included in the ui section of a shiny app
list_item("Howdy Title", badge_value = 27)list_item("Howdy Title", badge_value = 27)
Add Panel Sections with Color Headers Panel sections can be grouped by color or context to structure the landing page.
panel_div(class_type, panel_title, content)panel_div(class_type, panel_title, content)
class_type |
a object of class character, indicating the contextual state class |
panel_title |
a object of class character, indicating the header title |
content |
a object of class character, indicating text content |
a HTML object to be included in the ui section of a shiny app
panel_div(class_type = "primary", panel_title = "Directions", content = "How to use the app")panel_div(class_type = "primary", panel_title = "Directions", content = "How to use the app")
Run The Example Shiny App
runExample(display.mode = "showcase")runExample(display.mode = "showcase")
display.mode |
The mode in which to display the example. |
Nothing is returned except a shiny app launched locally displaying example layouts using the shinyLP package functions and examples from the shinyBS package.
## Not run: runExample()## Not run: runExample()
Provides additional Bootstrap web framework components to enahance the user expereince and interface for shiny applications. shinyLP makes it easier for R developers to include advanced HTML components without the need for writing HTML. Landing home pages are meant to be a informative introduction to the application, its features and how the user can best use the tool.
'iframe()', 'list_group()', 'list_item()', 'wells()' 'jumbotron()', 'panel_div()', and 'thumbnail_label()'. Run the example shiny app with shinyLP::runExample().
Add a custom thumbnail with a label and button
thumbnail_label(image, label, content, button_link, button_label)thumbnail_label(image, label, content, button_link, button_label)
image |
a object of class character |
label |
a object of class character |
content |
a object of class character |
button_link |
a object of class character |
button_label |
a object of class character |
a HTML object to be included in the ui section of a shiny app
thumbnail_label(image = 'Rlogo.png', label = 'App 1', content = 'here we go again', button_link = 'http://getbootstrap.com/', button_label = 'Click me')thumbnail_label(image = 'Rlogo.png', label = 'App 1', content = 'here we go again', button_link = 'http://getbootstrap.com/', button_label = 'Click me')
Add a Well Component Use the well as a simple effect on an element to give it an inset effect.
wells(content, size = "default")wells(content, size = "default")
content |
a object of class character |
size |
a object of class character determining the size of the well and options include, default, small, and large. |
a HTML object to be included in the ui section of a shiny app
wells(content = "Look, I'm a well!", size = "large")wells(content = "Look, I'm a well!", size = "large")