| Type: | Package |
| Title: | Bootstrap Landing Home Pages for Shiny Applications |
| Version: | 1.1.3 |
| Maintainer: | Jasmine Daly <jasmine.dumas@gmail.com> |
| 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. |
| URL: | https://github.com/jasdumas/shinyLP |
| Depends: | R (≥ 3.1.2) |
| Imports: | shiny |
| License: | MIT + file LICENSE |
| Encoding: | UTF-8 |
| RoxygenNote: | 7.2.3 |
| Suggests: | testthat |
| NeedsCompilation: | no |
| Packaged: | 2023-10-25 16:24:28 UTC; jasminedumas |
| Author: | Jasmine Daly [aut, cre] |
| Repository: | CRAN |
| Date/Publication: | 2023-10-25 22:00:02 UTC |
Add an iframe An iframe can contain a video for additional instructions within a Modal object
Description
Add an iframe An iframe can contain a video for additional instructions within a Modal object
Usage
iframe(width, height, url_link)
Arguments
width |
a object of class character |
height |
a object of class character |
url_link |
a object of class character, indicating content to display |
Value
a HTML object to be included in the ui section of a shiny app
See Also
Examples
iframe(width = "560", height = "315",
url_link = "https://www.youtube.com/embed/0fKg7e37bQE")
Add a Jumbotron to showcase key content
Description
Add a Jumbotron to showcase key content
Usage
jumbotron(header, content, button = TRUE, ...)
Arguments
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 |
Value
a HTML object to be included in the ui section of a shiny app
See Also
Examples
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.
Description
Add a Single List Group Component A flexible method for displaying simple list elements as a group.
Usage
list_group(list_items)
Arguments
list_items |
a vector of content generated from the list_item function |
Value
a HTML object to be included in the ui section of a shiny app
See Also
Examples
list_group(list_item("Howdy Title", badge_value = 27))
Add a Single List Item Component A flexible method for displaying simple list elements.
Description
Add a Single List Item Component A flexible method for displaying simple list elements.
Usage
list_item(content, badge = TRUE, badge_value)
Arguments
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. |
Value
a HTML object to be included in the ui section of a shiny app
See Also
Examples
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.
Description
Add Panel Sections with Color Headers Panel sections can be grouped by color or context to structure the landing page.
Usage
panel_div(class_type, panel_title, content)
Arguments
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 |
Value
a HTML object to be included in the ui section of a shiny app
See Also
Examples
panel_div(class_type = "primary", panel_title = "Directions",
content = "How to use the app")
Run The Example Shiny App
Description
Run The Example Shiny App
Usage
runExample(display.mode = "showcase")
Arguments
display.mode |
The mode in which to display the example. |
Value
Nothing is returned except a shiny app launched locally displaying example layouts using the shinyLP package functions and examples from the shinyBS package.
Examples
## Not run: runExample()
A R package To Add Bootstrap Components to Shiny Applications for Landing Home Pages.
Description
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.
This package has functions for
'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
Description
Add a custom thumbnail with a label and button
Usage
thumbnail_label(image, label, content, button_link, button_label)
Arguments
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 |
Value
a HTML object to be included in the ui section of a shiny app
See Also
Examples
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.
Description
Add a Well Component Use the well as a simple effect on an element to give it an inset effect.
Usage
wells(content, size = "default")
Arguments
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. |
Value
a HTML object to be included in the ui section of a shiny app
See Also
Examples
wells(content = "Look, I'm a well!", size = "large")