Generate an accordion

Description

Wrap one or more accordion items into a container

Usage

accordion(..., id, style = c("default", "1", "2", "3", "4"), uncollapsed = 1)

Arguments

Value

HTML of a container with a class called accordion

Examples

if (interactive()) {
  library(shiny)
  library(nextGenShinyApps)

  shiny::shinyApp(
    ui = fluidPage(
      style = "8",
      custom.bg.color = "white",
      sidebar = NULL,
      header = NULL,
      accordion(
        id = "accordion5",
        style = "2",
        accordionItem(
          title = "Accordion 1",
          icon = shiny::icon("edit"),
          "Massa sed elementum sus"
        ),
        accordionItem(
          title = "Accordion 2",
          icon = shiny::icon("cog"),
          "Auctor neque etiam non."
        )
      )
    ),
    server = function(input, output) {
    }
  )
}

Generate an accordion item

Description

Embed an accordion item within an accordion

Usage

accordionItem(
  ...,
  title = "A title",
  status = c("default", "primary", "secondary", "info", "success", "danger", "warning"),
  icon = NULL
)

Arguments

Value

A list of properties for an accordion item

Examples

if (interactive()) {
accordionItem(
  title = "Accordion 2",
  icon = shiny::icon("cog"),
  "Auctor neque etiam non."
)
}

Create a button

Description

Upgrade to the actionButton in 'Shiny' package

Usage

actionButton(
  inputId,
  label,
  icon = NULL,
  width = NULL,
  ...,
  size = c("m", "xs", "s", "l", "xl"),
  style = c("default", "pill", "round", "clean"),
  bg.type = c("default", "primary", "secondary", "info", "success", "danger", "warning"),
  outline = FALSE
)

Arguments

Value

HTML of the buttons to insert into a page

Examples

if (interactive()) {
shiny::div(actionButton("button",
  "Action button with primary color",
  icon = shiny::icon("folder"), bg.type = "primary"
))
shiny::div(actionButton("button",
  "Action button with primary color",
  icon = shiny::icon("file"),
  bg.type = "danger", outline = TRUE
))
}

Create an alert

Description

Create an alert with various styles

Usage

alert(
  ...,
  type = c("default", "standard"),
  close = FALSE,
  color = c("none", "primary", "secondary", "info", "success", "danger", "warning"),
  outline = FALSE,
  icon = NULL
)

Arguments

Value

HTML of an alert box to be inserted within a page

Examples

if (interactive()) {
card(
  header = FALSE,
  shiny::h2("Standard alert (closeable)"),
  alert("EX1", type = "standard",
  color = "primary"),
  alert("EX2", type = "standard",
  color = "secondary"),
  alert("EX3", type = "standard",
  color = "secondary", outline = TRUE),
  alert("EX4", type = "standard",
  color = "danger", outline = TRUE, close = TRUE),
  alert("EX5", type = "standard",
  close = TRUE),
  alert("EX6", type = "standard",
  color = "primary", icon = shiny::icon("info"))
)
}

New sidebar panel to display content

Description

Customizable sidebar panel for inclusion of various UI elements

Usage

altPanel(..., width = 4, border = FALSE, shadow = FALSE)

Arguments

Value

Creates an alternate container for displaying contents

Note

For more information on the features of the sidebar panel, look through the Github examples

Examples

 altPanel('content 2')
 

Flexible and extensible content container

Description

Widely used Bootstrap feature with improvements to allow collapse, minimize and closing

Usage

card(
  ...,
  title = "Standard Card",
  collapsed = FALSE,
  bg.fade = TRUE,
  width = 12,
  alert.text = NULL,
  alert.bg = c("primary", "warning", "secondary", "info", "success", "danger"),
  toolbar = NULL,
  header = TRUE,
  draggable = TRUE,
  id = NULL
)

Arguments

Value

HTML code of the container with a class called card that holds the items

Note

For more information on the features of the card, visit the examples section of the help documentation

