Merge develop to master

.Rbuildignore

@@ -16,4 +16,5 @@ development
 ^tools$
 ^srcjs$
 ^styles$
-^_pkgdown\.yml$
+pkgdown
+.lintr

.github/workflows/main.yml

@@ -3,74 +3,51 @@ on: push
 name: R-CMD-check
 
 jobs:
-  R-CMD-check:
+  main:
+    name: ${{ matrix.config.os }} (${{ matrix.config.r }})
+
     runs-on: ${{ matrix.config.os }}
 
-    name: ${{ matrix.config.os }} (${{ matrix.config.r }})
+    timeout-minutes: 30
 
     strategy:
       fail-fast: false
       matrix:
         config:
-        - { os: windows-latest, r: '3.6'}
-        - { os: macOS-latest, r: '3.6'}
-        - { os: ubuntu-18.04, r: '3.6', cran: "https://demo.rstudiopm.com/all/__linux__/bionic/latest"}
-
-    env:
-      R_REMOTES_NO_ERRORS_FROM_WARNINGS: true
-      CRAN: ${{ matrix.config.cran }}
+        - {os: macOS-latest,   r: 'release'}
+        - {os: windows-latest, r: 'release'}
+        - {os: ubuntu-22.04, r: 'devel'}
+        - {os: ubuntu-22.04, r: 'release'}
+        - {os: ubuntu-22.04, r: 'oldrel'}
 
     steps:
-      - uses: actions/checkout@v1
+      - name: Checkout repository
+        uses: actions/checkout@v2
 
-      - uses: r-lib/actions/setup-r@master
+      - name: Install R
+        uses: r-lib/actions/setup-r@v2
         with:
           r-version: ${{ matrix.config.r }}
 
-      - uses: r-lib/actions/setup-pandoc@master
-
-      - name: Query dependencies
-        run: Rscript -e "install.packages('remotes')" -e "saveRDS(remotes::dev_package_deps(dependencies = TRUE), 'depends.Rds', version = 2)"
-
-      - name: Cache R packages
-        if: runner.os != 'Windows'
-        uses: actions/cache@v1
+      - name: Install R package dependencies
+        uses: r-lib/actions/setup-r-dependencies@v2
         with:
-          path: ${{ env.R_LIBS_USER }}
-          key: ${{ runner.os }}-r-${{ matrix.config.r }}-${{ hashFiles('depends.Rds') }}
-          restore-keys: ${{ runner.os }}-r-${{ matrix.config.r }}-
+          extra-packages: local::. # Necessary to avoid object usage linter errors.
 
-      - name: Install system dependencies
-        if: runner.os == 'Linux'
-        env:
-          RHUB_PLATFORM: linux-x86_64-ubuntu-gcc
-        run: |
-          Rscript -e "remotes::install_github('r-hub/sysreqs')"
-          sysreqs=$(Rscript -e "cat(sysreqs::sysreq_commands('DESCRIPTION'))")
-          sudo -s eval "$sysreqs"
-
-      - name: Install vctrs
-        if: runner.os == 'Windows'
-        run: Rscript -e "remotes::install_cran('vctrs')"
-
-      - name: Install vctrs
-        if: runner.os == 'macos'
-        run: Rscript -e "remotes::install_cran('Rcpp')"
-
-      - name: Install dependencies
-        run: Rscript -e "library(remotes)" -e "update(readRDS('depends.Rds'))" -e "remotes::install_cran('rcmdcheck')"
-
-      - name: Check
-        run: Rscript -e "rcmdcheck::rcmdcheck(args = c('--no-manual', '--as-cran'), error_on = 'error', check_dir = 'check')"
-
-      - name: Upload check results
-        if: failure()
-        uses: actions/upload-artifact@master
+      - name: R CMD check
+        if: always()
+        uses: r-lib/actions/check-r-package@v2
         with:
-          name: ${{ runner.os }}-r${{ matrix.config.r }}-results
-          path: check
+          error-on: '"note"'
 
+      - name: Lint
+        if: always()
+        shell: Rscript {0}
+        run: |
+          lints <- lintr::lint_package()
+          for (lint in lints) print(lint)
+          quit(status = length(lints) > 0)
       - name: Test coverage
-        if: matrix.config.os == 'macOS-latest' && matrix.config.r == '3.6'
+        if: matrix.config.os == 'ubuntu-22.04' && matrix.config.r == 'release'
         run: |
           Rscript -e 'covr::codecov(token = "${{secrets.CODECOV_TOKEN}}")'

