Package 'argonDash'

Title: Argon Shiny Dashboard Template
Description: Create awesome 'Bootstrap 4' dashboards powered by 'Argon'.
Authors: David Granjon [aut, cre], RinteRface [cph], Creative Tim [ctb, cph] (Argon theme for Bootstrap 4)
Maintainer: David Granjon <[email protected]>
License: GPL-2
Version: 0.3.0.9000
Built: 2024-11-14 06:15:09 UTC
Source: https://github.com/rinterface/argondash

Help Index

Create a Boostrap 4 avatar

Description

Build an argon avatar

Usage

argonAvatar(src, toolTip = NULL, size = c("sm", "md", "lg"))

Arguments

src

Avatar inag path or url.
toolTip

Optional tooltip triggered on mouse hover.
size

Avatar size: choose one of "sm", "md" or "lg".

Author(s)

David Granjon, [email protected]

Create a Boostrap 4 avatar container

Description

Build an argon avatar container

Usage

argonAvatars(...)

Arguments

...

Slot for argonAvatar.

Author(s)

David Granjon, [email protected]

Create a Boostrap 4 dashboard body

Description

Build an argon dashboard body

Usage

argonDashBody(...)

Arguments

...

Body content, slot for argonTabItems

Author(s)

David Granjon, [email protected]

Create a Boostrap 4 dashboard footer

Description

Build an argon dashboard footer

Usage

argonDashFooter(..., copyrights = NULL, src = NULL)

Arguments

...

Slot for argonFooterMenu.
copyrights

Left text, if any.
src

Left text src, if any.

Author(s)

David Granjon, [email protected]

Launch the argonDash Gallery

Description

A gallery of all components available in argonDash.

Usage

argonDashGallery()

Examples

if (interactive()) {

 argonDashGallery()

}

Create a Boostrap 4 dashboard header

Description

Build an argon dashboard header

Usage

argonDashHeader(
  ...,
  gradient = TRUE,
  color = NULL,
  separator = FALSE,
  separator_color = "secondary",
  bottom_padding = 4,
  top_padding = 6,
  background_img = NULL,
  mask = FALSE,
  opacity = 8,
  height = 600
)

Arguments

...

Any element
gradient

Whether to apply a gradient effect. TRUE by default.
color

Header color. See https://demos.creative-tim.com/argon-design-system/docs/foundation/colors.html.
separator

Header bottom separator. FALSE by default.
separator_color

Separator color. "secondary" by default. See https://demos.creative-tim.com/argon-design-system/docs/foundation/colors.html.
bottom_padding

Bottom padding. 4 by default.
top_padding

Bottom padding. 6 by default.
background_img

Background image url or path.
mask

Whether to add an opacity mask on the header. FALSE by default
opacity

Mask opacity. Between 0 and 8. Only if mask is TRUE.
height

Header height. 600px by default. Only if background image.

Author(s)

David Granjon, [email protected]

Create a Boostrap 4 dashboard navbar

Description

Build an argon dashboard navbar

Usage

argonDashNavbar(...)

Arguments

...

Any element such as argonDropNav.

Author(s)

David Granjon, [email protected]

Create a Boostrap 4 dashboard page

Description

Build an argon dashboard page

Usage

argonDashPage(
  title = NULL,
  description = NULL,
  author = NULL,
  navbar = NULL,
  sidebar = NULL,
  header = NULL,
  body = NULL,
  footer = NULL
)

Arguments

title

App title.
description

Dashboard purpose.
author

Dashboard author.
navbar

Bootstrap 4 dashboard navbar.
sidebar

Bootstrap 4 dashboard main sidebar.
header

Bootstrap 4 dashboard header (below the navbar). Useful to hightlight elements or print a message.
body

Bootstrap 4 dashboard body wrapper.
footer

Bootstrap 4 dashboard footer.

Author(s)

David Granjon, [email protected]

Examples

if(interactive()){
 library(shiny)
 library(argonDash)

 shiny::shinyApp(
   ui = argonDashPage(),
   server = function(input, output) {}
 )
}

Create a Boostrap 4 dashboard sidebar

Description

Build an argon dashboard sidebar

Usage

argonDashSidebar(
  ...,
  dropdownMenus = NULL,
  id,
  brand_url = NULL,
  brand_logo = NULL,
  vertical = TRUE,
  side = c("left", "right"),
  size = c("s", "md", "lg"),
  skin = c("light", "dark"),
  background = "white"
)

Arguments

...

Any element such as argonDashSidebar, argonSidebarMenu, argonSidebarItem, argonSidebarHeader and argonSidebarDivider.
dropdownMenus

Slot for dropdown menus. Not displayd on large screens.
id

Unique sidebar id.
brand_url

Sidebar brand url

Sidebar brand logo
vertical

Whether to display the sidebar in vertical mode. TRUE by default.
side

Sidebar side: "right" or "left". "left" by default.
size

Sidebar size: "s", "md", "lg". "md" by default.
skin

Sidebar skin. "light" by default.
background

Sidebar background color. See https://demos.creative-tim.com/argon-design-system/docs/foundation/colors.html.

Author(s)

David Granjon, [email protected]

Create a Boostrap 4 dashboard dropdown menu

Description

Build an argon dashboard dropdown menu

Usage

argonDropNav(..., title = NULL, src = NULL, orientation = "right")

Arguments

...

slot for argonDropNavItem, argonDropNavTitle or argonDropNavDivider.
title

Menu title.
src

Menu image, if any.
orientation

Dropdown orientation: "left" or "right".

Author(s)

David Granjon, [email protected]

Create a Boostrap 4 dashboard dropdown menu divider

Description

Build an argon dashboard dropdown menu divider

Usage

argonDropNavDivider()