Examples

if (interactive()) {
 card(
   title = "Standard card",
   collapsed = TRUE,
   alert.text = "An alert for the content",
   alert.bg = "warning",
   toolbar = list(collapse = TRUE,
   maximize = TRUE, close = FALSE, menu = TRUE),
   shiny::h3("Sample text"),
   "Lorem www.pharmacometric.com"
 )
 }

Create an advanced checkbox input

Description

Modifications to checkboxinput to allow added styles

Usage

checkboxInput(inputId, label, value = FALSE, width = NULL, inline = FALSE)

Arguments

Value

HTML elements of a checkbox

Note

For more information on the features of the form, visit the examples section of the help documentation

Examples

        checkboxInput("somevalue", "Some value", FALSE)
        checkboxInput("somevalue", "Some value", value = FALSE, inline = TRUE)
        checkboxInput("somevalue", "Some value", FALSE)

Include stylesheets and scripts

Description

Use the package scripts and stylesheets in a page

Usage

cssjsinclude(template, color)

Arguments

Value

A list of files to be inserted in the header of a page

Examples

cssjsinclude('color','3')

Create the body section of the application

Description

Create a simple body containing a header and a content for the main body

Usage

dashboardBody(header, ...)

Arguments

Value

An HTML of the body of the page

Note

Endeavor to use as standalone and not within the fluidPage, as this function it already called within fluidPage

Examples

if (interactive()) {
dashboardBody(
  header = titlePanel(
    left = "Sample nextGenShinyApps Title",
    right = shiny::icon("user")
  ),
  "obi's preferred main body"
)
}

Generate a container for the application

Description

An upgrade to the fluidPage function available in the 'Shiny' package

Usage

fluidPage(
  ...,
  id = NULL,
  header = NULL,
  sidebar = NULL,
  class = NULL,
  style = rand.sc13,
  custom.bg.color = NULL,
  modal.header.links = NULL
)

Arguments

Value

A rendered HTML of the container holder of the application items

Note

This global layout can be applied to a variety of shiny app and dashboard, with or without a sidebar. See the example below.

Examples

if (interactive()) {
  library(shiny)
  library(nextGenShinyApps)

  shiny::shinyApp(
    ui = fluidPage(
      style = "6",
      header = titlePanel(left = "Sample App Title",
      right = "Image/logo"),
      sidebar = sidebarPanel(
        title = "myApp",
        "Sample sidebar content"
      ),
      "Sample body content"
    ),
    server = function(input, output) {}
  )
}

Load examples for the package

Description

Example shiny applications spanning aspects of the package

Usage

load.example(
  example = c("Plain", "noSideBar", "Plotly", "Rhansometable", "Card", "Tab", "Modal",
    "Form", "Button", "Spinner", "Alert", "Accordion")
)

Arguments

Value

A rendered HTML of the user specified example file

Options for example

"Plain", "noSideBar","Plotly","Rhansometable", "Card", "Tab", "Modal", "Form", "Button", "Spinner", "Alert", "Accordion"

Examples

if (interactive()) {
load.example(example = "Card")
}

Main panel to display content

Description

Customizable main panel for inclusion of various UI elements

Usage

mainPanel(..., width = 8, border = FALSE, shadow = FALSE)

Arguments

Value

Creates a container for displaying contents

Note

For more information on the features of the main panel, look through the Github examples

Examples

 mainPanel('content 1')
 

Create a master button

Description

A master button creator

Usage

masterButton(
  inputId,
  text = "Text",
  icon = NULL,
  width = NULL,
  size = c("m", "xs", "s", "l", "xl"),
  style = c("default", "pill", "round", "clean"),
  bg.type = c("default", "primary", "secondary", "info", "success", "danger", "warning"),
  outline = FALSE,
  extraClass = NULL,
  ...
)

Arguments

Value

HTML of the buttons to insert into a page

Examples

