Attach jQuery to current document

Description

The current function allows inclusion of jQuery in an HTML output

Usage

add.JQuery(version = "3.5.1")

Arguments

Value

script tag with jQuery link

Note

This function holds significance across the entire package, particularly in scenarios where a specific HTML output lacks the inclusion of the jQuery script required by other functions within this package. It serves as a crucial mechanism for ensuring that functionalities within the package remain operable even when the necessary jQuery script is absent from the HTML page by default knitting. By providing a fallback option, this function enhances the robustness and reliability of the package, allowing it to gracefully handle situations where jQuery is not explicitly included. Its role is pivotal in maintaining consistent behavior and functionality across diverse HTML environments, thereby facilitating seamless integration and usage of the package across various web development contexts.

Examples

add.JQuery()
add.JQuery("3.7.0") # add a specific version

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")

Generate a flexible and extensible card container

Description

Widely used card component from Bootstrap with improvements to improve utility

Usage

card.pro(
  ...,
  title,
  collapsed = FALSE,
  width = 12,
  tabs = NULL,
  icon = NULL,
  xtra.header.content = NULL,
  footer = NULL,
  togglebtn = TRUE,
  editbtn = TRUE,
  expandbtn = TRUE,
  colorbtn = TRUE,
  removebtn = TRUE,
  sortable = TRUE,
  sidebar = NULL,
  shadow = TRUE,
  header.bg = c("white", "green", "greenDark", "greenLight", "purple", "magenta", "pink",
    "pinkDark", "blueLight", "teal", "blue", "blueDark", "darken", "yellow", "orange",
    "orangeDark", "red", "redLight"),
  alert.text = NULL,
  alert.type = c("warning", "info", "success", "danger"),
  collapsibleGroup = NULL
)

Arguments

Value

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

Note

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

Examples

# Example 1
if (interactive()) {
  library(shiny)
  library(card.pro)

  shiny::shinyApp(
    ui = fluidPage(
      titlePanel("Change customizations.
      Its preserved across refresh!"),
      moveable(
        card.pro(
          "Lorem ipsum odor amet.",
          title = "Box 1",
          icon = icon("fire"),
          tabs = list(
            tabEntry(
              "Tab 1",
              textInput("nor1", "Enter name"),
              "Content for 1"
            ),
            tabEntry(
              "Tab 2",
              actionButton("nor1", "Try click"),
              "sample"
            )
          )
        ),
        card.pro(
          "Another something",
          title = "Box 2",
          width = 6,
          header.bg = "blue",
          alert.text = "Its an alert!",
          colorbtn = FALSE,
          editbtn = FALSE
        )
      )
    ),
    server = empty.server
  )
}

# Example 2
if (interactive()) {
  library(shiny)
  library(card.pro)

  shiny::shinyApp(
    ui = fluidPage(
      titlePanel("Change order and refresh, changes saved"),
      wrapper(
        moveable(
          card.pro(
            "A plot for test",
            textInput("test6", "Plot title"),
            actionButton("test9", "Make plot"),
            title = "Box 3",
            width = 6,
            header.bg = "red",
            collapsed = TRUE,
            sortable = FALSE
          ),
          card.pro(
            "Box 4 content",
            "shinyappstore.com",
            title = "Box 1",
            width = 8,
            header.bg = "red",
            sidebar = div(
              "My settings",
              textInput("test2", "Input change"),
              actionButton("test3", "Click to save")
            ),
            footer = list(
              "Footnote: example",
              actionButton("test19", "Upload something")
            )
          )
        )
      )
    ),
    server = empty.server
  )
}

Create a collapsible container panel item

Description

Create a collapsible container panel item that is enclosed by a list

Usage

collapseEntry(
  ...,
  title,
  collapsed = FALSE,
  color.off = "darken",
  color.on = "red"
)

Arguments

Details

Get color choices using quickcode:::color.choice

Value

An list containing the title and content of a collapsible container

Examples

if (interactive()) {
 library(shiny)
 library(card.pro)
 card.pro(
  title = "Sample collapsible",width = 4,
  collapsibleGroup = list(
    collapseEntry(title = "Summary 1", collapsed = TRUE, "Convallis aesus."),
    collapseEntry(title = "Summary 2", "eiusmod tempor incididunt")
  )
)
}

Empty server function

Description

For use in simple shiny apps not requiring server functions

Usage

empty.server(input, output, session)

Arguments

Value

Empty server function

Examples

if(interactive()){
  library(shiny)
  library(card.pro)
  ui = fluidPage("Obi Obianom")
  shinyApp(ui = ui, server = empty.server)
}

Generate a moveable grid

Description

A grid that holds draggable items

Usage

moveable(...)

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

moveable(
  htmltools::tags$div("A"),
  htmltools::tags$div("B")
)

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')

Main panel to display content

Description

Customizable main panel for inclusion of various UI elements

Usage

primePanel(..., 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

primePanel("content 1")

Create simple progress bar

Description

Create a progress bar within card container

Usage

progressInput(
  id,
  label = "",
  value = "35%",
  outer.value = value,
  color = color.choice,
  vertical = FALSE,
  size = c("m", "s", "l"),
  striped = FALSE
)

Arguments

Value

an HTML content to display a progress bar

Examples

if (interactive()) {
library(shiny)
library(card.pro)

# Without much modification of defaults
progressInput(id="id1")

# Set color and value
progressInput(id="id1", value = "90%", color = "green")
}

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"))

Create a tab panel item

Description

Create a tab panel item that is enclosed by a list

Usage

tabEntry(title, ...)

Arguments

Value

An list containing the title and content of a tab

Examples

if (interactive()) {
card.pro(
  title = "Sample tabs",
  tabs = list(
    tabEntry("Summary", "Convallis aesus."),
    tabEntry("Summary", "nextGenShinyApps.")
  )
)
}

Template location full text

Description

Fetch the location of the scripts

Usage

template.loc(template = "bundle")

Arguments

Value

A path for the location of the package

Examples

template.loc('bundle')

Create a title and footer bar

Description

Create an alternative title bar

Usage

titlePanel2(
  title,
  rightContent = NULL,
  windowTitle = title,
  text.col = "#2a2725",
  bg.col = "#ffffff"
)

footerPanel(
  title = shiny::HTML("© 2024"),
  rightContent = NULL,
  bg.col = "#2a2725",
  text.col = "#f5f5f5"
)

Arguments

Value

An list containing the title and content of a header or footer

Examples

if (interactive()) {
titlePanel2("Main title", "Right content | About me")
titlePanel2("Main title", action)
}

if (interactive()) {
footerPanel("Main footer @ 2024. All rights reserved", "Contact us")
}

Include stylesheets and scripts

Description

Use the package scripts and stylesheets in a page

Usage

use.cardpro(
  theme = letters[1:5],
  jquery = FALSE,
  jqueryui = TRUE,
  fontawesome = FALSE,
  template = "bundle",
  fix.header = FALSE
)

Arguments

Value

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

Note

Theme options are "a", "b", "c", "d" or "e"

Examples

if(interactive()){
use.cardpro()
use.cardpro(theme="a",jqueryui = TRUE, fontawesome = FALSE)
}

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"), shiny::mainPanel("test"))
wrapper(shiny::mainPanel("hello"), shiny::column(width = 2, "test"))