From 363068caab2fa708b247a4ab0f73cdc694223587 Mon Sep 17 00:00:00 2001 From: Greg Lin Date: Sun, 21 Jul 2024 22:26:15 -0500 Subject: [PATCH] Clarify use of .rownames in column definitions --- DESCRIPTION | 2 +- R/reactable.R | 3 ++- man/reactable-package.Rd | 1 - man/reactable.Rd | 3 ++- vignettes/examples.Rmd | 2 +- 5 files changed, 6 insertions(+), 5 deletions(-) diff --git a/DESCRIPTION b/DESCRIPTION index 278d86f8..9de46c5c 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -52,5 +52,5 @@ Suggests: V8 Encoding: UTF-8 Roxygen: list(markdown = TRUE) -RoxygenNote: 7.2.3 +RoxygenNote: 7.3.2 Config/testthat/edition: 3 diff --git a/R/reactable.R b/R/reactable.R index f9db953c..311aaf26 100644 --- a/R/reactable.R +++ b/R/reactable.R @@ -22,7 +22,8 @@ #' @param columnGroups List of column group definitions. See [colGroup()]. #' @param rownames Show row names? Defaults to `TRUE` if the data has row names. #' -#' To customize the row names column, use `".rownames"` as the column name. +#' To customize the row names column, add a column definition using `".rownames"` +#' as the column name. #' #' Cells in the row names column are automatically marked up as row headers #' for assistive technologies. diff --git a/man/reactable-package.Rd b/man/reactable-package.Rd index 2a2c3fad..f769b1de 100644 --- a/man/reactable-package.Rd +++ b/man/reactable-package.Rd @@ -3,7 +3,6 @@ \docType{package} \name{reactable-package} \alias{reactable-package} -\alias{_PACKAGE} \title{reactable: Interactive Data Tables for R} \description{ Interactive data tables for R, based on the 'React Table' JavaScript library. Provides an HTML widget that can be used in 'R Markdown' or 'Quarto' documents, 'Shiny' applications, or viewed from an R console. diff --git a/man/reactable.Rd b/man/reactable.Rd index 456e4be9..9cc437c3 100644 --- a/man/reactable.Rd +++ b/man/reactable.Rd @@ -69,7 +69,8 @@ Can also be a \code{\link[crosstalk:SharedData]{crosstalk::SharedData}} object t \item{rownames}{Show row names? Defaults to \code{TRUE} if the data has row names. -To customize the row names column, use \code{".rownames"} as the column name. +To customize the row names column, add a column definition using \code{".rownames"} +as the column name. Cells in the row names column are automatically marked up as row headers for assistive technologies.} diff --git a/vignettes/examples.Rmd b/vignettes/examples.Rmd index 54fa1f7a..8d2aa105 100644 --- a/vignettes/examples.Rmd +++ b/vignettes/examples.Rmd @@ -1731,7 +1731,7 @@ reactable( ### Row names Row names are shown by default if present. You can customize the row names column -using `".rownames"` as the column name: +by adding a column definition using `".rownames"` as the column name: ```{r} reactable(