colourPalette: Create a colour palette widget

In cpsievert/colourPalette: Pick your colour(s).

Description

Create an input control to select a colour, with or without shiny

Usage

colourPalette(label, value = "white", showColour = c("both", "text",
  "background"), palette = c("square", "limited"), allowedCols = NULL,
  allowTransparent = FALSE, transparentText = NULL,
  set = basename(tempfile("")))

Arguments

label	Display label for the control, or 'NULL for no label.
value	Initial value (can be a colour name or HEX code)
showColour	Whether to show the chosen colour as text inside the input, as the background colour of the input, or both (default).
palette	The type of colour palette to allow the user to select colours from. square (default) shows a square colour palette that allows the user to choose any colour, while limited only gives the user a predefined list of colours to choose from.
allowedCols	A list of colours that the user can choose from. Only applicable when palette == "limited". The limited palette uses a default list of 40 colours if allowedCols is not defined.
allowTransparent	If TRUE, then add a checkbox that allows the user to select the transparent colour.
transparentText	The text to show beside the transparency checkbox when allowTransparent is TRUE. The default value is "Transparent", but you can change it to "None" or any other string. This has no effect on the return value from the input; when the checkbox is checked, the input will always return the string "transparent".
set	sets the crosstalk group to inform about changes in input value.

Details

A colour input allows users to select a colour by clicking on the desired colour, or by entering a valid HEX colour in the input box. The input can be initialized with either a colour name or a HEX value. The return value is a HEX value by default, but you can use the returnName = TRUE parameter to get an R colour name instead (only when an R colour exists for the selected colour).

Since most functions in R that accept colours can also accept the value "transparent", colourInput has an option to allow selecting the "transparent" colour. When the user checks the checkbox for this special colour, the returned value form the input is "transparent".

Note

This function is an adaption of the fabulous colourInput so that htmlwidgets can take advantage of colour palette changes, without shiny.

Examples

# TODO: get label working (also height/width!)
colourPalette("hey there", "red", palette = "limited", allowedCols = c("red", "blue"))

cpsievert/colourPalette documentation built on May 13, 2019, 10:54 p.m.