File: style.Rd

package info (click to toggle)
r-cran-formattable 0.2.1%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, bullseye, forky, sid, trixie
  • size: 420 kB
  • sloc: javascript: 15; sh: 12; makefile: 2
file content (48 lines) | stat: -rw-r--r-- 1,475 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/style.R
\name{style}
\alias{style}
\title{Create a string-representation of CSS style}
\usage{
style(...)
}
\arguments{
\item{...}{style attributes in form of \code{name = value}. Many CSS properties
contains \code{'-'} in the middle of their names. In this case, use
\code{"the-name" = value} instead. \code{NA} will cancel the attribute.}
}
\value{
a string-representation of css styles
}
\description{
Most HTML elements can be stylized by a set of CSS style
properties. This function helps build CSS strings using
conventional argument-passing in R.
}
\details{
The general usage of CSS styling is

\code{<span style = "color: red; border: 1px">Text</span>}

The text color can be specified by `color`, the border of
element by `border`, and etc.

Basic styles like \code{color}, \code{border}, \code{background}
work properly and mostly consistently in modern web browsers.
However, some style properties may not work consistently in
different browsers.
}
\examples{
style(color = "red")
style(color = "red", "font-weight" = "bold")
style("background-color" = "gray", "border-radius" = "4px")
style("padding-right" = "2px")

formattable(mtcars, list(
  mpg = formatter("span",
    style = x ~ style(color = ifelse(x > median(x), "red", NA)))))
}
\seealso{
\href{https://www.w3.org/Style/CSS/all-properties}{List of CSS properties},
  \href{https://www.w3schools.com/cssref/}{CSS Reference}
}