|
2 | 2 | #' |
3 | 3 | #' Create a file upload control that can be used to upload one or more files. |
4 | 4 | #' |
5 | | -#' Whenever a file upload completes, the corresponding input variable is set |
6 | | -#' to a dataframe. See the `Server value` section. |
| 5 | +#' Whenever a file upload completes, the corresponding input variable is set to |
| 6 | +#' a dataframe. See the `Server value` section. |
| 7 | +#' |
| 8 | +#' Each time files are uploaded, they are written to a new random subdirectory |
| 9 | +#' inside of R's process-level temporary directory. The Shiny user session keeps |
| 10 | +#' track of all uploads in the session, and when the session ends, Shiny deletes |
| 11 | +#' all of the subdirectories where files where uploaded to. |
7 | 12 | #' |
8 | 13 | #' @family input elements |
9 | 14 | #' |
10 | 15 | #' @inheritParams textInput |
11 | 16 | #' @param multiple Whether the user should be allowed to select and upload |
12 | 17 | #' multiple files at once. **Does not work on older browsers, including |
13 | 18 | #' Internet Explorer 9 and earlier.** |
14 | | -#' @param accept A character vector of "unique file type specifiers" which |
15 | | -#' gives the browser a hint as to the type of file the server expects. |
16 | | -#' Many browsers use this prevent the user from selecting an invalid file. |
| 19 | +#' @param accept A character vector of "unique file type specifiers" which gives |
| 20 | +#' the browser a hint as to the type of file the server expects. Many browsers |
| 21 | +#' use this prevent the user from selecting an invalid file. |
17 | 22 | #' |
18 | 23 | #' A unique file type specifier can be: |
19 | 24 | #' * A case insensitive extension like `.csv` or `.rds`. |
20 | 25 | #' * A valid MIME type, like `text/plain` or `application/pdf` |
21 | 26 | #' * One of `audio/*`, `video/*`, or `image/*` meaning any audio, video, |
22 | | -#' or image type, respectively. |
| 27 | +#' or image type, respectively. |
23 | 28 | #' @param buttonLabel The label used on the button. Can be text or an HTML tag |
24 | 29 | #' object. |
25 | 30 | #' @param placeholder The text to show before a file has been uploaded. |
26 | 31 | #' @param capture What source to use for capturing image, audio or video data. |
27 | | -#' This attribute facilitates user access to a device's media capture |
28 | | -#' mechanism, such as a camera, or microphone, from within a file upload |
| 32 | +#' This attribute facilitates user access to a device's media capture |
| 33 | +#' mechanism, such as a camera, or microphone, from within a file upload |
29 | 34 | #' control. |
30 | 35 | #' |
31 | 36 | #' A value of `user` indicates that the user-facing camera and/or microphone |
|
67 | 72 | #' } |
68 | 73 | #' |
69 | 74 | #' @section Server value: |
70 | | -#' A `data.frame` that contains one row for each selected file, and following columns: |
| 75 | +#' |
| 76 | +#' A `data.frame` that contains one row for each selected file, and following |
| 77 | +#' columns: |
71 | 78 | #' \describe{ |
72 | 79 | #' \item{`name`}{The filename provided by the web browser. This is |
73 | 80 | #' **not** the path to read to get at the actual data that was uploaded |
|
0 commit comments