Namespaced IDs for inputs/outputs

Description

Namespaced IDs for inputs/outputs

Usage

NS(namespace, id = NULL)

ns.sep

Arguments

Format

An object of class character of length 1.

Create a Boostrap 4 argon alert

Description

Build an argon alert

Usage

argonAlert(..., icon = NULL, status = "default", closable = TRUE)

Arguments

Author(s)

David Granjon, dgranjon@ymail.com

Examples

if (interactive()) {
 library(argonR)
 argonAlert(
  icon = argonIcon("basket"),
  status = "danger",
  "This is an alert",
  closable = TRUE
 )
}

Create a Boostrap 4 badge

Description

Build an argon badge

Usage

argonBadge(text = NULL, src = NULL, pill = FALSE, status = "default")

Arguments

Author(s)

David Granjon, dgranjon@ymail.com

Examples

if (interactive()) {
 library(argonR)
 argonBadge(
   text = "My badge",
   src = "https://www.google.com",
   pill = FALSE,
   status = "success"
 )
}

Create a Boostrap 4 blur effect

Description

Build an argon blur effect

Usage

argonBlur(..., text = NULL, text_color = NULL)

Arguments

Note

Not compatible with argonDash

Author(s)

David Granjon, dgranjon@ymail.com

Examples

if (interactive()) {
 library(argonR)
 argonBlur(
  argonImage(
   src = "inst/images/imac.svg",
   floating = TRUE
  )
 ) 
}

Create a Boostrap 4 argon button

Description

Build an argon button

Usage

argonButton(
  src = NULL,
  name = NULL,
  status = "default",
  icon = NULL,
  size = NULL,
  block = FALSE,
  disabled = FALSE,
  outline = FALSE,
  toggle_modal = FALSE,
  modal_id = NULL
)

Arguments

Author(s)

David Granjon, dgranjon@ymail.com

Examples

if(interactive()){
 library(argonR)
 argonButton(
  name = "Click me!",
  status = "danger",
  icon = argonIcon("atom"),
  size = "lg",
  toggle_modal = TRUE,
  modal_id = "modal1"
 )
}

Create a Boostrap 4 card

Description

Build an argon card

Usage

argonCard(
  ...,
  title = NULL,
  src = NULL,
  hover_lift = FALSE,
  shadow = FALSE,
  shadow_size = NULL,
  hover_shadow = FALSE,
  border_level = 0,
  icon = NULL,
  btn_text = "More",
  status = "primary",
  background_color = NULL,
  gradient = FALSE,
  floating = FALSE,
  width = 6
)

Arguments

Author(s)

David Granjon, dgranjon@ymail.com

Examples

if (interactive()) {
 library(argonR)
 argonCard(
  status = "primary",
  width = 12,
  title = "Card 1",
  hover_lift = TRUE,
  shadow = TRUE,
  icon = argonIcon("check-bold"),
  src = "#",
  "Argon is a great free UI package based on Bootstrap 4 
  that includes the most important components and features."
 )
}

Create a carousel

Description

Build an argon carousel

Usage

argonCarousel(..., id, floating = FALSE, hover_lift = FALSE, width = 6)

Arguments

Author(s)

David Granjon, dgranjon@ymail.com

Examples

if (interactive()) {
 library(argonR)
 argonCarousel(
  id = "carousel2",
  argonCarouselItem(
    src = "https://demos.creative-tim.com/argon-design-system/assets/img/theme/img-1-1200x1000.jpg",
    active = TRUE
  ),
  argonCarouselItem(
    src = "https://demos.creative-tim.com/argon-design-system/assets/img/theme/img-2-1200x1000.jpg",
    active = FALSE
  )
 )
}

Create a carousel item

Description

Build an argon carousel item

Usage

argonCarouselItem(src = NULL, active = FALSE, mode = "img")

Arguments

Author(s)

David Granjon, dgranjon@ymail.com

Create a Boostrap 4 cascade effect

Description

Build an argon cascade effect

Usage

argonCascade(...)

Arguments

Note

You must pass cascade = TRUE to argonSection

Author(s)

David Granjon, dgranjon@ymail.com

Examples

