Skip to content

Commit 3fc0528

Browse files
committed
docs: more details about only_shiny
fix #340
1 parent a7f3c0c commit 3fc0528

File tree

3 files changed

+13
-3
lines changed

3 files changed

+13
-3
lines changed

DESCRIPTION

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
Type: Package
22
Package: ggiraph
33
Title: Make 'ggplot2' Graphics Interactive
4-
Version: 0.9.3.003
4+
Version: 0.9.3.004
55
Authors@R: c(
66
person("David", "Gohel", , "david.gohel@ardata.fr", role = c("aut", "cre")),
77
person("Panagiotis", "Skintzos", , "sigmapi@posteo.net", role = "aut"),

R/girafe_options.R

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -268,7 +268,12 @@ opts_hover_theme <- function(css = NULL, reactive = FALSE) {
268268
#' [girafe_css()], to give more control over the css for different element types.
269269
#' @param type selection mode ("single", "multiple", "none")
270270
#' when widget is in a Shiny application.
271-
#' @param only_shiny disable selections if not in a shiny context.
271+
#' @param only_shiny disable selections when not running within a Shiny
272+
#' application. Defaults to `TRUE` because selection is primarily
273+
#' designed for Shiny interactivity, where selected elements can be
274+
#' captured as reactive values. Set to `FALSE` only to demonstrate
275+
#' the selection/lasso feature in standalone HTML pages (e.g. in
276+
#' documentation examples or R Markdown output).
272277
#' @param selected character vector, id to be selected when the graph will be
273278
#' initialized.
274279
#' @note **IMPORTANT**: When applying a `fill` style with the `css` argument,

man/opts_selection.Rd

Lines changed: 6 additions & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)