.github/workflows/pkgdown.yml

@@ -0,0 +1,34 @@
+# Workflow derived from https://github.com/r-lib/actions/tree/v2/examples
+# Need help debugging build failures? Start at https://github.com/r-lib/actions#where-to-find-help
+on:
+  push:
+    branches:
+      - develop
+  workflow_dispatch:
+
+name: pkgdown
+
+jobs:
+  pkgdown:
+    runs-on: ubuntu-latest
+    env:
+      GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }}
+    steps:
+      - uses: actions/checkout@v2
+
+      - uses: r-lib/actions/setup-pandoc@v2
+
+      - uses: r-lib/actions/setup-r@v2
+        with:
+          use-public-rspm: true
+
+      - uses: r-lib/actions/setup-r-dependencies@v2
+        with:
+          extra-packages: any::pkgdown, local::.
+          needs: website
+
+      - name: Deploy to gh-pages branch
+        run: |
+          git config --local user.name "$GITHUB_ACTOR"
+          git config --local user.email "$GITHUB_ACTOR@users.noreply.github.com"
+          Rscript -e 'pkgdown::deploy_to_branch(new_process = FALSE)'

.gitignore

@@ -1,3 +1,5 @@
+.DS_Store
+
 # History files
 .Rhistory
 .Rapp.history
