Title: | R Interface to Argon HTML Design |
---|---|
Description: | R wrapper around the argon HTML library. More at <https://demos.creative-tim.com/argon-design-system/>. |
Authors: | David Granjon [aut, cre], RinteRface [cph], Creative Tim [ctb, cph] (Argon theme for Bootstrap 4), Winston Chang [ctb, cph] (Unexported functions from htmltools) |
Maintainer: | David Granjon <[email protected]> |
License: | GPL-2 |
Version: | 0.2.0 |
Built: | 2024-11-11 05:45:31 UTC |
Source: | https://github.com/rinterface/argonr |
Build an argon alert
argonAlert(..., icon = NULL, status = "default", closable = TRUE)
argonAlert(..., icon = NULL, status = "default", closable = TRUE)
... |
Alert content. |
icon |
|
status |
Alert status. See https://demos.creative-tim.com/argon-design-system/docs/components/alerts.html. |
closable |
Whether to make the alert closable or not. TRUE by default. |
David Granjon, [email protected]
if (interactive()) { library(argonR) argonAlert( icon = argonIcon("basket"), status = "danger", "This is an alert", closable = TRUE ) }
if (interactive()) { library(argonR) argonAlert( icon = argonIcon("basket"), status = "danger", "This is an alert", closable = TRUE ) }
Build an argon badge
argonBadge(text = NULL, src = NULL, pill = FALSE, status = "default")
argonBadge(text = NULL, src = NULL, pill = FALSE, status = "default")
text |
Badge text. |
src |
Badge external link. |
pill |
Pill mode. FALSE by default. |
status |
Badge status. See https://demos.creative-tim.com/argon-design-system/docs/components/badge.html. |
David Granjon, [email protected]
if (interactive()) { library(argonR) argonBadge( text = "My badge", src = "https://www.google.com", pill = FALSE, status = "success" ) }
if (interactive()) { library(argonR) argonBadge( text = "My badge", src = "https://www.google.com", pill = FALSE, status = "success" ) }
Build an argon blur effect
argonBlur(..., text = NULL, text_color = NULL)
argonBlur(..., text = NULL, text_color = NULL)
... |
Tag to be treated by the blur effect. |
text |
Text that appears on hover. |
text_color |
Text color. See https://demos.creative-tim.com/argon-design-system/docs/foundation/colors.html. |
Not compatible with argonDash
David Granjon, [email protected]
if (interactive()) { library(argonR) argonBlur( argonImage( src = "inst/images/imac.svg", floating = TRUE ) ) }
if (interactive()) { library(argonR) argonBlur( argonImage( src = "inst/images/imac.svg", floating = TRUE ) ) }
Build an argon button
argonButton( src = NULL, name = NULL, status = "default", icon = NULL, size = NULL, block = FALSE, disabled = FALSE, outline = FALSE, toggle_modal = FALSE, modal_id = NULL )
argonButton( src = NULL, name = NULL, status = "default", icon = NULL, size = NULL, block = FALSE, disabled = FALSE, outline = FALSE, toggle_modal = FALSE, modal_id = NULL )
src |
Button external link. |
name |
Button label. |
status |
Button color. See https://demos.creative-tim.com/argon-design-system/docs/components/buttons.html. |
icon |
|
size |
Button size: NULL, "sm" or "lg". |
block |
Whether the button fill its parent. FALSE by default. |
disabled |
Whether to disable the button. FALSE by default. |
outline |
Whether to outline the button. FALSE by default. |
toggle_modal |
Whether to use th button for a modal. FALSE by default. |
modal_id |
If toggle_modal is TRUE, nedd to provide the modal targeted. |
David Granjon, [email protected]
if(interactive()){ library(argonR) argonButton( name = "Click me!", status = "danger", icon = argonIcon("atom"), size = "lg", toggle_modal = TRUE, modal_id = "modal1" ) }
if(interactive()){ library(argonR) argonButton( name = "Click me!", status = "danger", icon = argonIcon("atom"), size = "lg", toggle_modal = TRUE, modal_id = "modal1" ) }
Build an argon card
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 )
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 )
... |
Body content. |
title |
Card title. |
src |
Card external link. |
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. |
shadow_size |
Card shadow size. Only if shadow is TRUE. NULL by default. |
hover_shadow |
Only if shadow is TRUE. Whether to enlarge the shadow on hover. FALSE by default. |
border_level |
Border level. O by default. |
icon |
|
btn_text |
Button text. src arg must not be NULL so that this button appears. |
status |
Card status. See https://demos.creative-tim.com/argon-design-system/docs/foundation/colors.html. |
background_color |
Card background color. NULL by default. See https://demos.creative-tim.com/argon-design-system/docs/foundation/colors.html. |
gradient |
Whether to apply a gradient effect on the card background. FALSE by default. |
floating |
Whether to animate the card by a vertical floating movement. FALSE by default. Not compatible with hover_lift. |
width |
Card width. Between 1 and 12. |
David Granjon, [email protected]
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." ) }
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." ) }
Build an argon carousel
argonCarousel(..., id, floating = FALSE, hover_lift = FALSE, width = 6)
argonCarousel(..., id, floating = FALSE, hover_lift = FALSE, width = 6)
... |
Slot for argonCarouselItem. |
id |
Carousel unique id. |
floating |
Whether to apply a floating effect. FALSE by default. |
hover_lift |
Whether to apply a lift effect on hover. FALSE by default. Not compatible with floating. Only if card_mode is TRUE. |
width |
Carousel width. |
David Granjon, [email protected]
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 ) ) }
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 ) ) }
Build an argon carousel item
argonCarouselItem(src = NULL, active = FALSE, mode = "img")
argonCarouselItem(src = NULL, active = FALSE, mode = "img")
src |
Image url or path. |
active |
Whether the item is active or not. |
mode |
Item mode: "img" by default but also "iframe" or "video". |
David Granjon, [email protected]
Build an argon cascade effect
argonCascade(...)
argonCascade(...)
... |
Slot for argonCascadeItem. Exactly 13 items. |
You must pass cascade = TRUE to argonSection
David Granjon, [email protected]
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") ) ) }
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") ) ) }
Build an argon cascade item
argonCascadeItem(name, size = NULL, src = NULL)
argonCascadeItem(name, size = NULL, src = NULL)
name |
Icon name. |
size |
Icon size: NULL, "sm" or "lg". |
src |
Optional external url, link, ... |
David Granjon, [email protected]
Build an argon column
argonColumn(..., width = NULL, center = FALSE, offset = NULL)
argonColumn(..., width = NULL, center = FALSE, offset = NULL)
... |
Any UI element. |
width |
Optional. Column width between 1 and 12. |
center |
Whether to center column elements or not. FALSE by default. |
offset |
Column offset. NULL by default. Importantly, offset + width cannot exceed 12! |
David Granjon, [email protected]
if (interactive()) { library(argonR) argonColumn( width = 4, argonAlert( icon = "basket", status = "danger", "This is an alert", closable = TRUE ) ) }
if (interactive()) { library(argonR) argonColumn( width = 4, argonAlert( icon = "basket", status = "danger", "This is an alert", closable = TRUE ) ) }
Build an argon contact form
argonContact( title = NULL, subtitle = NULL, name = "Your name", mail = "Email Adress", subject = "Subject", message, mailto, width = 8 )
argonContact( title = NULL, subtitle = NULL, name = "Your name", mail = "Email Adress", subject = "Subject", message, mailto, width = 8 )
title |
Form title. |
subtitle |
Form subtitle. |
name |
Contact name. |
mail |
Contact mail. |
subject |
Message subject. |
message |
For message |
mailto |
Adress to which send the form. |
width |
Form width. Between 1 and 12. |
Need to have an active formspree.io account. See https://formspree.io. Only works on web-server!
David Granjon, [email protected]
Create a boostrap 4 container
argonContainer(..., size = NULL)
argonContainer(..., size = NULL)
... |
Tag to be embedded. |
size |
Container size. NULL or "lg". |
David Granjon, [email protected]
if (interactive()) { library(argonR) argonContainer() }
if (interactive()) { library(argonR) argonContainer() }
Build an argon dropdown menu
argonDropdown(..., name, size = NULL)
argonDropdown(..., name, size = NULL)
... |
Slot for argonDropdownItem. |
name |
Dropdown menu name. |
size |
Dropdown size: NULL or "xl". |
David Granjon, [email protected]
Build an argon dropdown item
argonDropdownItem( name = NULL, description = NULL, src = NULL, icon = NULL, status = NULL )
argonDropdownItem( name = NULL, description = NULL, src = NULL, icon = NULL, status = NULL )
name |
Item name. |
description |
Item description if any. |
src |
HTML target page. |
icon |
|
status |
Icon and name color status. See https://demos.creative-tim.com/argon-design-system/docs/foundation/colors.html. |
David Granjon, [email protected]
A custom h1 tag
argonH1(..., display)
argonH1(..., display)
... |
Any text. |
display |
value between 1 and 4. |
David Granjon, [email protected]
if (interactive()) { library(argonR) argonH1(display = 3, "ArgonR elements") }
if (interactive()) { library(argonR) argonH1(display = 3, "ArgonR elements") }
Build an argon Nucleo icon
argonIcon(name, color = NULL)
argonIcon(name, color = NULL)
name |
icon name. |
color |
icon color. See https://demos.creative-tim.com/argon-design-system/docs/foundation/colors.html. |
David Granjon, [email protected]
if (interactive()) { library(argonR) argonIcon("atom") }
if (interactive()) { library(argonR) argonIcon("atom") }
Build an argon Nucleo icon wrapper
argonIconWrapper( iconTag, circle = TRUE, size = NULL, status = "default", gradient_color = NULL, shadow = TRUE, hover_shadow = FALSE )
argonIconWrapper( iconTag, circle = TRUE, size = NULL, status = "default", gradient_color = NULL, shadow = TRUE, hover_shadow = FALSE )
iconTag |
Slot for argonIcon |
circle |
Wrapper's shape. TRUE by default. |
size |
Wrapper size. "sm", "md" or "lg". |
status |
Wrapper color. See https://demos.creative-tim.com/argon-design-system/docs/foundation/colors.html. |
gradient_color |
icon gradient background color. |
shadow |
Whether to apply a shadow effet. TRUE by default. |
hover_shadow |
Only if shadow is TRUE. Whether to enlarge the shadow on hover. FALSE by default. |
David Granjon, [email protected]
if (interactive()) { library(argonR) argonIconWrapper( iconTag = argonIcon("atom"), size = "lg", status = "danger", shadow = TRUE, hover_shadow = TRUE ) }
if (interactive()) { library(argonR) argonIconWrapper( iconTag = argonIcon("atom"), size = "lg", status = "danger", shadow = TRUE, hover_shadow = TRUE ) }
Build an argon image container
argonImage( src = NULL, url = NULL, floating = FALSE, card_mode = FALSE, hover_lift = FALSE, width = NULL )
argonImage( src = NULL, url = NULL, floating = FALSE, card_mode = FALSE, hover_lift = FALSE, width = NULL )
src |
Image source or path. |
url |
Only with card_mode on. Optional external link. |
floating |
Whether to apply a floating effect. FALSE by default. |
card_mode |
Whether to include the image in a card wrapper. FALSE by default. |
hover_lift |
Whether to apply a lift effect on hover. FALSE by default. Not compatible with floating. Only if card_mode is TRUE. |
width |
Image manual width in px. |
David Granjon, [email protected]
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 ) }
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
argonInstall(path = getwd())
argonInstall(path = getwd())
path |
Where to store assets. By default, getwd(). |
argon assets are stored in the inst folder similarly as the package folder.
David Granjon, [email protected]
if(interactive()){ library(argonR) argonInstall() }
if(interactive()){ library(argonR) argonInstall() }
A custom p tag
argonLead(...)
argonLead(...)
... |
Any text. |
David Granjon, [email protected]
if (interactive()) { library(argonR) argonLead("Badges") }
if (interactive()) { library(argonR) argonLead("Badges") }
Change tag margins
argonMargin(tag, orientation, value)
argonMargin(tag, orientation, value)
tag |
Tag to be treated. |
orientation |
Margin side. See https://getbootstrap.com/docs/4.1/utilities/spacing/. |
value |
Margin value, negative or positive. See https://getbootstrap.com/docs/4.1/utilities/spacing/. |
David Granjon, [email protected]
if (interactive()) { library(argonR) argonMargin(tag = h1("test"), orientation = "t", value = -1) argonMargin(tag = h1("test"), orientation = "x", value = 7) }
if (interactive()) { library(argonR) argonMargin(tag = h1("test"), orientation = "t", value = -1) argonMargin(tag = h1("test"), orientation = "x", value = 7) }
Build an argon modal
argonModal(..., id, title = NULL, status = NULL, gradient = FALSE)
argonModal(..., id, title = NULL, status = NULL, gradient = FALSE)
... |
Modal body content. |
id |
Modal unique id. Should be the same as modal_id from argonButton. |
title |
Modal title. |
status |
Modal color. See https://demos.creative-tim.com/argon-design-system/docs/foundation/colors.html. |
gradient |
Modal background gradient. FALSE by default. Does not work if status is NULL. |
David Granjon, [email protected]
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." ) }
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." ) }
Apply the class muted to a text
argonMuted(...)
argonMuted(...)
... |
Any text. |
David Granjon, [email protected]
if (interactive()) { library(argonR) argonMuted(argonLead("Badges")) }
if (interactive()) { library(argonR) argonMuted(argonLead("Badges")) }
Change tag padding
argonPadding(tag, orientation, value)
argonPadding(tag, orientation, value)
tag |
Tag to be treated. |
orientation |
Padding side. See https://getbootstrap.com/docs/4.1/utilities/spacing/. |
value |
Padding value. See https://getbootstrap.com/docs/4.1/utilities/spacing/. |
David Granjon, [email protected]
if (interactive()) { library(argonR) argonPadding(tag = h1("test"), orientation = NULL, value = 5) argonPadding(tag = h1("test"), orientation = "x", value = 2) }
if (interactive()) { library(argonR) argonPadding(tag = h1("test"), orientation = NULL, value = 5) argonPadding(tag = h1("test"), orientation = "x", value = 2) }
Build an argon page
argonPage( ..., title = NULL, description = NULL, author = NULL, navbar = NULL, footer = NULL, favicon = NULL, analytics = NULL )
argonPage( ..., title = NULL, description = NULL, author = NULL, navbar = NULL, footer = NULL, favicon = NULL, analytics = NULL )
... |
Body content |
title |
App title. |
description |
Purpose. |
author |
Author. |
navbar |
Navbar. |
footer |
Footer. |
favicon |
Website favicon. The png must be located in inst/images. |
analytics |
Website analytics such as Hotjar or google analytics. Must be wrapped in tagList or list. Moreover the script must be contained in a <script></script> tag: if it is not already the case, use tags$script. |
David Granjon, [email protected]
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() ) }
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
argonPageTemplate(filename = "index", path = getwd(), argonPage, view = TRUE)
argonPageTemplate(filename = "index", path = getwd(), argonPage, view = TRUE)
filename |
HTML filename for instance, index.html. |
path |
Where to store the saved file. By default, getwd(). |
argonPage |
Slot for argonPage. |
view |
Whether to preview the page in a web browser. TRUE by default. |
Do not forget to copy the inst folder of the package to the root of your website folder.
David Granjon, [email protected]
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) }
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
argonPagination(..., size = NULL, align = NULL)
argonPagination(..., size = NULL, align = NULL)
... |
Slot for argonPaginationItem. |
size |
Pagination size: NULL, "sm" or "lg". |
align |
Pagination alignement. NULL (left), "center" or "end" (right). |
align will not work if you embed the argonPagination in an argonRow.
David Granjon, [email protected]
if(interactive()){ library(argonR) argonPagination( size = "lg", align = "center", argonPaginationItem( name = 1, src = "test.html" ), argonPaginationItem( name = 2, src = "https://www.google.com" ) ) }
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
argonPaginationItem(name, src = NULL)
argonPaginationItem(name, src = NULL)
name |
Item name. Better to use numerics such as 1, 2, 3, ... |
src |
Item target. Another html page for instance. |
David Granjon, [email protected]
Build an argon perspective effect
argonPersp(..., side)
argonPersp(..., side)
... |
Tag to be treated by the persp effect. |
side |
Perspective side effect. "right" or "left". |
Disabled on small screens (not a bug)
David Granjon, [email protected]
if (interactive()) { library(argonR) argonPersp(argonCard(), side = "right") }
if (interactive()) { library(argonR) argonPersp(argonCard(), side = "right") }
Build an argon profile card
argonProfile( ..., title = NULL, subtitle = NULL, src = NULL, url = NULL, url_1 = NULL, url_2 = NULL, stats )
argonProfile( ..., title = NULL, subtitle = NULL, src = NULL, url = NULL, url_1 = NULL, url_2 = NULL, stats )
... |
Any element. |
title |
Profile title. |
subtitle |
Profile subtitle. |
src |
Profile image path or url. |
url |
Main url. |
url_1 |
First social link. |
url_2 |
Second social link. |
stats |
Stats items. See argonProfileStats. |
Do not work on argonR. Only for argon Dash
David Granjon, [email protected]
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." ) }
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." ) }
Build an argon profile card stat item
argonProfileStat(value, description)
argonProfileStat(value, description)
value |
Stat value. |
description |
Stat description. |
David Granjon, [email protected]
Build an argon profile card stats container
argonProfileStats(...)
argonProfileStats(...)
... |
Slot for argonProfileStat. |
David Granjon, [email protected]
Build an argon progress bar
argonProgress(value, text = NULL, status = "primary")
argonProgress(value, text = NULL, status = "primary")
value |
Progress value between 0 and 100. |
text |
Label text. |
status |
Progress status color. See https://demos.creative-tim.com/argon-design-system/docs/foundation/colors.html. |
David Granjon, [email protected]
if (interactive()) { library(argonR) argonProgress(value = 10, status = "danger", text = "Custom Text") }
if (interactive()) { library(argonR) argonProgress(value = 10, status = "danger", text = "Custom Text") }
A custom quotation tool
argonQuote(..., footer = NULL, source = NULL, align = "center")
argonQuote(..., footer = NULL, source = NULL, align = "center")
... |
Any text. |
footer |
Footer content, if any. |
source |
Source if any. |
align |
Text alignement. "center", "right" or "left". |
David Granjon, [email protected]
if (interactive()) { library(argonR) argonQuote(align = "center", "I am a text") }
if (interactive()) { library(argonR) argonQuote(align = "center", "I am a text") }
Build an argon row
argonRow(..., center = FALSE)
argonRow(..., center = FALSE)
... |
Any UI element. |
center |
Whether to center row elements or not. FALSE by default. |
David Granjon, [email protected]
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() ) ) }
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() ) ) }
Build an argon section container
argonSection( ..., size = NULL, status = "default", gradient = FALSE, separator = FALSE, separator_color = "secondary", shape = FALSE, cascade = FALSE )
argonSection( ..., size = NULL, status = "default", gradient = FALSE, separator = FALSE, separator_color = "secondary", shape = FALSE, cascade = FALSE )
... |
Any UI element. |
size |
Section size. NULL by default. |
status |
Section status. See https://demos.creative-tim.com/argon-design-system/docs/foundation/colors.html. |
gradient |
Section gradient effect. FALSE by default. |
separator |
Section 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. |
shape |
Whether to include shape in the background. FALSE by default. |
cascade |
Whether to enable a cascade effect. FALSE by default. |
Do not use with the argonDash package. Only for argonR.
David Granjon, [email protected]
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() ) ) ) ) }
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() ) ) ) ) }
Build an argon social button
argonSocialButton(src = NULL, status = "default", icon = NULL)
argonSocialButton(src = NULL, status = "default", icon = NULL)
src |
Button external link. |
status |
Button color. See https://demos.creative-tim.com/argon-design-system/docs/components/buttons.html. |
icon |
Button icon. Expect icon. |
David Granjon, [email protected]
if(interactive()){ library(argonR) argonSocialButton( src = "http://rinterface.com", status = "danger", icon = icon("facebook") ) }
if(interactive()){ library(argonR) argonSocialButton( src = "http://rinterface.com", status = "danger", icon = icon("facebook") ) }
Build an argon tab item
argonTab(..., tabName, active = FALSE)
argonTab(..., tabName, active = FALSE)
... |
Tab content |
tabName |
Tab name: it will be also passed as the id argument. Should be unique. |
active |
Whether the tab is active or not. FALSE bu default. |
David Granjon, [email protected]
Build an argon tabs
argonTabSet( ..., id, card_wrapper = FALSE, horizontal = TRUE, circle = FALSE, size = "sm", width = 6, iconList = NULL )
argonTabSet( ..., id, card_wrapper = FALSE, horizontal = TRUE, circle = FALSE, size = "sm", width = 6, iconList = NULL )
... |
Slot for argonTab. |
id |
argonTabs id. Should be unique. |
card_wrapper |
Whether to embed tab content in a card. FALSE by default. |
horizontal |
Whether to display tabs horizontally. TRUE by default. |
circle |
Whether to display circled design. FALSE by default. |
size |
Tabs size. "sm" by default. "md", "lg". |
width |
Tabs width. Between 1 and 12. |
iconList |
A list of argonIcon or icon. The lenght must have the same length as the number of tabs. NULL by default. |
David Granjon, [email protected]
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" ) ) }
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" ) ) }
A custom color fo your text
argonTextColor(tag, color)
argonTextColor(tag, color)
tag |
Any tag containing text. |
color |
Text color. See https://demos.creative-tim.com/argon-design-system/docs/foundation/colors.html. |
David Granjon, [email protected]
if (interactive()) { library(argonR) library(htmltools) argonTextColor( tag = h1("test"), color = "success" ) }
if (interactive()) { library(argonR) library(htmltools) argonTextColor( tag = h1("test"), color = "success" ) }
Create a boostrap 4 tooltip
argonTooltip(tag, position, title = NULL)
argonTooltip(tag, position, title = NULL)
tag |
Tag to be documented. |
position |
Where to display the toolptip: "top", "right", "bottom" or "left". |
title |
Tooltip title. |
David Granjon, [email protected]
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." ) ) }
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." ) ) }
Build an argon user image
argonUser(..., title = NULL, subtitle = NULL, src = NULL)
argonUser(..., title = NULL, subtitle = NULL, src = NULL)
... |
Any element such as argonIcon... |
title |
User title. |
subtitle |
User subtitle. |
src |
User image url or path. |
David Granjon, [email protected]
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" ) }
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" ) }