if (interactive()) {
 library(argonR)
 argonSection(
  size = "lg",
  status = "default",
  cascade = TRUE,
  
  argonH1(display = 3, "ArgonR Cascade Effect") %>% 
    argonPadding(orientation = "l", value = 5) %>%
    argonPadding(orientation = "b", value = 5) %>%
    argonTextColor(color = "white"),
  
  argonCascade(
    argonCascadeItem(name = "diamond", src = "https://www.google.com"),
    argonCascadeItem(name = "album-2", size = "sm"),
    argonCascadeItem(name = "app", size = "sm"),
    argonCascadeItem(name = "atom", size = "sm"),
    argonCascadeItem(name = "bag-17", src = "https://www.google.com"),
    argonCascadeItem(name = "bell-55"),
    argonCascadeItem(name = "credit-card"),
    argonCascadeItem(name = "briefcase-24", size = "sm", "https://www.google.com"),
    argonCascadeItem(name = "building", size = "sm"),
    argonCascadeItem(name = "button-play", size = "sm"),
    argonCascadeItem(name = "calendar-grid-58"),
    argonCascadeItem(name = "camera-compact"),
    argonCascadeItem(name = "chart-bar-32")
  )
 )
}

Create a Boostrap 4 cascade item

Description

Build an argon cascade item

Usage

argonCascadeItem(name, size = NULL, src = NULL)

Arguments

Author(s)

David Granjon, dgranjon@ymail.com

Create a Boostrap 4 column

Description

Build an argon column

Usage

argonColumn(..., width = NULL, center = FALSE, offset = NULL)

Arguments

Author(s)

David Granjon, dgranjon@ymail.com

Examples

if (interactive()) {
 library(argonR)
 argonColumn(
  width = 4,
  argonAlert(
    icon = "basket",
    status = "danger",
    "This is an alert",
    closable = TRUE
  )
 )
}

Create a Boostrap 4 argon contact form

Description

Build an argon contact form

Usage

argonContact(
  title = NULL,
  subtitle = NULL,
  name = "Your name",
  mail = "Email Adress",
  subject = "Subject",
  message,
  mailto,
  width = 8
)

Arguments

Note

Need to have an active formspree.io account. See https://formspree.io. Only works on web-server!

Author(s)

David Granjon, dgranjon@ymail.com

Create a boostrap 4 container

Description

Create a boostrap 4 container

Usage

argonContainer(..., size = NULL)

Arguments

Author(s)

David Granjon, dgranjon@ymail.com

Examples

if (interactive()) {
 library(argonR)
 argonContainer()
}

Create a Boostrap 4 argon dropdown menu

Description

Build an argon dropdown menu

Usage

argonDropdown(..., name, size = NULL)

Arguments

Author(s)

David Granjon, dgranjon@ymail.com

Create a Boostrap 4 argon dropdown item

Description

Build an argon dropdown item

Usage

argonDropdownItem(
  name = NULL,
  description = NULL,
  src = NULL,
  icon = NULL,
  status = NULL
)

Arguments

Author(s)

David Granjon, dgranjon@ymail.com

Create a Boostrap 4 argon footer

Description

Build an argon footer

Usage

argonFooter(..., has_card = FALSE, status = NULL, gradient = FALSE)

Arguments

Author(s)

David Granjon, dgranjon@ymail.com

Examples

if(interactive()){
 library(argonR)
 argonFooter(
  has_card = FALSE,
  argonContainer(
    size = "lg",
    argonRow(
      argonColumn(
        width = 6,
        argonIconWrapper(
          iconTag = argonIcon("atom"),
          size = "lg",
          status = "success",
          shadow = TRUE,
          hover_shadow = TRUE
        ),
        argonH1(
          display = 3,
          "Insert anything in the footer"
        ),
        argonLead(
          "The Arctic Ocean freezes every winter and much of 
          the sea-ice then thaws every summer, and that process 
          will continue whatever"
        )
        ),
      argonColumn(
        width = 6,
        argonCarousel(
          width = 12,
          id = "carousel2",
          argonCarouselItem(
            src = "http://www.72pxdesigns.com/wp-content/uploads/2017/06/preview-814162.png",
            active = TRUE
          ),
          argonCarouselItem(
            src = "http://www.72pxdesigns.com/wp-content/uploads/2017/06/preview-814162.png",
            active = FALSE
          )
        )
      )
    )
   )
 )
}