if (interactive()) {
card(
  shiny::h2("Master buttons with various styles"),
  header = FALSE,
  shiny::div(masterButton("Submit button with primary color",
    icon = shiny::icon("file"), size = "s", bg.type = "primary"
  ))
)
}

Create hyperlink modal section that appears ONLY when the sidebar logo is clicked

Description

Additional tab section for additional links

Usage

modal.header(...)

Arguments

Value

An HTML containing elements of links to be inserted in the header of a page

Examples

if (interactive()) {
list1 <- list(
  title = "Home", icon = shiny::icon("home"),
  link = "https://google.com"
)
list2 <- list(
  title = "Docs", icon = shiny::icon("folder"),
  link = "https://obi.obianom.com"
)

modal.header(list(list1, list2))
}

Generate a modal box

Description

Advanced modal dialog that allows various positioning and transparency

Usage

modalDialog(
  ...,
  title = NULL,
  footer = modalButton("Dismiss"),
  size = c("m", "s", "l", "xl"),
  easyClose = FALSE,
  fade = TRUE,
  position = c("centered", "left", "right", "top", "bottom"),
  transparent = FALSE
)

Arguments

Value

An HTML containing elements of a modal box that remains hidden until a button is clicked

Note

For more information on the features of the card, visit the examples section of the help documentation

Examples

if (interactive()) {
  library(shiny)
  library(nextGenShinyApps)
  shiny::shinyApp(
    ui = fluidPage(
      style = "8",
      custom.bg.color = "white",
      sidebar = NULL,
      header = NULL,
      shiny::h3("Modal EXAMPLES"),
      shiny::div(actionButton("obianom1", "Show BIG shiny modal on the RIGHT")),
      shiny::br(),
      shiny::div(actionButton("obianom2", "Show SMALL shiny modal on the RIGHT"))
    ),
    server = function(input, output) {
      shiny::observeEvent(input$obianom1, {
        shiny::showModal(modalDialog(
          textInput("dataset", "Enter a data set"),
          shiny::div("Id leo in vitae"),
          size = "l",
          position = "bottom",
        ))
      })
      shiny::observeEvent(input$obianom2, {
        shiny::showModal(modalDialog(
          textInput("dataset", "Enter a data set"),
          shiny::div("Lorem donec massa"),
          size = "l",
          position = "right",
        ))
      })
    }
  )
}

Nav tag

Description

A nav tag for creating HTML navigations

Usage

nav(class, id = NULL, role = NULL, ...)

Arguments

Value

HTML content of a container with type nav

Examples

nav('sample','id1','sample','some content')

Random number betwen 1 and 10000

Description

One or more random numbers

Usage

rand.num(num)

Arguments

Value

One or more numbers

Examples

rand.num(10)

Generate a row div

Description

A simple row div

Usage

row(...)

Arguments

Value

An HTML containing elements of a container with class row to be embedded in a page

Examples

row(shiny::div(width=12,"Hello nextGenShinyApps"))

Generate toolbar buttons

Description

Use within a card to display toolbar

Usage

setup.toolbar.buttons(...)

Arguments

Value

HTML code of a container containing items to be inserted in the toolbar

Note

For more information on the features of a toolbar within a card, visit the examples section of the help documentation

Examples

 setup.toolbar.buttons(list(maximize=TRUE,collapse=TRUE,close=TRUE))
 

Generate toolbar menu

Description

Use within a card to display menu

Usage

setup.toolbar.menu(...)

Arguments

Value

HTML code of a container containing menu to be inserted in the toolbar if declared TRUE

Note

For more information on the features of a toolbar within a card, visit the examples section of the help documentation

Examples

 setup.toolbar.menu(list(menu=TRUE))
 

Sidebar layout

Description

Container for sidebar, optional

Usage

sidebarLayout(...)

Arguments

Value

An HTML containing elements in a container

Examples

sidebarLayout("sample text")

Create the sidebar panel

Description

Creates an advanced sidebar panel with colors corresponding to a chosen theme style

Usage

