Added limited documentation to the inputs
This commit is contained in:
78
man/betterDateRangeInput.Rd
Normal file
78
man/betterDateRangeInput.Rd
Normal file
@@ -0,0 +1,78 @@
|
||||
% Generated by roxygen2: do not edit by hand
|
||||
% Please edit documentation in R/betterDateRangeInput.R
|
||||
\name{betterDateRangeInput}
|
||||
\alias{betterDateRangeInput}
|
||||
\title{Improved shiny dateRangeInput}
|
||||
\usage{
|
||||
betterDateRangeInput(
|
||||
inputId,
|
||||
label,
|
||||
start = NULL,
|
||||
end = NULL,
|
||||
min = NULL,
|
||||
max = NULL,
|
||||
display_format = "yyyy-mm-dd",
|
||||
startview = "month",
|
||||
weekstart = 0,
|
||||
language = "en",
|
||||
separator = " to ",
|
||||
width = NULL,
|
||||
autoclose = TRUE,
|
||||
autonext = TRUE,
|
||||
...
|
||||
)
|
||||
}
|
||||
\arguments{
|
||||
\item{inputId}{The \code{input} slot that will be used to access the value.}
|
||||
|
||||
\item{label}{Display label for the control, or \code{NULL} for no label.}
|
||||
|
||||
\item{start}{The initial start date. Either a Date object, or a string in
|
||||
\code{yyyy-mm-dd} format. If NULL (the default), will use the current
|
||||
date in the client's time zone.}
|
||||
|
||||
\item{end}{The initial end date. Either a Date object, or a string in
|
||||
\code{yyyy-mm-dd} format. If NULL (the default), will use the current
|
||||
date in the client's time zone.}
|
||||
|
||||
\item{min}{The minimum allowed date. Either a Date object, or a string in
|
||||
\code{yyyy-mm-dd} format.}
|
||||
|
||||
\item{max}{The maximum allowed date. Either a Date object, or a string in
|
||||
\code{yyyy-mm-dd} format.}
|
||||
|
||||
\item{display_format}{An ISO format for dates}
|
||||
|
||||
\item{startview}{The date range shown when the input object is first clicked.
|
||||
Can be "month" (the default), "year", or "decade".}
|
||||
|
||||
\item{weekstart}{Which day is the start of the week. Should be an integer
|
||||
from 0 (Sunday) to 6 (Saturday).}
|
||||
|
||||
\item{language}{The language used for month and day names. Default is "en".
|
||||
Other valid values include "ar", "az", "bg", "bs", "ca", "cs", "cy", "da",
|
||||
"de", "el", "en-AU", "en-GB", "eo", "es", "et", "eu", "fa", "fi", "fo",
|
||||
"fr-CH", "fr", "gl", "he", "hr", "hu", "hy", "id", "is", "it-CH", "it",
|
||||
"ja", "ka", "kh", "kk", "ko", "kr", "lt", "lv", "me", "mk", "mn", "ms",
|
||||
"nb", "nl-BE", "nl", "no", "pl", "pt-BR", "pt", "ro", "rs-latin", "rs",
|
||||
"ru", "sk", "sl", "sq", "sr-latin", "sr", "sv", "sw", "th", "tr", "uk",
|
||||
"vi", "zh-CN", and "zh-TW".}
|
||||
|
||||
\item{separator}{String to display between the start and end input boxes.}
|
||||
|
||||
\item{width}{The width of the input, e.g. \code{'400px'}, or \code{'100\%'};
|
||||
see \code{\link[shiny:validateCssUnit]{validateCssUnit()}}.}
|
||||
|
||||
\item{autoclose}{Whether or not to close the datepicker immediately when a
|
||||
date is selected.}
|
||||
|
||||
\item{autonext}{Automatically move to "end" when "start" is selected if TRUE}
|
||||
|
||||
\item{...}{Ignored}
|
||||
}
|
||||
\description{
|
||||
Improved shiny dateRangeInput
|
||||
}
|
||||
\seealso{
|
||||
\code{\link[shiny:dateRangeInput]{shiny::dateRangeInput()}}, \code{\link[shiny:updateDateRangeInput]{shiny::updateDateRangeInput()}}
|
||||
}
|
||||
Reference in New Issue
Block a user