Create a custim h1 tag

Description

A custom h1 tag

Usage

argonH1(..., display)

Arguments

Author(s)

David Granjon, dgranjon@ymail.com

Examples

if (interactive()) {
 library(argonR)
 argonH1(display = 3, "ArgonR elements")
}

Create a Nucleo icon

Description

Build an argon Nucleo icon

Usage

argonIcon(name, color = NULL)

Arguments

Author(s)

David Granjon, dgranjon@ymail.com

Examples

if (interactive()) {
 library(argonR)
 argonIcon("atom")
}

Create a Nucleo icon wrapper

Description

Build an argon Nucleo icon wrapper

Usage

argonIconWrapper(
  iconTag,
  circle = TRUE,
  size = NULL,
  status = "default",
  gradient_color = NULL,
  shadow = TRUE,
  hover_shadow = FALSE
)

Arguments

Author(s)

David Granjon, dgranjon@ymail.com

Examples

if (interactive()) {
 library(argonR)
 argonIconWrapper(
  iconTag = argonIcon("atom"),
  size = "lg",
  status = "danger",
  shadow = TRUE,
  hover_shadow = TRUE
 )
}

Create a Boostrap 4 image container

Description

Build an argon image container

Usage

argonImage(
  src = NULL,
  url = NULL,
  floating = FALSE,
  card_mode = FALSE,
  hover_lift = FALSE,
  width = NULL
)

Arguments

Author(s)

David Granjon, dgranjon@ymail.com

Examples

if (interactive()) {
 library(argonR)
 argonImage(
  floating = TRUE,
  src = "https://demos.creative-tim.com/argon-design-system/assets/img/ill/ill-2.svg",
  hover_lift = TRUE
 )
}

Install argon assets

Description

Install argon assets

Usage

argonInstall(path = getwd())

Arguments

Note

argon assets are stored in the inst folder similarly as the package folder.

Author(s)

David Granjon, dgranjon@ymail.com

Examples

if(interactive()){
 library(argonR)
 argonInstall()
}

Create a custom p tag

Description

A custom p tag

Usage

argonLead(...)

Arguments

Author(s)

David Granjon, dgranjon@ymail.com

Examples

if (interactive()) {
 library(argonR)
 argonLead("Badges")
}

Change tag margins

Description

Change tag margins

Usage

argonMargin(tag, orientation, value)

Arguments

Author(s)

David Granjon, dgranjon@ymail.com

Examples

if (interactive()) {
 library(argonR)
 argonMargin(tag = h1("test"), orientation = "t", value = -1)
 argonMargin(tag = h1("test"), orientation = "x", value = 7)
}

Create a Boostrap 4 argon modal

Description

Build an argon modal

Usage

argonModal(..., id, title = NULL, status = NULL, gradient = FALSE)

Arguments

Author(s)

David Granjon, dgranjon@ymail.com

Examples

if(interactive()){
 library(argonR)
 argonModal(
  id = "modal1",
  title = "This is a modal",
  status = "danger",
  gradient = TRUE,
  "YOU SHOULD READ THIS!",
  br(),
  "A small river named Duden flows by their place and supplies it with the necessary regelialia."
 )
}

Create a muted text

Description

Apply the class muted to a text

Usage

argonMuted(...)

Arguments

Author(s)

David Granjon, dgranjon@ymail.com

Examples

if (interactive()) {
 library(argonR)
 argonMuted(argonLead("Badges"))
}

Create a Boostrap 4 argon navbar item

Description

Build an argon navbar item

Usage

argonNavItem(name = NULL, src = NULL, icon = NULL, tooltip = NULL)

Arguments

Author(s)

David Granjon, dgranjon@ymail.com

Create a Boostrap 4 argon navbar menu

Description

Build an argon navbar menu

Usage

argonNavMenu(..., side = "left")

Arguments

Author(s)

David Granjon, dgranjon@ymail.com

Create a Boostrap 4 argon navbar

Description

Build an argon navbar

Usage

