Contributor Covenant Code of Conduct
@@ -115,115 +54,96 @@Contributor Covenant Code of Conduct
-Our Pledge
+Our Pledge
We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
-Our Standards
+Our Standards
Examples of behavior that contributes to a positive environment for our community include:
--
-
- Demonstrating empathy and kindness toward other people +
- Demonstrating empathy and kindness toward other people
- Being respectful of differing opinions, viewpoints, and experiences
- Giving and gracefully accepting constructive feedback
- Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
- Focusing on what is best not just for us as individuals, but for the overall community -
- The use of sexualized language or imagery, and sexual attention or advances of any kind +
- The use of sexualized language or imagery, and sexual attention or advances of any kind
- Trolling, insulting or derogatory comments, and personal or political attacks
- Public or private harassment
- Publishing others’ private information, such as a physical or email address, without their explicit permission
- Other conduct which could reasonably be considered inappropriate in a professional setting -
Examples of unacceptable behavior include:
--
-
Examples of unacceptable behavior include:
+Enforcement Responsibilities
Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
-Scope
+Scope
This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
-Enforcement
+Enforcement
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at [INSERT CONTACT METHOD]. All complaints will be reviewed and investigated promptly and fairly.
All community leaders are obligated to respect the privacy and security of the reporter of any incident.
-Enforcement Guidelines
+Enforcement Guidelines
Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
--1. Correction
+1. Correction
Community Impact: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
Consequence: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
-2. Warning
+2. Warning
Community Impact: A violation through a single incident or series of actions.
Consequence: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
-3. Temporary Ban
+3. Temporary Ban
Community Impact: A serious violation of community standards, including sustained inappropriate behavior.
Consequence: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
-4. Permanent Ban
+4. Permanent Ban
Community Impact: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior, harassment of an individual, or aggression toward or disparagement of classes of individuals.
Consequence: A permanent ban from any sort of public interaction within the community.
-Attribution
-This Code of Conduct is adapted from the Contributor Covenant, version 2.0, available at https://www.contributor-covenant.org/version/2/0/ code_of_conduct.html.
-Community Impact Guidelines were inspired by Mozilla’s code of conduct enforcement ladder.
-For answers to common questions about this code of conduct, see the FAQ at https://www.contributor-covenant.org/faq. Translations are available at https:// www.contributor-covenant.org/translations.
+Attribution
+This Code of Conduct is adapted from the Contributor Covenant, version 2.0, available at https://www.contributor-covenant.org/version/2/0/ code_of_conduct.html.
+Community Impact Guidelines were inspired by Mozilla’s code of conduct enforcement ladder.
+For answers to common questions about this code of conduct, see the FAQ at https://www.contributor-covenant.org/faq. Translations are available at https:// www.contributor-covenant.org/translations.
Authors
+ +Citation
+ Source:DESCRIPTION
+ -
-
-
-
David Granjon. Author, maintainer. -
-
- -
-
RinteRface. Copyright holder. -
-
- -
-
Creative Tim. Contributor, copyright holder. -
-
Argon theme for Bootstrap 4
-
Granjon D (2024). +argonDash: Argon Shiny Dashboard Template. +R package version 0.3.0.9000, https://rinterface.github.io/argonDash/, https://github.com/RinteRface/argonDash. +
+@Manual{,
+ title = {argonDash: Argon Shiny Dashboard Template},
+ author = {David Granjon},
+ year = {2024},
+ note = {R package version 0.3.0.9000, https://rinterface.github.io/argonDash/},
+ url = {https://github.com/RinteRface/argonDash},
+}
Authors
--
-
+
@@ -70,112 +71,112 @@
- - + + diff --git a/reference/argonDropNav.html b/reference/argonDropNav.html index 0a078cc..acb818d 100644 --- a/reference/argonDropNav.html +++ b/reference/argonDropNav.html @@ -1,67 +1,12 @@ - - - - - - - --- - + + diff --git a/reference/argonDashSidebar.html b/reference/argonDashSidebar.html index 7d2872b..96b5f99 100644 --- a/reference/argonDashSidebar.html +++ b/reference/argonDashSidebar.html @@ -1,67 +1,12 @@ - - - - - - - --- - + + diff --git a/reference/argonDashPage.html b/reference/argonDashPage.html index 8df842c..93c7d43 100644 --- a/reference/argonDashPage.html +++ b/reference/argonDashPage.html @@ -1,67 +1,12 @@ - - - - - - - -- - + + diff --git a/reference/argonDashNavbar.html b/reference/argonDashNavbar.html index 9804890..3e12952 100644 --- a/reference/argonDashNavbar.html +++ b/reference/argonDashNavbar.html @@ -1,67 +1,12 @@ - - - - - - - -
-argonDash
++ - +- - + + diff --git a/reference/argonDashHeader.html b/reference/argonDashHeader.html index f39eec0..551b97b 100644 --- a/reference/argonDashHeader.html +++ b/reference/argonDashHeader.html @@ -1,67 +1,12 @@ - - - - - - - -
-argon Bootstrap4 dashboard template for Shiny
-+-Installation
-argonDash requires to install argonR.
++-Installation +
+argonDash requires to install argonR.
--
install.packages("argonR") -# devel version -devtools::install_github("RinteRface/argonDash") -# from CRAN -install.packages("argonDash")-+-Demo
-See a demonstration on shinyapps.io.
+install.packages("argonR") +# devel version +devtools::install_github("RinteRface/argonDash") +# from CRAN +install.packages("argonDash")+- - + + diff --git a/reference/argonDashGallery.html b/reference/argonDashGallery.html index ed8516b..fb1a700 100644 --- a/reference/argonDashGallery.html +++ b/reference/argonDashGallery.html @@ -1,67 +1,12 @@ - - - - - - - -Demo +
+See a demonstration on shinyapps.io.
--+ - --Vertical layout
+library(argonDash) +argonDashGallery()-@@ -184,5 +185,7 @@-Aknowledgement
++-Aknowledgement +
- -Creative Tim for designing the original argon dashboard HTML template. +Creative Tim for designing the original argon dashboard HTML template.
--Code of Conduct
-Please note that the argonDash project is released with a Contributor Code of Conduct. By contributing to this project, you agree to abide by its terms.
++Code of Conduct +
+Please note that the argonDash project is released with a Contributor Code of Conduct. By contributing to this project, you agree to abide by its terms.
Dev status
+ + diff --git a/news/index.html b/news/index.html index 61a0183..c3b8c71 100644 --- a/news/index.html +++ b/news/index.html @@ -1,66 +1,12 @@ - - - - - - - -Changelog • argonDash - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Changelog • argonDash - - + + - - --- - + + diff --git a/reference/argonDashFooter.html b/reference/argonDashFooter.html index a843556..47e008b 100644 --- a/reference/argonDashFooter.html +++ b/reference/argonDashFooter.html @@ -1,67 +1,12 @@ - - - - - - - -- - - -+- - + + diff --git a/reference/argonDashBody.html b/reference/argonDashBody.html index e13b62b..8fcaaab 100644 --- a/reference/argonDashBody.html +++ b/reference/argonDashBody.html @@ -1,67 +1,12 @@ - - - - - - - -- - + + diff --git a/reference/argonAvatars.html b/reference/argonAvatars.html index 1c1438b..e20dceb 100644 --- a/reference/argonAvatars.html +++ b/reference/argonAvatars.html @@ -1,67 +1,12 @@ - - - - - - - --- - + + diff --git a/pkgdown.css b/pkgdown.css index 1273238..80ea5b8 100644 --- a/pkgdown.css +++ b/pkgdown.css @@ -56,8 +56,10 @@ img.icon { float: right; } -img { +/* Ensure in-page images don't run outside their container */ +.contents img { max-width: 100%; + height: auto; } /* Fix bug in bootstrap (only seen in firefox) */ @@ -78,11 +80,10 @@ dd { /* Section anchors ---------------------------------*/ a.anchor { - margin-left: -30px; - display:inline-block; - width: 30px; - height: 30px; - visibility: hidden; + display: none; + margin-left: 5px; + width: 20px; + height: 20px; background-image: url(./link.svg); background-repeat: no-repeat; @@ -90,17 +91,15 @@ a.anchor { background-position: center center; } -.hasAnchor:hover a.anchor { - visibility: visible; -} - -@media (max-width: 767px) { - .hasAnchor:hover a.anchor { - visibility: hidden; - } +h1:hover .anchor, +h2:hover .anchor, +h3:hover .anchor, +h4:hover .anchor, +h5:hover .anchor, +h6:hover .anchor { + display: inline-block; } - /* Fixes for fixed navbar --------------------------*/ .contents h1, .contents h2, .contents h3, .contents h4 { @@ -264,31 +263,26 @@ table { /* Syntax highlighting ---------------------------------------------------- */ -pre { - word-wrap: normal; - word-break: normal; - border: 1px solid #eee; -} - -pre, code { +pre, code, pre code { background-color: #f8f8f8; color: #333; } +pre, pre code { + white-space: pre-wrap; + word-break: break-all; + overflow-wrap: break-word; +} -pre code { - overflow: auto; - word-wrap: normal; - white-space: pre; +pre { + border: 1px solid #eee; } -pre .img { +pre .img, pre .r-plt { margin: 5px 0; } -pre .img img { +pre .img img, pre .r-plt img { background-color: #fff; - display: block; - height: auto; } code a, pre a { @@ -305,9 +299,8 @@ a.sourceLine:hover { .kw {color: #264D66;} /* keyword */ .co {color: #888888;} /* comment */ -.message { color: black; font-weight: bolder;} -.error { color: orange; font-weight: bolder;} -.warning { color: #6A0366; font-weight: bolder;} +.error {font-weight: bolder;} +.warning {font-weight: bolder;} /* Clipboard --------------------------*/ @@ -365,3 +358,27 @@ mark { content: ""; } } + +/* Section anchors --------------------------------- + Added in pandoc 2.11: https://github.com/jgm/pandoc-templates/commit/9904bf71 +*/ + +div.csl-bib-body { } +div.csl-entry { + clear: both; +} +.hanging-indent div.csl-entry { + margin-left:2em; + text-indent:-2em; +} +div.csl-left-margin { + min-width:2em; + float:left; +} +div.csl-right-inline { + margin-left:2em; + padding-left:1em; +} +div.csl-indent { + margin-left: 2em; +} diff --git a/pkgdown.js b/pkgdown.js index 7e7048f..6f0eee4 100644 --- a/pkgdown.js +++ b/pkgdown.js @@ -80,7 +80,7 @@ $(document).ready(function() { var copyButton = ""; - $(".examples, div.sourceCode").addClass("hasCopyButton"); + $("div.sourceCode").addClass("hasCopyButton"); // Insert copy buttons: $(copyButton).prependTo(".hasCopyButton"); @@ -91,7 +91,7 @@ // Initialize clipboard: var clipboardBtnCopies = new ClipboardJS('[data-clipboard-copy]', { text: function(trigger) { - return trigger.parentNode.textContent; + return trigger.parentNode.textContent.replace(/\n#>[^\n]*/g, ""); } }); diff --git a/pkgdown.yml b/pkgdown.yml index 83a0b61..04289a4 100644 --- a/pkgdown.yml +++ b/pkgdown.yml @@ -1,6 +1,6 @@ -pandoc: 2.7.3 -pkgdown: 1.6.1 +pandoc: 2.19.2 +pkgdown: 2.0.7 pkgdown_sha: ~ articles: {} -last_built: 2021-11-18T17:30Z +last_built: 2024-01-16T21:04Z diff --git a/reference/argonAvatar.html b/reference/argonAvatar.html index 01a348a..3aa8e4d 100644 --- a/reference/argonAvatar.html +++ b/reference/argonAvatar.html @@ -1,67 +1,12 @@ - - - - - - - ----argonDash 0.3.0.9000 Unreleased -
----Bug fix
--
-
- Fix issue in
argonDashGallery()++argonDash 0.3.0.9000
+++Bug fix
+- Fix issue in
argonDashGallery()
-
- Fix issue in
--argonDash 0.2.0 2019-11-27 -
- --+-Documentation
--
-
- revamp the gallery +
- revamp the gallery
- Better documentation of
argonDashPage()
- - add min-height to body
- add
argonTable(),argonTableItems()andargonTableItem() - add
argonAvatars()andargonAvatar()
- - Fix #12: reduce vertical space between brand logo and menu items in
argonDashSidebar(). Thanks @ShixiangWang
+ - Fix #12: reduce vertical space between brand logo and menu items in
argonDashSidebar(). Thanks @ShixiangWang - fix issue in
argonInfoCard()when stat is NULL
- - fix #3 thanks @noahbishop: when vertical is FALSE in the
argonDashSidebar(), navbar elements are horizontally displayed, as expected
- - fix #3 thanks @noahbishop: when vertical is FALSE in the
argonDashSidebar(), navbar elements are horizontally displayed, as expected
+ - fix #21: icon_background has a default value in
argonInfoCard(). Thanks @tusharmajhi9
+ - fix #20: Remove hardcoded stat parameter, leave it user defined. Thanks @mkaranja +
- fix #10: allow to programmatically set the value of ‘stat’ in the
argonInfoCard(). Thanks @Patrikios
+ - fix #2:
argonDropdown()correctly render in the navbar
+ - fix #21: icon_background has a default value in
argonInfoCard(). Thanks @tusharmajhi9
- - fix #20: Remove hardcoded stat parameter, leave it user defined. Thanks @mkaranja -
- fix #10: allow to programmatically set the value of ‘stat’ in the
argonInfoCard(). Thanks @Patrikios
- - fix #2:
argonDropdown()correctly render in the navbar
- - Change icon args of
argonDropNavItem(),argonSidebarItem()andargonInfoCard()-
- - remove icon_color arg from
argonSidebarItem()-
- - stat_icon arg of
argonInfoCard()can use eithericon()orargonIcon()-
-
+- +argonDash 0.2.02019-11-27
+ ++- +Documentation
+++Minor improvement
+++Bug fix
++-Breaking changes
+In order to enable user to choose between
shiny::icon()andargonR::argonIcon(): - Change icon args ofargonDropNavItem(),argonSidebarItem()andargonInfoCard()- remove icon_color arg fromargonSidebarItem()- stat_icon arg ofargonInfoCard()can use eithericon()orargonIcon()---Bug fix
--
-
---Breaking changes
-In order to enable user to choose between
-shiny::icon()andargonR::argonIcon():-
-
Create a Boostrap 4 avatar — argonAvatar • argonDash - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Create a Boostrap 4 avatar — argonAvatar • argonDash - - - - + + ---- - - -++@@ -120,54 +58,50 @@-Create a Boostrap 4 avatar
Build an argon avatar
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
- -David Granjon, dgranjon@ymail.com
+++ ++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".
+
+
Create a Boostrap 4 avatar container — argonAvatars • argonDash - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Create a Boostrap 4 avatar container — argonAvatars • argonDash - - - - + + ---- - - -++-@@ -120,46 +58,42 @@Create a Boostrap 4 avatar container
- Source:R/useful-items.R+ Source:R/useful-items.RargonAvatars.RdCreate a Boostrap 4 avatar container
Build an argon avatar container
argonAvatars(...)
- -Arguments
--
+- -... -Slot for argonAvatar.
+-+argonAvatars(...)Author
+++Arguments
+- ... +
Slot for argonAvatar.
-
David Granjon, dgranjon@ymail.com
+Create a Boostrap 4 dashboard body — argonDashBody • argonDash - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Create a Boostrap 4 dashboard body — argonDashBody • argonDash - - - - + + ---- - - -++-@@ -120,46 +58,42 @@Create a Boostrap 4 dashboard body
- Source:R/dashboardBody.R+ Source:R/dashboardBody.RargonDashBody.RdCreate a Boostrap 4 dashboard body
Build an argon dashboard body
argonDashBody(...)
- -Arguments
--
+- -... -Body content, slot for argonTabItems
+-+argonDashBody(...)Author
+++Arguments
+- ... +
Body content, slot for argonTabItems
-
David Granjon, dgranjon@ymail.com
+Create a Boostrap 4 dashboard footer — argonDashFooter • argonDash - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Create a Boostrap 4 dashboard footer — argonDashFooter • argonDash - - - - + + ---- - - -++-@@ -120,54 +58,50 @@Create a Boostrap 4 dashboard footer
- Source:R/dashboardFooter.R+ Source:R/dashboardFooter.RargonDashFooter.RdCreate a Boostrap 4 dashboard footer
Build an argon dashboard footer
argonDashFooter(..., copyrights = NULL, src = NULL)
- -Arguments
--
- -- -... -Slot for argonFooterMenu.
- -copyrights -Left text, if any.
- -src -Left text src, if any.
Author
- -David Granjon, dgranjon@ymail.com
+++ ++argonDashFooter(..., copyrights = NULL, src = NULL)++Arguments
+- ... +
Slot for argonFooterMenu.
+
+
+- copyrights +
Left text, if any.
+
+
+- src +
Left text src, if any.
+
+
Launch the argonDash Gallery — argonDashGallery • argonDash - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Launch the argonDash Gallery — argonDashGallery • argonDash - - - - + + ---- - - -++-@@ -120,43 +58,42 @@Launch the argonDash Gallery
- Source:R/argonDashGallery.R+ Source:R/argonDashGallery.RargonDashGallery.RdLaunch the argonDash Gallery
A gallery of all components available in argonDash.
argonDashGallery()
- ++-+argonDashGallery()Examples
--if (interactive()) { - - argonDashGallery() - -} -
++Examples
+++if (interactive()) { + + argonDashGallery() + +} +Create a Boostrap 4 dashboard header — argonDashHeader • argonDash - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Create a Boostrap 4 dashboard header — argonDashHeader • argonDash + + - - - - ---- - - -++-@@ -120,98 +58,94 @@Create a Boostrap 4 dashboard header
- Source:R/dashboardHeader.R+ Source:R/dashboardHeader.RargonDashHeader.RdCreate a Boostrap 4 dashboard header
Build an argon dashboard header
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
- -David Granjon, dgranjon@ymail.com
+++ ++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.
+
+
Create a Boostrap 4 dashboard navbar — argonDashNavbar • argonDash - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Create a Boostrap 4 dashboard navbar — argonDashNavbar • argonDash - - - - + + ---- - - -++-@@ -120,46 +58,42 @@Create a Boostrap 4 dashboard navbar
- Source:R/dashboardNavbar.R+ Source:R/dashboardNavbar.RargonDashNavbar.RdCreate a Boostrap 4 dashboard navbar
Build an argon dashboard navbar
argonDashNavbar(...)
- -Arguments
--
+- -... -Any element such as argonDropNav.
+-+argonDashNavbar(...)Author
+++Arguments
+- ... +
Any element such as argonDropNav.
-
David Granjon, dgranjon@ymail.com
+Create a Boostrap 4 dashboard page — argonDashPage • argonDash - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Create a Boostrap 4 dashboard page — argonDashPage • argonDash - - + + - - ---- - - -++-@@ -120,96 +58,94 @@Create a Boostrap 4 dashboard page
- Source:R/dashboardPage.R+ Source:R/dashboardPage.RargonDashPage.RdCreate a Boostrap 4 dashboard page
Build an argon dashboard page
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
- -David Granjon, dgranjon@ymail.com
- -Examples
-if(interactive()){ - library(shiny) - library(argonDash) - - shiny::shinyApp( - ui = argonDashPage(), - server = function(input, output) {} - ) -} - -
+++ ++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.
+
+
Create a Boostrap 4 dashboard sidebar — argonDashSidebar • argonDash - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Create a Boostrap 4 dashboard sidebar — argonDashSidebar • argonDash - - + + - - ---- - - -++-@@ -120,94 +58,90 @@Create a Boostrap 4 dashboard sidebar
- Source:R/dashboardSidebar.R+ Source:R/dashboardSidebar.RargonDashSidebar.RdCreate a Boostrap 4 dashboard sidebar
Build an argon dashboard sidebar
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
- -brand_logo -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
- -David Granjon, dgranjon@ymail.com
++ ++ +++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
+
+
+- brand_logo +
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.
+
+
Create a Boostrap 4 dashboard dropdown menu — argonDropNav • argonDash - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -Create a Boostrap 4 dashboard dropdown menu — argonDropNav • argonDash - - + + - - ---- - - -++-@@ -120,58 +58,54 @@Create a Boostrap 4 dashboard dropdown menu
- Source:R/dashboardNavbar.R+ Source:R/dashboardNavbar.RargonDropNav.RdCreate a Boostrap 4 dashboard dropdown menu
Build an argon dashboard dropdown menu
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
- -David Granjon, dgranjon@ymail.com
+++ ++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".
+
+
Create a Boostrap 4 dashboard dropdown menu divider
- Source:R/dashboardNavbar.R
+ Source: R/dashboardNavbar.R
argonDropNavDivider.RdCreate a Boostrap 4 dashboard dropdown menu divider
Build an argon dashboard dropdown menu divider
argonDropNavDivider()- - -
Author
+argonDropNavDivider()David Granjon, dgranjon@ymail.com
+Create a Boostrap 4 dashboard dropdown menu item
- Source:R/dashboardNavbar.R
+ Source: R/dashboardNavbar.R
argonDropNavItem.RdCreate a Boostrap 4 dashboard dropdown menu item
Build an argon dashboard dropdown menu item
argonDropNavItem(title = NULL, src = NULL, icon = NULL)- -
Arguments
-| title | -Item title. |
-
|---|---|
| src | -External link. |
-
| icon | -Icon, if any. Expect argonIcon or icon. |
-
Author
- -David Granjon, dgranjon@ymail.com
+argonDropNavItem(title = NULL, src = NULL, icon = NULL)Arguments
+- title +
Item title.
+
+
+- src +
External link.
+
+
+- icon +
Icon, if any. Expect argonIcon or icon.
+
+
Create a Boostrap 4 dashboard dropdown menu title
- Source:R/dashboardNavbar.R
+ Source: R/dashboardNavbar.R
argonDropNavTitle.RdCreate a Boostrap 4 dashboard dropdown menu title
Build an argon dashboard dropdown menu title
argonDropNavTitle(title = NULL)- -
Arguments
-| title | -Menu title. |
-
|---|
argonDropNavTitle(title = NULL)Author
+Arguments
+- title +
Menu title.
-
David Granjon, dgranjon@ymail.com
+Create a Boostrap 4 dashboard footer menu item
- Source:R/dashboardFooter.R
+ Source: R/dashboardFooter.R
argonFooterItem.RdCreate a Boostrap 4 dashboard footer menu item
Build an argon dashboard footer menu item
argonFooterItem(..., src = NULL)+
argonFooterItem(..., src = NULL)Arguments
-| ... | -Item name. |
-
|---|---|
| src | -Item external link. |
-
Arguments
+- ... +
Item name.
- - src +
Item external link.
+
+
Author
-David Granjon, dgranjon@ymail.com
+Create a Boostrap 4 dashboard footer menu
- Source:R/dashboardFooter.R
+ Source: R/dashboardFooter.R
argonFooterMenu.RdCreate a Boostrap 4 dashboard footer menu
Build an argon dashboard footer menu
argonFooterMenu(...)- -
Arguments
-| ... | -Slot for argonFooterItem. |
-
|---|
argonFooterMenu(...)Author
+Arguments
+- ... +
Slot for argonFooterItem.
-
David Granjon, dgranjon@ymail.com
+Create a Boostrap 4 dashboard info card
- Source:R/useful-items.R
+ Source: R/useful-items.R
argonInfoCard.RdCreate a Boostrap 4 dashboard info card
Build an argon dashboard info card
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
- -David Granjon, dgranjon@ymail.com
+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.
+
+
A divider to put inside argonDashSidebar
- Source:R/dashboardSidebar.R
+ A divider to put inside argonDashSidebar
+ Source:R/dashboardSidebar.R
argonSidebarDivider.RdA divider to put inside argonDashSidebar
+A divider to put inside argonDashSidebar
argonSidebarDivider()- +
argonSidebarDivider()A header to put inside argonDashSidebar
- Source:R/dashboardSidebar.R
+ A header to put inside argonDashSidebar
+ Source:R/dashboardSidebar.R
argonSidebarHeader.RdA header to put inside argonDashSidebar
+A header to put inside argonDashSidebar
argonSidebarHeader(title = NULL)+
argonSidebarHeader(title = NULL)Arguments
-| title | -Header title |
-
|---|
Arguments
+- title +
Header title
+
Create a Boostrap 4 argon sidebar menu
- Source:R/dashboardSidebar.R
+ Source: R/dashboardSidebar.R
argonSidebarItem.RdCreate a Boostrap 4 argon sidebar menu
Build an argon dashboard main sidebar menu
argonSidebarItem(..., tabName = NULL, icon = NULL)- -
Arguments
-| ... | -Item name. |
-
|---|---|
| tabName | -Should correspond exactly to the tabName given in |
-
| icon | -Item icon. argonIcon or icon. |
-
Author
- -David Granjon, dgranjon@ymail.com
+argonSidebarItem(..., tabName = NULL, icon = NULL)Arguments
+- ... +
Item name.
+
+
+- tabName +
Should correspond exactly to the tabName given in
argonTabItem.
+
+
+- icon +
Item icon. argonIcon or icon.
+
+
Create a Boostrap 4 argon sidebar menu
- Source:R/dashboardSidebar.R
+ Source: R/dashboardSidebar.R
argonSidebarMenu.RdCreate a Boostrap 4 argon sidebar menu
Build an argon dashboard main sidebar menu
argonSidebarMenu(...)- -
Arguments
-| ... | -Slot for argonSidebarItem. |
-
|---|
argonSidebarMenu(...)Author
+Arguments
+- ... +
Slot for argonSidebarItem.
-
David Granjon, dgranjon@ymail.com
+One tab to put inside a tab items container
- Source:R/dashboardBody.R
+ Source: R/dashboardBody.R
argonTabItem.RdOne tab to put inside a tab items container
One tab to put inside a tab items container
argonTabItem(tabName = NULL, ...)+
argonTabItem(tabName = NULL, ...)Arguments
+- tabName +
The name of a tab. This must correspond to the
tabName+of aargonSidebarItem.
- - ... +
Contents of the tab.
+
+
Arguments
-| tabName | -The name of a tab. This must correspond to the |
-
|---|---|
| ... | -Contents of the tab. |
-
A container for tab items
A container for tab items
argonTabItems(...)+
argonTabItems(...)Arguments
-| ... | -Items to put in the container. Each item should be a
- |
-
|---|
Arguments
+- ... +
Items to put in the container. Each item should be a +
argonTabItem.
+
Create a Boostrap 4 table container
- Source:R/useful-items.R
+ Source: R/useful-items.R
argonTable.RdCreate a Boostrap 4 table container
Build an argon table container
argonTable( - ..., - cardWrap = FALSE, - title = NULL, - headTitles, - dark = FALSE, - width = 12 -)- -
Arguments
-| ... | -- |
|---|---|
| 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
- -David Granjon, dgranjon@ymail.com
- -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) { } - ) -} - - -+
argonTable(
+ ...,
+ cardWrap = FALSE,
+ title = NULL,
+ headTitles,
+ dark = FALSE,
+ width = 12
+)Arguments
+- ... +
- + + +
- 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.
+
+
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
- Source:R/useful-items.R
+ Source: R/useful-items.R
argonTableItem.RdCreate a Boostrap 4 table item
Build an argon table item
argonTableItem(..., dataCell = FALSE)+
argonTableItem(..., dataCell = FALSE)Arguments
-| ... | -Any HTML element. |
-
|---|---|
| dataCell | -Whether the cell should be contain data or text. <td> by default. |
-
Arguments
+- ... +
Any HTML element.
- - dataCell +
Whether the cell should be contain data or text. <td> by default.
+
+
Author
-David Granjon, dgranjon@ymail.com
+Create a Boostrap 4 table item row
- Source:R/useful-items.R
+ Source: R/useful-items.R
argonTableItems.RdCreate a Boostrap 4 table item row
Build an argon table item row
argonTableItems(...)- -
Arguments
-| ... | -Slot for argonTableItem. |
-
|---|
argonTableItems(...)Author
+Arguments
+- ... +
Slot for argonTableItem.
-
David Granjon, dgranjon@ymail.com
+Reference
Assert that a tag has specified properties
Assert that a tag has specified properties
tagAssert(tag, type = NULL, class = NULL, allowUI = TRUE)- -
Arguments
-| tag | -A tag object. |
-
|---|---|
| type | -The type of a tag, like "div", "a", "span". |
-
| class | -An HTML class. |
-
| allowUI | -If TRUE (the default), allow dynamic outputs generated by
-
+
+
+
+ Arguments+
|
-