File: jscolorInput.Rd

package info (click to toggle)
r-cran-rlumshiny 0.2.3-1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, forky, sid, trixie
  • size: 1,332 kB
  • sloc: javascript: 922; makefile: 2
file content (72 lines) | stat: -rw-r--r-- 2,343 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/jscolor.R
\name{jscolorInput}
\alias{jscolorInput}
\title{Create a JSColor picker input widget}
\usage{
jscolorInput(
  inputId,
  label,
  value,
  position = "bottom",
  color = "transparent",
  mode = "HSV",
  slider = TRUE,
  close = FALSE
)
}
\arguments{
\item{inputId}{\code{\link{character}} (\strong{required}):
Specifies the input slot that will be used to access the value.}

\item{label}{\code{\link{character}} (\emph{optional}):
Display label for the control, or NULL for no label.}

\item{value}{\code{\link{character}} (\emph{optional}):
Initial RGB value of the color picker. Default is black ('#000000').}

\item{position}{\code{\link{character}} (\emph{with default}):
Position of the picker relative to the text input ('bottom', 'left', 'top', 'right').}

\item{color}{\code{\link{character}} (\emph{with default}):
Picker color scheme ('transparent' by default). Use RGB color coding ('000000').}

\item{mode}{\code{\link{character}} (\emph{with default}):
Mode of hue, saturation and value. Can either be 'HSV' or 'HVS'.}

\item{slider}{\code{\link{logical}} (\emph{with default}):
Show or hide the slider.}

\item{close}{\code{\link{logical}} (\emph{with default}):
Show or hide a close button.}
}
\description{
Creates a JSColor (Javascript/HTML Color Picker) widget to be used in shiny applications.
}
\examples{
# html code
jscolorInput("col", "Color", "21BF6B", slider = FALSE)

# example app
\dontrun{
shinyApp(
ui = fluidPage(
  jscolorInput(inputId = "col", label = "JSColor Picker", 
               value = "21BF6B", position = "right", 
               mode = "HVS", close = TRUE),
  plotOutput("plot")
),
server = function(input, output) {
  output$plot <- renderPlot({
    plot(cars, col = input$col, cex = 2, pch = 16)
 })
})
}
}
\seealso{
Other input.elements: \code{\link{animationOptions}}, \code{\link{sliderInput}};
\code{\link{checkboxGroupInput}}; \code{\link{checkboxInput}}; \code{\link{dateInput}};
\code{\link{dateRangeInput}}; \code{\link{fileInput}}; \code{\link{numericInput}};
\code{\link{passwordInput}}; \code{\link{radioButtons}}; \code{\link{selectInput}},
\code{\link{selectizeInput}}; \code{\link{submitButton}}; \code{\link{textInput}}
}