argonNavbar(
  ...,
  href = "#",
  src = NULL,
  src_collapsed = NULL,
  id,
  headroom = TRUE
)

Arguments

Author(s)

David Granjon, dgranjon@ymail.com

Examples

if(interactive()){
 library(argonR)
 argonNavbar(
  id = "main-navbar",
  src = "https://demos.creative-tim.com/argon-design-system/assets/img/brand/white.png",
  # left menu
  argonNavMenu(
    argonDropdown(
      name = "Components",
      size = "lg",
      argonDropdownItem(
        name = "Getting Started",
        description = "BlaBlaBlaBlaBlaBlaBlaBlaBlaBlaBlaBlaBlaBlaBlaBlaBlaBla",
        src = "test.html",
        icon = "spaceship",
        status = "primary"
      ),
      argonDropdownItem(
        name = "Foundation",
        description = "BlaBlaBlaBlaBlaBlaBlaBlaBlaBlaBlaBlaBlaBlaBlaBlaBlaBla",
        src = "",
        icon = "palette",
        status = "warning"
      ),
      argonDropdownItem(
        name = "Components",
        description = "BlaBlaBlaBlaBlaBlaBlaBlaBlaBlaBlaBlaBlaBlaBlaBlaBlaBla",
        src = "",
        icon = "ui-04",
        status = "success"
      )
    )
  ),
  # right menu
  argonNavMenu(
    side = "right",
    argonNavItem(
      name = "facebook",
      src = "https://www.facebook.com",
      icon = "facebook-square",
      tooltip = "Like us on Facebook"
    ),
    argonNavItem(
      name = "instagram",
      src = "https://www.instagram.com",
      icon = "instagram",
      tooltip = "Follow us on Instagram"
    ),
    argonNavItem(
      name = "twitter",
      src = "https://www.twitter.com",
      icon = "twitter-square",
      tooltip = "Follow us on Twitter"
    ),
    argonNavItem(
      name = "github",
      src = "https://www.github.com",
      icon = "github",
      tooltip = "Star us on Github"
    )
  )
 )
}

Change tag padding

Description

Change tag padding

Usage

argonPadding(tag, orientation, value)

Arguments

Author(s)

David Granjon, dgranjon@ymail.com

Examples

if (interactive()) {
 library(argonR)
 argonPadding(tag = h1("test"), orientation = NULL, value = 5)
 argonPadding(tag = h1("test"), orientation = "x", value = 2)
}

Create a Boostrap 4 argon page

Description

Build an argon page

Usage

argonPage(
  ...,
  title = NULL,
  description = NULL,
  author = NULL,
  navbar = NULL,
  footer = NULL,
  favicon = NULL,
  analytics = NULL
)

Arguments

Author(s)

David Granjon, dgranjon@ymail.com

Examples

if(interactive()){
 library(argonR)
 argonPage(
  title = "ArgonR Static Template",
  author =  "Somebody",
  description = "HTML Static Template",
  navbar = argonNavbar(id = "navbar"),
  footer = argonFooter(),
  # main content
  argonSection(),
  argonSection(),
  argonSection(),
  argonSection(),
  argonSection()
 )
}

Create an HTML version of the argonPage

Description

Create an HTML version of the argonPage

Usage

argonPageTemplate(filename = "index", path = getwd(), argonPage, view = TRUE)

Arguments

Note

Do not forget to copy the inst folder of the package to the root of your website folder.

Author(s)

David Granjon, dgranjon@ymail.com

Examples

if(interactive()){
 library(argonR)
 
 # generate the page
 example <- argonPage(
  title = "ArgonR Static Template",
  author =  "Somebody",
  description = "HTML Static Template",
  navbar = argonNavbar(id = "navbar"),
  footer = argonFooter(),
  # main content
  argonSection(),
  argonSection(),
  argonSection(),
  argonSection(),
  argonSection()
 )
 
 # create the path
 path <- getwd()
 
 # generate the static page
 argonPageTemplate(filename = "example", path = path, argonPage = example)
 
}

Build an argon pagination container

Description

Build an argon pagination container

Usage

argonPagination(..., size = NULL, align = NULL)

Arguments

Note

align will not work if you embed the argonPagination in an argonRow.