sidebarPanel(..., title = "TitleApp", footer = FALSE)

Arguments

Value

An HTML containing elements of a sidebar to be embedded in a page

Note

This global layout can be applied to a variety of shiny app and dashboard, with or without a sidebar. See the example below.

Examples

if (interactive()) {
  library(shiny)
  library(nextGenShinyApps)

  shiny::shinyApp(
    ui = fluidPage(
      style = "7",
      header = NULL,
      sidebar = sidebarPanel(
        title = "myApp",
        "Sample sidebar contents",
        footer = FALSE
      ),
      "Plain content"
    ),
    server = function(input, output) {}
  )
}

Generate a sortable grid

Description

A grid that holds draggable items

Usage

sortablegrid(..., width = 6, id = NULL)

Arguments

Value

HTML code of a container that allows items within it to be draggable

Note

For more information on the features of a sortable grid, visit the examples section of the help documentation

Examples

 sortablegrid("item1",width=12)

Create a spinner

Description

Create a loading spinner for customization of outputs

Usage

spinner(
  type = c("ring", "grow", "square", "rect"),
  size = c("l", "s"),
  color = c("default", "primary", "secondary", "info", "success", "danger", "warning")
)

Arguments

Value

An HTML containing elements of a spinner to be embedded in a page during loading

Examples

if (interactive()) {
  library(shiny)
  library(nextGenShinyApps)

  shiny::shinyApp(
    ui = fluidPage(
      style = "3",
      custom.bg.color = "cyan",
      sidebar = NULL,
      header = NULL,
      card(
        header = FALSE,
        shiny::h2("loading spinner"),
        spinner(type = "rect", size = "s"),
        spinner(type = "rect", color = "primary"),
        spinner(type = "grow", color = "secondary"),
        spinner(type = "ring", color = "success"),
        spinner(type = "rect", color = "warning"),
        spinner(type = "square", color = "danger"),
        spinner(type = "rect", color = "info")
      )
    ),
    server = function(input, output) {
    }
  )
}

Create a submit button

Description

Upgrade to the submitButton in 'Shiny' package

Usage

submitButton(
  inputId,
  text = "Apply Changes",
  icon = NULL,
  width = NULL,
  size = c("m", "xs", "s", "l", "xl"),
  style = c("default", "pill", "round", "clean"),
  bg.type = c("default", "primary", "secondary", "info", "success", "danger", "warning"),
  outline = FALSE
)

Arguments

Value

HTML of the submit buttons to insert into a page

Examples

if (interactive()) {
card(
  shiny::h2("Submit buttons with various styles"),
  header = FALSE,
  shiny::div(submitButton("Submit button with primary color",
    icon = shiny::icon("file"), size = "s", bg.type = "primary"
  )),
  shiny::div(submitButton("Secondary color",
    icon = shiny::icon("folder"), bg.type = "secondary"
  )),
  shiny::div(submitButton("Success color",
    icon = shiny::icon("filter"), bg.type = "success"
  )),
  shiny::div(submitButton("Warning color",
    icon = shiny::icon("grid"), bg.type = "warning"
  )),
  shiny::div(submitButton("Danger color",
    icon = shiny::icon("check"), bg.type = "danger"
  )),
  shiny::div(submitButton("Info color",
    icon = shiny::icon("trash"), bg.type = "info"
  ))
)
}

Create a tab panel item

Description

Create a tab panel item that is enclosed by a tabsetPanel

Usage

tabPanel(title, ...)

Arguments

Value

An list containing the title and content of a tab

Examples

if (interactive()) {
tabPanel("Summary", "Convallis aesus.")
tabPanel("Summary", "nextGenShinyAppss.")
}

Create an advanced tabset

Description

Advanced tabset panel with styles and features

Usage

tabsetPanel(
  ...,
  type = c("default", "pills", "clean", "jPills", "justified"),
  border = TRUE,
  justified = FALSE,
  position = c("left", "end", "center")
)

