Hao Zhu | 501fb45 | 2017-07-05 14:37:13 -0400 | [diff] [blame] | 1 | % Generated by roxygen2: do not edit by hand |
| 2 | % Please edit documentation in R/scroll_box.R |
| 3 | \name{scroll_box} |
| 4 | \alias{scroll_box} |
| 5 | \title{Put a HTML table into a scrollable box} |
| 6 | \usage{ |
Hao Zhu | 4b0c51e | 2017-08-01 15:21:07 -0400 | [diff] [blame] | 7 | scroll_box(kable_input, height = NULL, width = NULL, |
Hao Zhu | 270846b | 2019-01-06 17:52:26 -0500 | [diff] [blame] | 8 | box_css = "border: 1px solid #ddd; padding: 5px; ", extra_css = NULL, |
Hao Zhu | 72917f9 | 2019-03-15 18:41:42 -0400 | [diff] [blame] | 9 | fixed_thead = TRUE) |
Hao Zhu | 501fb45 | 2017-07-05 14:37:13 -0400 | [diff] [blame] | 10 | } |
| 11 | \arguments{ |
| 12 | \item{kable_input}{A HTML kable object} |
| 13 | |
| 14 | \item{height}{A character string indicating the height of the box, e.g. "50px"} |
| 15 | |
| 16 | \item{width}{A character string indicating the width of the box, e.g. "100px"} |
Hao Zhu | 4b0c51e | 2017-08-01 15:21:07 -0400 | [diff] [blame] | 17 | |
| 18 | \item{box_css}{CSS text for the box} |
| 19 | |
| 20 | \item{extra_css}{Extra CSS styles} |
Hao Zhu | 270846b | 2019-01-06 17:52:26 -0500 | [diff] [blame] | 21 | |
Hao Zhu | 72917f9 | 2019-03-15 18:41:42 -0400 | [diff] [blame] | 22 | \item{fixed_thead}{HTML table option so table header row is fixed at top. |
| 23 | Values can be either T/F or \code{list(enabled = T/F, background = "anycolor")}.} |
Hao Zhu | 501fb45 | 2017-07-05 14:37:13 -0400 | [diff] [blame] | 24 | } |
| 25 | \description{ |
| 26 | This function will put a HTML kable object in a fixed-height, |
| 27 | fixed-width or both box and make it scrollable. |
| 28 | } |
Irene | 319a546 | 2018-04-17 15:37:39 -0700 | [diff] [blame] | 29 | \examples{ |
| 30 | \dontrun{ |
| 31 | # Specify table size by pixels |
| 32 | kable(cbind(mtcars, mtcars), "html") \%>\% |
| 33 | kable_styling() \%>\% |
| 34 | scroll_box(width = "500px", height = "200px") |
| 35 | |
| 36 | # Specify by percent |
| 37 | kable(cbind(mtcars, mtcars), "html") \%>\% |
| 38 | kable_styling() \%>\% |
| 39 | scroll_box(width = "100\%", height = "200px") |
| 40 | } |
| 41 | } |