Author(s)

David Granjon, dgranjon@ymail.com

Examples

if(interactive()){
 library(argonR)
 argonPagination(
  size = "lg",
  align = "center",
  argonPaginationItem(
    name = 1,
    src = "test.html"
  ),
  argonPaginationItem(
    name = 2,
    src = "https://www.google.com"
  )
 )
}

Build an argon pagination item

Description

Build an argon pagination item

Usage

argonPaginationItem(name, src = NULL)

Arguments

Author(s)

David Granjon, dgranjon@ymail.com

Create a Boostrap 4 perspective effect

Description

Build an argon perspective effect

Usage

argonPersp(..., side)

Arguments

Note

Disabled on small screens (not a bug)

Author(s)

David Granjon, dgranjon@ymail.com

Examples

if (interactive()) {
 library(argonR)
 argonPersp(argonCard(), side = "right")
}

Create a Boostrap 4 profile card

Description

Build an argon profile card

Usage

argonProfile(
  ...,
  title = NULL,
  subtitle = NULL,
  src = NULL,
  url = NULL,
  url_1 = NULL,
  url_2 = NULL,
  stats
)

Arguments

Note

Do not work on argonR. Only for argon Dash

Author(s)

David Granjon, dgranjon@ymail.com

Examples

if(interactive()){
 library(argonR)
 argonProfile(
  title = "John",
  subtitle = "Japan, Kagoshima",
  src = "https://image.flaticon.com/icons/svg/1006/1006540.svg",
  url = "https://www.google.com",
  url_1 = "https://www.google.com",
  url_2 = "https://www.google.com",
  stats = argonProfileStats(
    argonProfileStat(
      value = 22,
      description = "Friends"
    ),
    argonProfileStat(
      value = 10,
      description = "Photos"
    ),
    argonProfileStat(
      value = 89,
      description = "Comments"
    )
  ),
  "An artist of considerable range, Ryan — 
  the name taken by Melbourne-raised, 
  Brooklyn-based Nick Murphy — writes, 
  performs and records all of his own music, 
  giving it a warm, intimate feel with a solid 
  groove structure. An artist of considerable 
  range."
 )
}

Create a Boostrap 4 profile card stat item

Description

Build an argon profile card stat item

Usage

argonProfileStat(value, description)

Arguments

Author(s)

David Granjon, dgranjon@ymail.com

Create a Boostrap 4 profile card stats container

Description

Build an argon profile card stats container

Usage

argonProfileStats(...)

Arguments

Author(s)

David Granjon, dgranjon@ymail.com

Create a progress bar

Description

Build an argon progress bar

Usage

argonProgress(value, text = NULL, status = "primary")

Arguments

Author(s)

David Granjon, dgranjon@ymail.com

Examples

if (interactive()) {
 library(argonR)
 argonProgress(value = 10, status = "danger", text = "Custom Text")
}

Create a quotation tag

Description

A custom quotation tool

Usage

argonQuote(..., footer = NULL, source = NULL, align = "center")

Arguments

Author(s)

David Granjon, dgranjon@ymail.com

Examples

if (interactive()) {
 library(argonR)
 argonQuote(align = "center", "I am a text")
}

Create a Boostrap 4 row

Description

Build an argon row

Usage

argonRow(..., center = FALSE)

Arguments

Author(s)

David Granjon, dgranjon@ymail.com

Examples

if (interactive()) {
 library(argonR)
 argonRow(
  argonColumn(
    width = 6,
    argonH1(
      display = 3, 
      "ArgonR, HTML static template for R", 
      htmltools::span("completed with examples")
    ) %>% argonTextColor(color = "white"),
    argonLead(
      "Argon is a great free UI package based on Bootstrap 
              4 that includes the most important components and features"
    ) %>% argonTextColor(color = "white")
  ),
  argonColumn(
    width = 6,
    argonImage(
      src = "inst/images/imac.svg",
      floating = TRUE
    ) %>% argonPersp(side = "right")
    %>% argonBlur()
  )
 )
}

Create a Boostrap 4 section container

Description

Build an argon section container

Usage

argonSection(
  ...,
  size = NULL,
  status = "default",
  gradient = FALSE,
  separator = FALSE,
  separator_color = "secondary",
  shape = FALSE,
  cascade = FALSE
)

