Accessible alternatives for radioButtons, checkboxGroupInput and fileInput added
This commit is contained in:
54
man/a11yCheckboxGroupInput.Rd
Normal file
54
man/a11yCheckboxGroupInput.Rd
Normal file
@@ -0,0 +1,54 @@
|
||||
% Generated by roxygen2: do not edit by hand
|
||||
% Please edit documentation in R/a11yCheckboxGroupInput.R
|
||||
\name{a11yCheckboxGroupInput}
|
||||
\alias{a11yCheckboxGroupInput}
|
||||
\title{Checkbox Group Input Control}
|
||||
\usage{
|
||||
a11yCheckboxGroupInput(
|
||||
inputId,
|
||||
label,
|
||||
choices = NULL,
|
||||
selected = NULL,
|
||||
inline = FALSE,
|
||||
width = NULL,
|
||||
choiceNames = NULL,
|
||||
choiceValues = NULL,
|
||||
withSelectAll = FALSE
|
||||
)
|
||||
}
|
||||
\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{choices}{List of values to show checkboxes for. If elements of the list
|
||||
are named then that name rather than the value is displayed to the user. If
|
||||
this argument is provided, then \code{choiceNames} and \code{choiceValues}
|
||||
must not be provided, and vice-versa. The values should be strings; other
|
||||
types (such as logicals and numbers) will be coerced to strings.}
|
||||
|
||||
\item{selected}{The values that should be initially selected, if any.}
|
||||
|
||||
\item{inline}{If \code{TRUE}, render the choices inline (i.e. horizontally)}
|
||||
|
||||
\item{width}{The width of the input, e.g. \code{'400px'}, or \code{'100\%'};
|
||||
see \code{\link[shiny:validateCssUnit]{validateCssUnit()}}.}
|
||||
|
||||
\item{choiceNames, choiceValues}{List of names and values, respectively,
|
||||
that are displayed to the user in the app and correspond to the each
|
||||
choice (for this reason, \code{choiceNames} and \code{choiceValues}
|
||||
must have the same length). If either of these arguments is
|
||||
provided, then the other \emph{must} be provided and \code{choices}
|
||||
\emph{must not} be provided. The advantage of using both of these over
|
||||
a named list for \code{choices} is that \code{choiceNames} allows any
|
||||
type of UI object to be passed through (tag objects, icons, HTML code,
|
||||
...), instead of just simple text. See Examples.}
|
||||
|
||||
\item{withSelectAll}{Create additional "select all"/"clear all" controls}
|
||||
}
|
||||
\description{
|
||||
Creates more accessible shiny group of shiny checkboxes
|
||||
}
|
||||
\seealso{
|
||||
\code{\link[shiny:checkboxGroupInput]{shiny::checkboxGroupInput()}}
|
||||
}
|
||||
65
man/a11yFileInput.Rd
Normal file
65
man/a11yFileInput.Rd
Normal file
@@ -0,0 +1,65 @@
|
||||
% Generated by roxygen2: do not edit by hand
|
||||
% Please edit documentation in R/a11yFileInput.R
|
||||
\name{a11yFileInput}
|
||||
\alias{a11yFileInput}
|
||||
\title{File Upload Control}
|
||||
\usage{
|
||||
a11yFileInput(
|
||||
inputId,
|
||||
label,
|
||||
multiple = FALSE,
|
||||
accept = NULL,
|
||||
width = NULL,
|
||||
buttonLabel = "Browse...",
|
||||
placeholder = "No file selected",
|
||||
capture = NULL
|
||||
)
|
||||
}
|
||||
\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{multiple}{Whether the user should be allowed to select and upload
|
||||
multiple files at once. \strong{Does not work on older browsers, including
|
||||
Internet Explorer 9 and earlier.}}
|
||||
|
||||
\item{accept}{A character vector of "unique file type specifiers" which gives
|
||||
the browser a hint as to the type of file the server expects. Many browsers
|
||||
use this prevent the user from selecting an invalid file.
|
||||
|
||||
A unique file type specifier can be:
|
||||
\itemize{
|
||||
\item A case insensitive extension like \code{.csv} or \code{.rds}.
|
||||
\item A valid MIME type, like \code{text/plain} or \code{application/pdf}
|
||||
\item One of \verb{audio/*}, \verb{video/*}, or \verb{image/*} meaning any audio, video,
|
||||
or image type, respectively.
|
||||
}}
|
||||
|
||||
\item{width}{The width of the input, e.g. \code{'400px'}, or \code{'100\%'};
|
||||
see \code{\link[shiny:validateCssUnit]{validateCssUnit()}}.}
|
||||
|
||||
\item{buttonLabel}{The label used on the button. Can be text or an HTML tag
|
||||
object.}
|
||||
|
||||
\item{placeholder}{The text to show before a file has been uploaded.}
|
||||
|
||||
\item{capture}{What source to use for capturing image, audio or video data.
|
||||
This attribute facilitates user access to a device's media capture
|
||||
mechanism, such as a camera, or microphone, from within a file upload
|
||||
control.
|
||||
|
||||
A value of \code{user} indicates that the user-facing camera and/or microphone
|
||||
should be used. A value of \code{environment} specifies that the outward-facing
|
||||
camera and/or microphone should be used.
|
||||
|
||||
By default on most phones, this will accept still photos or video. For
|
||||
still photos only, also use \code{accept="image/*"}. For video only, use
|
||||
\code{accept="video/*"}.}
|
||||
}
|
||||
\description{
|
||||
Creates more accessible shiny file upload input.
|
||||
}
|
||||
\seealso{
|
||||
\code{\link[shiny:fileInput]{shiny::fileInput()}}
|
||||
}
|
||||
52
man/a11yRadioButtons.Rd
Normal file
52
man/a11yRadioButtons.Rd
Normal file
@@ -0,0 +1,52 @@
|
||||
% Generated by roxygen2: do not edit by hand
|
||||
% Please edit documentation in R/a11yRadioButtons.R
|
||||
\name{a11yRadioButtons}
|
||||
\alias{a11yRadioButtons}
|
||||
\title{Create radio buttons}
|
||||
\usage{
|
||||
a11yRadioButtons(
|
||||
inputId,
|
||||
label,
|
||||
choices = NULL,
|
||||
selected = NULL,
|
||||
inline = FALSE,
|
||||
width = NULL,
|
||||
choiceNames = NULL,
|
||||
choiceValues = NULL
|
||||
)
|
||||
}
|
||||
\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{choices}{List of values to select from (if elements of the list are
|
||||
named then that name rather than the value is displayed to the user). If
|
||||
this argument is provided, then \code{choiceNames} and \code{choiceValues} must not
|
||||
be provided, and vice-versa. The values should be strings; other types
|
||||
(such as logicals and numbers) will be coerced to strings.}
|
||||
|
||||
\item{selected}{The initially selected value. If not specified, then it
|
||||
defaults to the first item in \code{choices}. To start with no items selected,
|
||||
use \code{character(0)}.}
|
||||
|
||||
\item{inline}{If \code{TRUE}, render the choices inline (i.e. horizontally)}
|
||||
|
||||
\item{width}{The width of the input, e.g. \code{'400px'}, or \code{'100\%'};
|
||||
see \code{\link[shiny:validateCssUnit]{validateCssUnit()}}.}
|
||||
|
||||
\item{choiceNames, choiceValues}{List of names and values, respectively, that
|
||||
are displayed to the user in the app and correspond to the each choice (for
|
||||
this reason, \code{choiceNames} and \code{choiceValues} must have the same length).
|
||||
If either of these arguments is provided, then the other \emph{must} be provided
|
||||
and \code{choices} \emph{must not} be provided. The advantage of using both of these
|
||||
over a named list for \code{choices} is that \code{choiceNames} allows any type of UI
|
||||
object to be passed through (tag objects, icons, HTML code, ...), instead
|
||||
of just simple text. See Examples.}
|
||||
}
|
||||
\description{
|
||||
Creates more accessible shiny radio buttons
|
||||
}
|
||||
\seealso{
|
||||
\code{\link[shiny:radioButtons]{shiny::radioButtons()}}
|
||||
}
|
||||
Reference in New Issue
Block a user