Arguments

Value

An HTML containing elements of a tabset to be embedded in a page

Note

Many examples exist for the tabset, fid them using the package load.example function

Examples

if (interactive()) {
  library(shiny)
  library(nextGenShinyApps)
  tab2 <- tabPanel("Summary", "SAMPLE nunc.")
  tab3 <- tabPanel("Tab 3", "aoreet sit amet.")
  tab4 <- tabPanel("Tab 4", "Vulputate pulvinar")


  shiny::shinyApp(
    ui = fluidPage(
      style = "8",
      custom.bg.color = "rgb(110,134,032)",
      sidebar = NULL,
      header = NULL,
      tabsetPanel(
        tab2,
        tab3,
        type = "pills",
        justified = TRUE
      )
    ),
    server = function(input, output) {
    }
  )
}

Template location full text

Description

Fetch the location of the scripts

Usage

template.loc(template = "core")

Arguments

Value

A path for the location of the package

Examples

template.loc('core')

Create an advanced text area input

Description

Modifications to 'textAreaInput' to allow added styles

Usage

textAreaInput(
  inputId,
  label,
  value = "",
  width = NULL,
  height = NULL,
  cols = NULL,
  rows = NULL,
  placeholder = NULL,
  resize = c("both", "none", "vertical", "horizontal"),
  style = c("default", "pill", "round", "clean"),
  border.type = c("none", "primary", "secondary", "info", "success", "danger", "warning")
)

Arguments

Value

HTML element of a textAreaInput

Note

For more information on the features of the form, visit the examples section of the help documentation

Examples

textAreaInput("caption",
          "Sample Text area input",
          "Data Summary",
          width = "1000px", border.type = "success"
        )

Create an advanced text input

Description

Modifications to textInput to allow added functionality and styles

Usage

textInput(
  inputId,
  label,
  value = "",
  width = NULL,
  placeholder = NULL,
  size = c("m", "s", "l", "xl"),
  style = c("default", "pill", "round", "clean"),
  border.type = c("none", "primary", "secondary", "info", "success", "danger", "warning"),
  prepend = NULL,
  append = NULL,
  disabled = FALSE
)

Arguments

Value

A HTML with modifications to th style information

Note

For more information on the features of the form, visit the examples section of the help documentation

Examples

if (interactive()) {
  library(shiny)
  library(nextGenShinyApps)

  shiny::shinyApp(
    ui = fluidPage(
      style = "8",
      custom.bg.color = "white",
      sidebar = NULL,
      header = NULL,
      card(
        header = FALSE,
        tags$h3("Text input"),
        textInput("caption", "Basic"),
        textInput("caption", "Basic", style = "clean"),
        textInput("caption", "Border - primary",
          "Enter sample text",
          prepend = "@", border.type = "info"
        ),
        textInput("caption", "Border - primary",
          "Enter sample text",
          prepend = shiny::icon("lock")
        ),
        textInput("caption", "Border - primary",
          "Enter sample text",
          append = "%"
        ),
        textInput("caption", "Border - primary",
          "Enter sample text",
          prepend = shiny::icon("chart"),
          append = ".00"
        )
      )
    ),
    server = function(input, output) {
    }
  )
}

Title panel for the header of the application

Description

Used to embed the header within the body of the application

Usage

titlePanel(left = "Sample Tile", right = NULL, link = "#")

Arguments

Value

An HTML containing elements to insert in a title

Examples

if (interactive()) {
  titlePanel(
    left = "Sample App Title",
    right = shiny::div("Image/logo", shiny::icon("trash"))
  )
  }

A wrapper for panels

Description

Create a wrapper div for pannels

Usage

wrapper(
  ...,
  bg = c("default", "primary", "secondary", "warning", "info", "danger", "success")
)

Arguments

Value

a container for other containers

Examples

wrapper(altPanel("hello"),mainPanel("test"))
wrapper(mainPanel("hello"),shiny::column(width=2,"test"))