@@ -33,3 +35,4 @@ vignettes/*.pdf
 *.knit.md
 .Rproj.user
 
+/docs/

.lintr

@@ -0,0 +1,9 @@
+linters:
+  linters_with_defaults(
+    line_length_linter = line_length_linter(100),
+    object_name_linter = NULL
+  )
+exclusions:
+  c(
+    "vignettes"
+  )

CHANGELOG.md

@@ -5,6 +5,8 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/).
 
 ## [Unreleased]
 ### Added
+- `sidebarUserPanel` was added increasing support of `shinydashboard` functions
+
 ### Changed
 ### Fixed
 ### Removed
@@ -17,7 +19,7 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/).
 - `fluid` param for `tabItem`
 - `class` param for `dashboardPage`, `dashboardBody`, `dashboardSidebar` and `dashboardHeader` 
 - `dashboardPage`, `dashboardBody`, `dashboardSidebar` and `dashboardHeader` have now built-in CSS classes of syntax `dashboard-<component>` e.g. `dashboard-page`. Thanks to that it's easy to write selectors for DOM nodes related to them
-- pkgdown docuemntation
+- pkgdown documentation
 - tests for dropdown menu, utils and value box
 
 ### Changed

DESCRIPTION

@@ -1,17 +1,17 @@
 Package: semantic.dashboard
 Type: Package
 Title: Dashboard with Fomantic UI Support for Shiny
-Version: 0.2.0
+Version: 0.2.1
 Authors@R: c(person("Filip", "Stachura", email = "filip@appsilon.com", role = "aut"),
-  person("Dominik", "Krzeminski", email = "dominik@appsilon.com", role = "cre"),
+  person("Dominik", "Krzeminski", email = "dominik@appsilon.com", role = "aut"),
   person("Krystian", "Igras", role = "aut"),
   person("Michał", "Maj", role = "ctb"),
   person("Michał", "Drzazga", role = "ctb"),
+  person("Developers", "Appsilon", email = "support+opensource@appsilon.com", role = "cre"),
   person(family = "Appsilon", role = "cph"))
-Description: It offers functions for creating dashboard with Fomantic UI. 
+Description: It offers functions for creating dashboard with Fomantic UI.
 BugReports: https://github.com/Appsilon/semantic.dashboard/issues
 Encoding: UTF-8
-LazyData: TRUE
 License: MIT + file LICENSE
 Imports:
     utils,
@@ -21,8 +21,14 @@ Imports:
     glue,
     checkmate
 Suggests:
-    testthat,
+    covr,
+    knitr,
     lintr,
+    markdown,
+    rcmdcheck,
+    rmarkdown,
     shinydashboard,
-    covr
-RoxygenNote: 7.1.1
+    testthat
+RoxygenNote: 7.2.1
+VignetteBuilder:
+    knitr

NAMESPACE

@@ -37,8 +37,10 @@ export(render_value_box)
 export(semantic_palette)
 export(sidebarMenu)
 export(sidebarMenuOutput)
+export(sidebarUserPanel)
 export(sidebar_menu)
 export(sidebar_menu_output)
+export(sidebar_user_panel)
 export(tabBox)
 export(tabItem)
 export(tabItems)
@@ -47,6 +49,8 @@ export(tab_item)
 export(tab_items)
 export(taskItem)
 export(task_item)
+export(updateTabItems)
+export(update_tab_items)
 export(valueBox)
 export(valueBoxOutput)
 export(value_box)

R/box.R

@@ -23,12 +23,16 @@ box <- function(..., title = NULL, color = "", ribbon = TRUE, title_side = "top
                 collapsible = TRUE, width = 8, id = NULL, collapse_icon = "minus",
                 expand_icon = "plus") {
   verify_value_allowed("color", c("", ALLOWED_COLORS))
-  verify_value_allowed("title_side", if (ribbon) ALLOWED_BOX_SIDES_RIBBON else ALLOWED_BOX_SIDES_NONRIBBON)
+  verify_value_allowed(
+    "title_side",
+    if (ribbon) ALLOWED_BOX_SIDES_RIBBON else ALLOWED_BOX_SIDES_NONRIBBON
+  )
   box_id <- if (!is.character(id)) {
     paste0("box_", random_id_generator())
   } else {
     id
   }
+  title_id <- sub("box_", "title_", box_id)
   label <- if (!is.character(title)) {
     NULL
   } else {
@@ -40,18 +44,23 @@ box <- function(..., title = NULL, color = "", ribbon = TRUE, title_side = "top
     }
     shiny::div(class = title_class, minimize_button, title)
   }
+  icon_selector <- glue::glue("'#{title_id} > .label > .icon'")
+  # nolint start: line_length_linter
   js_script <- glue::glue("$('#{box_id}').accordion({{
-    selector: {{ trigger: '.title .icon' }},
-    onOpening: function() {{ $('#{box_id}').find('.label .icon').removeClass('{expand_icon}').addClass('{collapse_icon}'); }},
-    onClosing: function() {{ $('#{box_id}').find('.label .icon').removeClass('{collapse_icon}').addClass('{expand_icon}'); }}
+    selector: {{ trigger: {icon_selector} }},
+    onOpening: function() {{ $({icon_selector}).removeClass('{expand_icon}').addClass('{collapse_icon}'); }},
+    onClosing: function() {{ $({icon_selector}).removeClass('{collapse_icon}').addClass('{expand_icon}'); }}
   }});")
+  # nolint end
   column(width = width,
     shiny::div(class = paste("ui segment raised", color),
       shiny::div(id = box_id, class = "ui accordion",
-        shiny::div(class = "title", style = "cursor: auto", label),
+        shiny::div(id = title_id, class = "title", style = "cursor: auto", label),
         shiny::div(class = "content active", shiny::div(...))
       )
     ),
-    if (collapsible) shiny::singleton(shiny::tags$script(paste0("$(document).ready(function() { ", js_script, " })")))
+    if (collapsible) shiny::singleton(
+      shiny::tags$script(shiny::HTML(paste0("$(document).ready(function() {", js_script, " })")))
+    )
   )
 }

R/column.R

@@ -4,8 +4,8 @@
 #' @param ... UI elements to include within the column.
 #' @return A column that can be passed to \code{\link[semantic.dashboard]{dashboardPage}}
 #' @export
-column <- function(width, ...){
-  if (!is.numeric(width) || (width < MIN_COLUMN_WIDTH) || (width > MAX_COLUMN_WIDTH)){
+column <- function(width, ...) {
+  if (!is.numeric(width) || (width < MIN_COLUMN_WIDTH) || (width > MAX_COLUMN_WIDTH)) {
     stop(paste("'width' must be between", MIN_COLUMN_WIDTH, "and", MAX_COLUMN_WIDTH))
   }
   shiny::tags$div(class = paste(COLUMN_WIDTHS[width], "wide column"), ...)

R/constants.R

@@ -1,12 +1,18 @@
-ALLOWED_COLORS <- c("", "red", "orange", "yellow", "olive", "green", "teal",
-                    "blue", "violet", "purple", "pink", "brown", "grey", "black")
+ALLOWED_COLORS <- c(
+  "", "red", "orange", "yellow", "olive", "green", "teal",
+  "blue", "violet", "purple", "pink", "brown", "grey", "black"
+)
 ALLOWED_SIDEBAR_SIZES <- c("", "thin", "very thin", "wide", "very wide")
 ALLOWED_SIDEBAR_SIDES <- c("left", "right", "top", "bottom")
 ALLOWED_VALUEBOX_SIZES <- c("mini", "tiny", "small", "", "large", "huge")
-ALLOWED_BOX_SIDES_NONRIBBON <- c("top", "bottom", "top left", "top right", "bottom left", "bottom right")
+ALLOWED_BOX_SIDES_NONRIBBON <- c(
+  "top", "bottom", "top left", "top right", "bottom left", "bottom right"
+)
 ALLOWED_BOX_SIDES_RIBBON <- c("top left", "top right")
-COLUMN_WIDTHS <-   c("", "two", "three", "four", "five", "six", "seven", "eight", "nine", "ten",
-                     "eleven", "twelve", "thirteen", "fourteen", "fifteen", "sixteen")
+COLUMN_WIDTHS <- c(
+  "", "two", "three", "four", "five", "six", "seven", "eight", "nine", "ten",
+  "eleven", "twelve", "thirteen", "fourteen", "fifteen", "sixteen"
+)
 MIN_COLUMN_WIDTH <- 1
 MAX_COLUMN_WIDTH <- 16
 MIN_PROGRESS_VALUE <- 0
@@ -21,19 +27,27 @@ progress_bar_js <- "$('.progress').progress();"
 #' Semantic colors
 #' https://github.com/Semantic-Org/Semantic-UI/blob/master/src/themes/default/globals/site.variables
 #' @export
-semantic_palette <- c("#A333C8", "#21BA45", "#2185D0", "#DB2828", "#F2711C", "#FBBD08", "#B5CC18",
-                      "#00B5AD", "#6435C9", "#E03997", "#A5673F", "#767676", "#1B1C1D")
-names(semantic_palette) <- c("purple", "green", "blue", "red", "orange", "yellow", "olive", "teal",
-                             "violet", "pink", "brown", "grey", "black")
+semantic_palette <- c(
+  "#A333C8", "#21BA45", "#2185D0", "#DB2828", "#F2711C", "#FBBD08", "#B5CC18",
+  "#00B5AD", "#6435C9", "#E03997", "#A5673F", "#767676", "#1B1C1D"
+)
+names(semantic_palette) <- c(
+  "purple", "green", "blue", "red", "orange", "yellow", "olive", "teal",
+  "violet", "pink", "brown", "grey", "black"
+)
 
 #' Semantic light colors
 #' https://github.com/Semantic-Org/Semantic-UI/blob/master/src/themes/default/globals/site.variables
 #' @export
-light_semantic_palette <- c("#DC73FF", "#2ECC40", "#54C8FF", "#FF695E", "#FF851B", "#FFE21F",
-                            "#D9E778", "#6DFFFF", "#A291FB", "#FF8EDF", "#D67C1C", "#DCDDDE",
-                            "#545454")
+light_semantic_palette <- c(
+  "#DC73FF", "#2ECC40", "#54C8FF", "#FF695E", "#FF851B", "#FFE21F",
+  "#D9E778", "#6DFFFF", "#A291FB", "#FF8EDF", "#D67C1C", "#DCDDDE",
+  "#545454"
+)
 
-names(light_semantic_palette) <- c("lightPurple", "lightGreen", "lightBlue", "lightRed",
-                                   "lightOrange", "lightYellow", "lightOlive", "lightTeal",
-                                   "lightViolet", "lightPink", "lightBrown", "lightGrey",
-                                   "lightBlack")
+names(light_semantic_palette) <- c(
+  "lightPurple", "lightGreen", "lightBlue", "lightRed",
+  "lightOrange", "lightYellow", "lightOlive", "lightTeal",
+  "lightViolet", "lightPink", "lightBrown", "lightGrey",
+  "lightBlack"
+)

R/deps.R

@@ -1,15 +1,17 @@
 #' Get the semantic.dashboard dependencies
 #'
-#' @description To add dependencies in the future follow the \code{\link[htmltools]{htmlDependency}} help.
+#' @description To add dependencies in the future follow the \code{\link[htmltools]{htmlDependency}}
+#'   help.
 #'
 #' @return semantic.dashboard dependencies
+#' @keywords internal
 get_dashboard_dependencies <- function() {
   list(
     htmlDependency(
       "semantic.dashboard",
       as.character(utils::packageVersion("semantic.dashboard")),
       c(file = system.file(package = "semantic.dashboard")),
-      script = "semantic.dashboard.min.js",
+      script = c("semantic.dashboard.min.js", "updateTabItems.js"),
       stylesheet = "semantic.dashboard.min.css"
     )
   )