Arguments

Note

Do not use with the argonDash package. Only for argonR.

Author(s)

David Granjon, dgranjon@ymail.com

Examples

if (interactive()) {
 library(argonR)
 argonSection(
  size = "lg",
  status = "default",
  gradient = TRUE,
  separator = TRUE,
  separator_color = "white",
  shape = TRUE,
  argonColumn(
    argonRow(
      argonColumn(
        width = 6,
        argonH1(
          display = 3, 
          "ArgonR, HTML static template for R", 
          htmltools::span("completed with examples")
        ) %>% argonTextColor(color = "white"),
        argonLead(
          "Argon is a great free UI package based on Bootstrap 
          4 that includes the most important components and features"
        ) %>% argonTextColor(color = "white")
        ),
      argonColumn(
        width = 6,
        argonImage(
          src = "inst/images/imac.svg",
          floating = TRUE
        ) %>% argonPersp(side = "right")
        %>% argonBlur()
      )
      )
  )
 )
}

Create a Boostrap 4 argon social button

Description

Build an argon social button

Usage

argonSocialButton(src = NULL, status = "default", icon = NULL)

Arguments

Author(s)

David Granjon, dgranjon@ymail.com

Examples

if(interactive()){
 library(argonR)
 argonSocialButton(
  src = "http://rinterface.com",
  status = "danger",
  icon = icon("facebook")
 )
}

Create a Boostrap 4 tab item

Description

Build an argon tab item

Usage

argonTab(..., tabName, active = FALSE)

Arguments

Author(s)

David Granjon, dgranjon@ymail.com

Create a Boostrap 4 tabs

Description

Build an argon tabs

Usage

argonTabSet(
  ...,
  id,
  card_wrapper = FALSE,
  horizontal = TRUE,
  circle = FALSE,
  size = "sm",
  width = 6,
  iconList = NULL
)

Arguments

Author(s)

David Granjon, dgranjon@ymail.com

Examples

if (interactive()) {
 library(argonR)
 argonTabSet(
  id = "tabset1",
  card_wrapper = TRUE,
  horizontal = TRUE,
  circle = FALSE,
  size = "sm",
  width = 6,
  iconList = list(
   argonIcon("cloud-upload-96"), 
   argonIcon("bell-55"), 
   argonIcon("calendar-grid-58")
  ),
  argonTab(
    tabName = "Tab 1",
    active = FALSE,
    "tabText1"
  ),
  argonTab(
    tabName = "Tab 2",
    active = TRUE,
    "tabText2"
  ),
  argonTab(
    tabName = "Tab 3",
    active = FALSE,
    "tabText3"
  )
 )
}

Add a custom color to a text

Description

A custom color fo your text

Usage

argonTextColor(tag, color)

Arguments

Author(s)

David Granjon, dgranjon@ymail.com

Examples

if (interactive()) {
 library(argonR)
 library(htmltools)
 argonTextColor(
  tag = h1("test"),
  color = "success"
 )
}

Create a boostrap 4 tooltip

Description

Create a boostrap 4 tooltip

Usage

argonTooltip(tag, position, title = NULL)

Arguments

Author(s)

David Granjon, dgranjon@ymail.com

Examples

if (interactive()) {
 library(argonR)
 argonTooltip(
  position = "left", 
  title = "I am a nice card",
  argonCard(
   status = "primary",
   width = 12,
   title = "Card 1",
   hover_lift = TRUE,
   shadow = TRUE,
   icon = "check-bold",
   src = "#",
   "Argon is a great free UI package based on Bootstrap 4 
   that includes the most important components and features."
  )
 )
}

Create a Boostrap 4 user image

Description

Build an argon user image

Usage

argonUser(..., title = NULL, subtitle = NULL, src = NULL)

Arguments

Author(s)

David Granjon, dgranjon@ymail.com

Examples

if (interactive()) {
 library(argonR)
 argonUser(
  title = "Ryan Tompson",
  subtitle = "Web Developer",
  src = "https://demos.creative-tim.com/argon-design-system/assets/img/theme/team-1-800x800.jpg"
 )
}