Skip to content

Commit

Permalink
fix: documentation and package check notes
Browse files Browse the repository at this point in the history
  • Loading branch information
Jakub Sobolewski committed Sep 12, 2023
1 parent ba56655 commit a08a3bb
Show file tree
Hide file tree
Showing 6 changed files with 36 additions and 22 deletions.
1 change: 1 addition & 0 deletions .Rbuildignore
Original file line number Diff line number Diff line change
Expand Up @@ -11,3 +11,4 @@
^data-raw$
^scrape-docs/
^vignettes/
^.*\.sass_cache_keys
1 change: 0 additions & 1 deletion DESCRIPTION
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,6 @@ Imports:
htmltools,
jsonlite,
purrr,
rlang,
shiny,
shiny.react (>= 0.3.0)
Suggests:
Expand Down
10 changes: 6 additions & 4 deletions R/extensions.R
Original file line number Diff line number Diff line change
Expand Up @@ -22,9 +22,8 @@ isCommandBarItem <- function(x) {
#' except for `text`, `icon` (which will inserted as proper `iconProps`) and `subitems` (which will be inserted as
#' proper `subMenuProps`).
#'
#' @param key Key of the item.
#' @param text Text to be displayed on the menu.
#' @param icon Optional name of an icon.
#' @param subitems Optional list of CommandBar items.
#' @param onClick A JS function that runs on item click. By default it sends input value to `input[[key]]`
#' @param ... Additional props to pass to CommandBarItem.
#' @return Item suitable for use in the CommandBar.
Expand Down Expand Up @@ -53,10 +52,13 @@ CommandBarItem <- function(
#' CommandBar extension that sends values of clicked CommandBarItems
#'
#' @param inputId Input name
#' @return A CommandBar
#' @param ... Arguments passed to CommandBar.
#' @param itemValueGetter A function that takes a CommandBarItem and returns a value to be sent to Shiny.
#' By default it returns `key` of the item.
#' @return A CommandBar component.
#'
#' @seealso CommandBarItem
#' @rdname CommandBar
# #' @rdname CommandBar
#' @export
CommandBar.shinyInput <- function(
inputId,
Expand Down
15 changes: 2 additions & 13 deletions man/CommandBar.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

25 changes: 25 additions & 0 deletions man/CommandBar.shinyInput.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 2 additions & 4 deletions man/CommandBarItem.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit a08a3bb

Please sign in to comment.