Author(s)

David Granjon, [email protected]

Create a Boostrap 4 dashboard dropdown menu item

Description

Build an argon dashboard dropdown menu item

Usage

argonDropNavItem(title = NULL, src = NULL, icon = NULL)

Arguments

title

Item title.
src

External link.
icon

Icon, if any. Expect argonIcon or icon.

Author(s)

David Granjon, [email protected]

Create a Boostrap 4 dashboard dropdown menu title

Description

Build an argon dashboard dropdown menu title

Usage

argonDropNavTitle(title = NULL)

Arguments

title

Menu title.

Author(s)

David Granjon, [email protected]

Create a Boostrap 4 dashboard footer menu item

Description

Build an argon dashboard footer menu item

Usage

argonFooterItem(..., src = NULL)

Arguments

...

Item name.
src

Item external link.

Author(s)

David Granjon, [email protected]

Create a Boostrap 4 dashboard footer menu

Description

Build an argon dashboard footer menu

Usage

argonFooterMenu(...)

Arguments

...

Slot for argonFooterItem.

Author(s)

David Granjon, [email protected]

Create a Boostrap 4 dashboard info card

Description

Build an argon dashboard info card

Usage

argonInfoCard(
  value,
  title = NULL,
  stat = NULL,
  stat_icon = NULL,
  description = NULL,
  icon,
  icon_background = "default",
  hover_lift = FALSE,
  shadow = FALSE,
  background_color = NULL,
  gradient = FALSE,
  width = 3
)

Arguments

value

info card value.
title

info card title.
stat

info card stat value.
stat_icon

info card stat icon. Expect argonIcon or icon.
description

info card stat description.
icon

info card icon. Expect argonIcon or icon.
icon_background

info card icon background color.
hover_lift

Whether to apply a lift effect on hover. FALSE by default. Not compatible with floating.
shadow

Whether to apply a shadow effect. FALSE by default.
background_color

Card background color. NULL by default.
gradient

Whether to apply a gradient effect on the card background. FALSE by default.
width

info card width. Between 1 and 12.

Author(s)

David Granjon, [email protected]

A divider to put inside argonDashSidebar

Description

A divider to put inside argonDashSidebar

Usage

argonSidebarDivider()

A header to put inside argonDashSidebar

Description

A header to put inside argonDashSidebar

Usage

argonSidebarHeader(title = NULL)

Arguments

title

Header title

Create a Boostrap 4 argon sidebar menu

Description

Build an argon dashboard main sidebar menu

Usage

argonSidebarItem(..., tabName = NULL, icon = NULL)

Arguments

...

Item name.
tabName

Should correspond exactly to the tabName given in argonTabItem.
icon

Item icon. argonIcon or icon.

Author(s)

David Granjon, [email protected]

Create a Boostrap 4 argon sidebar menu

Description

Build an argon dashboard main sidebar menu

Usage

argonSidebarMenu(...)

Arguments

...

Slot for argonSidebarItem.

Author(s)

David Granjon, [email protected]

One tab to put inside a tab items container

Description

One tab to put inside a tab items container

Usage

argonTabItem(tabName = NULL, ...)

Arguments

tabName

The name of a tab. This must correspond to the tabName of a argonSidebarItem.
...

Contents of the tab.

A container for tab items

Description

A container for tab items

Usage

argonTabItems(...)

Arguments

...

Items to put in the container. Each item should be a argonTabItem.

Create a Boostrap 4 table container

Description

Build an argon table container

Usage

argonTable(
  ...,
  cardWrap = FALSE,
  title = NULL,
  headTitles,
  dark = FALSE,
  width = 12
)

Arguments

...

argonTableItems.
cardWrap

Whether to wrap the table in a card. FALSE by default.
title

Card title if any.
headTitles

Table header names. Must have the same length as the number of argonTableItem in argonTableItems. Set "" to have an empty title field.
dark

Whether to enable dark mode. FALSE by default.
width

Table width. 12 by default.

Author(s)

David Granjon, [email protected]

Examples

if (interactive()) {
 library(shiny)
 library(argonR)
 library(argonDash)
 shinyApp(
  ui = argonDashPage(
    navbar = argonDashNavbar(), 
    sidebar = argonDashSidebar(id = "mysidebar"), 
    header = argonDashHeader(), 
    body = argonDashBody(
     argonTable(
      headTitles = c(
       "PROJECT",
       "BUDGET",
       "STATUS",
       "USERS",
       "COMPLETION",
       ""
      ),
      argonTableItems(
       argonTableItem("Argon Design System"),
       argonTableItem(dataCell = TRUE, "$2,500 USD"),
       argonTableItem(
        dataCell = TRUE, 
        argonBadge(
         text = "Pending",
         status = "danger"
        )
       ),
       argonTableItem(
        argonAvatar(
         size = "sm",
         src = "https://image.flaticon.com/icons/svg/219/219976.svg"
         )
       ),
       argonTableItem(
        dataCell = TRUE, 
        argonProgress(value = 60, status = "danger")
       ),
       argonTableItem(
        argonButton(
         name = "Click me!",
         status = "warning",
         icon = "atom",
         size = "sm"
        )
       )
      )
     )
    ), 
    footer = argonDashFooter()
  ),
  server = function(input, output) { }
 )
}

Create a Boostrap 4 table item

Description

Build an argon table item

Usage

argonTableItem(..., dataCell = FALSE)

Arguments

...

Any HTML element.
dataCell

Whether the cell should be contain data or text. <td> by default.

Author(s)

David Granjon, [email protected]

Create a Boostrap 4 table item row

Description

Build an argon table item row

Usage

argonTableItems(...)

Arguments

...

Slot for argonTableItem.

Author(s)

David Granjon, [email protected]