😎 Give your xaringan slides some style
Vous ne pouvez pas sélectionner plus de 25 sujets Les noms de sujets doivent commencer par une lettre ou un nombre, peuvent contenir des tirets ('-') et peuvent comporter jusqu'à 35 caractères.

425 lines
19KB

  1. % Generated by roxygen2: do not edit by hand
  2. % Please edit documentation in R/style_mono_accent.R
  3. \name{style_mono_accent}
  4. \alias{style_mono_accent}
  5. \title{Monotone Accent Theme}
  6. \usage{
  7. style_mono_accent(
  8. base_color = "#43418A",
  9. white_color = "#FFFFFF",
  10. black_color = "#272822",
  11. text_color = black_color,
  12. header_color = base_color,
  13. background_color = white_color,
  14. link_color = base_color,
  15. text_bold_color = base_color,
  16. text_slide_number_color = base_color,
  17. padding = "16px 64px 16px 64px",
  18. background_image = NULL,
  19. background_size = NULL,
  20. background_position = NULL,
  21. code_highlight_color = "rgba(255,255,0,0.5)",
  22. code_inline_color = base_color,
  23. code_inline_background_color = NULL,
  24. code_inline_font_size = "1em",
  25. inverse_background_color = base_color,
  26. inverse_text_color = white_color,
  27. inverse_text_shadow = FALSE,
  28. inverse_header_color = white_color,
  29. title_slide_text_color = inverse_text_color,
  30. title_slide_background_color = inverse_background_color,
  31. title_slide_background_image = NULL,
  32. title_slide_background_size = NULL,
  33. title_slide_background_position = NULL,
  34. footnote_color = NULL,
  35. footnote_font_size = "0.9em",
  36. footnote_position_bottom = "60px",
  37. left_column_subtle_color = apply_alpha(base_color, 0.6),
  38. left_column_selected_color = base_color,
  39. blockquote_left_border_color = apply_alpha(base_color, 0.5),
  40. table_border_color = "#666",
  41. table_row_border_color = "#ddd",
  42. table_row_even_background_color = lighten_color(base_color, 0.8),
  43. base_font_size = "20px",
  44. text_font_size = "1rem",
  45. header_h1_font_size = "2.75rem",
  46. header_h2_font_size = "2.25rem",
  47. header_h3_font_size = "1.75rem",
  48. header_background_auto = FALSE,
  49. header_background_color = header_color,
  50. header_background_text_color = background_color,
  51. header_background_padding = NULL,
  52. header_background_content_padding_top = "7rem",
  53. header_background_ignore_classes = c("normal", "inverse", "title", "middle", "bottom"),
  54. text_slide_number_font_size = "0.9em",
  55. text_font_google = NULL,
  56. text_font_family = "Noto Sans",
  57. text_font_weight = "normal",
  58. text_font_url = "https://fonts.googleapis.com/css?family=Noto+Sans:400,400i,700,700i&display=swap",
  59. text_font_family_fallback = "-apple-system, BlinkMacSystemFont, avenir next, avenir, helvetica neue, helvetica, Ubuntu, roboto, noto, segoe ui, arial",
  60. text_font_base = "sans-serif",
  61. header_font_google = NULL,
  62. header_font_family = "Cabin",
  63. header_font_weight = "600",
  64. header_font_url = "https://fonts.googleapis.com/css?family=Cabin:600,600i&display=swap",
  65. code_font_google = NULL,
  66. code_font_family = "Source Code Pro",
  67. code_font_size = "0.9rem",
  68. code_font_url = "https://fonts.googleapis.com/css?family=Source+Code+Pro:400,700&display=swap",
  69. code_font_family_fallback = "Menlo, Consolas, Monaco, Liberation Mono, Lucida Console",
  70. colors = NULL,
  71. extra_css = NULL,
  72. extra_fonts = NULL,
  73. outfile = "xaringan-themer.css"
  74. )
  75. }
  76. \arguments{
  77. \item{base_color}{Monotone Base Color, works best with a strong color.
  78. Defaults to #43418A. Used in multiple CSS rules.}
  79. \item{white_color}{Brightest color used. Defaults to #FFFFFF. Used in
  80. multiple CSS rules.}
  81. \item{black_color}{Darkest color used. Defaults to #272822. Used in multiple
  82. CSS rules.}
  83. \item{text_color}{Text Color. Defaults to \code{black_color}. Modifies the \code{body}
  84. element. The value of this variable is also stored as a CSS variable that
  85. can be referenced with \code{var(--text_color)} in any argument of a style
  86. function or in custom CSS.}
  87. \item{header_color}{Header Color. Defaults to \code{base_color}. Modifies the
  88. \verb{h1, h2, h3} elements. The value of this variable is also stored as a CSS
  89. variable that can be referenced with \code{var(--header-color)} in any argument
  90. of a style function or in custom CSS.}
  91. \item{background_color}{Slide Background Color. Defaults to \code{white_color}.
  92. Modifies the \code{.remark-slide-content} class. The value of this variable is
  93. also stored as a CSS variable that can be referenced with
  94. \code{var(--background-color)} in any argument of a style function or in custom
  95. CSS.}
  96. \item{link_color}{Link Color. Defaults to \code{base_color}. Modifies the
  97. \verb{a, a > code} elements. The value of this variable is also stored as a CSS
  98. variable that can be referenced with \code{var(--link-color)} in any argument
  99. of a style function or in custom CSS.}
  100. \item{text_bold_color}{Bold Text Color. Defaults to \code{base_color}. Modifies
  101. the \code{strong} element. The value of this variable is also stored as a CSS
  102. variable that can be referenced with \code{var(--text-bold-color)} in any
  103. argument of a style function or in custom CSS.}
  104. \item{text_slide_number_color}{Slide Number Color. Defaults to \code{base_color}.
  105. Modifies the \code{.remark-slide-number} class.}
  106. \item{padding}{Slide Padding in \verb{top right [bottom left]} format. Defaults
  107. to 16px 64px 16px 64px. Modifies the \code{.remark-slide-content} class.}
  108. \item{background_image}{Background image applied to each \emph{and every} slide.
  109. Set \code{title_slide_background_image = "none"} to remove the background image
  110. from the title slide. Defaults to \code{NULL}. Modifies the
  111. \code{.remark-slide-content} class.}
  112. \item{background_size}{Background image size, requires \code{background_image} to
  113. be set. If \code{background_image} is set, \code{background_size} will default to
  114. \code{cover} so the backround fills the screen. If both \code{background_image} and
  115. \code{background_position} are set, will default to 100 percent. Defaults to
  116. \code{NULL}. Modifies the \code{.remark-slide-content} class.}
  117. \item{background_position}{Background image position, requires
  118. \code{background_image} to be set, and it is recommended to adjust
  119. \code{background_size}. Defaults to \code{NULL}. Modifies the
  120. \code{.remark-slide-content} class.}
  121. \item{code_highlight_color}{Code Line Highlight. Defaults to
  122. rgba(255,255,0,0.5). Modifies the \code{.remark-code-line-highlighted} class.
  123. The value of this variable is also stored as a CSS variable that can be
  124. referenced with \code{var(--code-highlight-color)} in any argument of a style
  125. function or in custom CSS.}
  126. \item{code_inline_color}{Inline Code Color. Defaults to \code{base_color}.
  127. Modifies the \code{.remark-inline-code} class.}
  128. \item{code_inline_background_color}{Inline Code Background Color. Defaults
  129. to \code{NULL}. Modifies the \code{.remark-inline-code} class.}
  130. \item{code_inline_font_size}{Inline Code Text Font Size. Defaults to 1em.
  131. Modifies the \code{.remark-inline-code} class. The value of this variable is
  132. also stored as a CSS variable that can be referenced with
  133. \code{var(--code-inline-font-size)} in any argument of a style function or in
  134. custom CSS.}
  135. \item{inverse_background_color}{Inverse Background Color. Defaults to
  136. \code{base_color}. Modifies the \code{.inverse} class. The value of this variable is
  137. also stored as a CSS variable that can be referenced with
  138. \code{var(--inverse-background-color)} in any argument of a style function or
  139. in custom CSS.}
  140. \item{inverse_text_color}{Inverse Text Color. Defaults to \code{white_color}.
  141. Modifies the \code{.inverse} class. The value of this variable is also stored
  142. as a CSS variable that can be referenced with \code{var(--inverse-text-color)}
  143. in any argument of a style function or in custom CSS.}
  144. \item{inverse_text_shadow}{Enables Shadow on text of inverse slides.
  145. Defaults to \code{FALSE}. Modifies the \code{.inverse} class.}
  146. \item{inverse_header_color}{Inverse Header Color. Defaults to \code{white_color}.
  147. Modifies the \verb{.inverse h1, .inverse h2, .inverse h3} classes. The value of
  148. this variable is also stored as a CSS variable that can be referenced with
  149. \code{var(--inverse-header-color)} in any argument of a style function or in
  150. custom CSS.}
  151. \item{title_slide_text_color}{Title Slide Text Color. Defaults to
  152. \code{inverse_text_color}. Modifies the \code{.title-slide} class. The value of this
  153. variable is also stored as a CSS variable that can be referenced with
  154. \code{var(--title-slide-text-color)} in any argument of a style function or in
  155. custom CSS.}
  156. \item{title_slide_background_color}{Title Slide Background Color. Defaults
  157. to \code{inverse_background_color}. Modifies the \code{.title-slide} class. The
  158. value of this variable is also stored as a CSS variable that can be
  159. referenced with \code{var(--title-slide-background-color)} in any argument of a
  160. style function or in custom CSS.}
  161. \item{title_slide_background_image}{Title Slide Background Image URL.
  162. Defaults to \code{NULL}. Modifies the \code{.title-slide} class.}
  163. \item{title_slide_background_size}{Title Slide Background Image Size,
  164. defaults to "cover" if background image is set. Defaults to \code{NULL}.
  165. Modifies the \code{.title-slide} class.}
  166. \item{title_slide_background_position}{Title Slide Background Image
  167. Position. Defaults to \code{NULL}. Modifies the \code{.title-slide} class.}
  168. \item{footnote_color}{Footnote text color (if \code{NA}, then it will be the same
  169. color as \code{text_color}). Defaults to \code{NULL}. Modifies the \code{.footnote}
  170. class.}
  171. \item{footnote_font_size}{Footnote font size. Defaults to 0.9em. Modifies
  172. the \code{.footnote} class.}
  173. \item{footnote_position_bottom}{Footnote location from bottom of screen.
  174. Defaults to 60px. Modifies the \code{.footnote} class.}
  175. \item{left_column_subtle_color}{Left Column Text (not last). Defaults to
  176. \code{apply_alpha(base_color, 0.6)}. Modifies the
  177. \verb{.left-column h2, .left-column h3} classes.}
  178. \item{left_column_selected_color}{Left Column Current Selection. Defaults to
  179. \code{base_color}. Modifies the
  180. \verb{.left-column h2:last-of-type, .left-column h3:last-child} classes.}
  181. \item{blockquote_left_border_color}{Blockquote Left Border Color. Defaults
  182. to \code{apply_alpha(base_color, 0.5)}. Modifies the \code{blockquote} element.}
  183. \item{table_border_color}{Table top/bottom border. Defaults to #666.
  184. Modifies the \verb{table: border-top, border-bottom} elements.}
  185. \item{table_row_border_color}{Table row inner bottom border. Defaults to
  186. #ddd. Modifies the \verb{table thead th: border-bottom} elements.}
  187. \item{table_row_even_background_color}{Table Even Row Background Color.
  188. Defaults to \code{lighten_color(base_color, 0.8)}. Modifies the
  189. \verb{thead, tfoot, tr:nth-child(even)} elements.}
  190. \item{base_font_size}{Base Font Size for All Slide Elements (must be \code{px}).
  191. Defaults to 20px. Modifies the \code{html} element. The value of this variable
  192. is also stored as a CSS variable that can be referenced with
  193. \code{var(--base-font-size)} in any argument of a style function or in custom
  194. CSS.}
  195. \item{text_font_size}{Slide Body Text Font Size. Defaults to 1rem. Modifies
  196. the \code{.remark-slide-content} class. The value of this variable is also
  197. stored as a CSS variable that can be referenced with
  198. \code{var(--text-font-size)} in any argument of a style function or in custom
  199. CSS.}
  200. \item{header_h1_font_size}{h1 Header Text Font Size. Defaults to 2.75rem.
  201. Modifies the \verb{.remark-slide-content h1} class. The value of this variable
  202. is also stored as a CSS variable that can be referenced with
  203. \code{var(--header-h1-font-size)} in any argument of a style function or in
  204. custom CSS.}
  205. \item{header_h2_font_size}{h2 Header Text Font Size. Defaults to 2.25rem.
  206. Modifies the \verb{.remark-slide-content h2} class. The value of this variable
  207. is also stored as a CSS variable that can be referenced with
  208. \code{var(--header-h2-font-size)} in any argument of a style function or in
  209. custom CSS.}
  210. \item{header_h3_font_size}{h3 Header Text Font Size. Defaults to 1.75rem.
  211. Modifies the \verb{.remark-slide-content h3} class. The value of this variable
  212. is also stored as a CSS variable that can be referenced with
  213. \code{var(--header-h3-font-size)} in any argument of a style function or in
  214. custom CSS.}
  215. \item{header_background_auto}{Add background under slide title automatically
  216. for h1 header elements. If not enabled, use \code{class: header_background} to
  217. enable. Defaults to \code{FALSE}.}
  218. \item{header_background_color}{Background Color for h1 Header with
  219. Background. Defaults to \code{header_color}. Modifies the
  220. \verb{.remark-slide-content h1} class. The value of this variable is also
  221. stored as a CSS variable that can be referenced with
  222. \code{var(--header-background-color)} in any argument of a style function or in
  223. custom CSS.}
  224. \item{header_background_text_color}{Text Color for h1 Header with
  225. Background. Defaults to \code{background_color}. Modifies the
  226. \verb{.remark-slide-content h1} class. The value of this variable is also
  227. stored as a CSS variable that can be referenced with
  228. \code{var(--header-background-text-color)} in any argument of a style function
  229. or in custom CSS.}
  230. \item{header_background_padding}{Padding for h1 Header with Background.
  231. Defaults to \code{NULL}. Modifies the \verb{.remark-slide-content h1} class.}
  232. \item{header_background_content_padding_top}{Top Padding for Content in
  233. Slide with Header with Background. Defaults to 7rem. Modifies the
  234. \code{.remark-slide-content} class.}
  235. \item{header_background_ignore_classes}{Slide Classes Where Header with
  236. Background will not be Applied. Defaults to
  237. \code{c('normal', 'inverse', 'title', 'middle', 'bottom')}. Modifies the
  238. \code{.remark-slide-content} class.}
  239. \item{text_slide_number_font_size}{Slide Number Text Font Size. Defaults to
  240. 0.9em. Modifies the \code{.remark-slide-number} class.}
  241. \item{text_font_google}{Use \code{google_font()} to specify body font. Defaults
  242. to \code{NULL}. Modifies the \code{body} element.}
  243. \item{text_font_family}{Body Text Font Family (xaringan default is
  244. \code{'Droid Serif'}). Defaults to Noto Sans. Modifies the \code{body} element. The
  245. value of this variable is also stored as a CSS variable that can be
  246. referenced with \code{var(--text-font-family)} in any argument of a style
  247. function or in custom CSS.}
  248. \item{text_font_weight}{Body Text Font Weight. Defaults to normal. Modifies
  249. the \code{body} element.}
  250. \item{text_font_url}{Body Text Font URL(s). Defaults to
  251. https://fonts.googleapis.com/css?family=Noto+Sans:400,400i,700,700i&display=swap.
  252. Modifies the \verb{@import url()} elements.}
  253. \item{text_font_family_fallback}{Body Text Font Fallbacks. Defaults to
  254. -apple-system, BlinkMacSystemFont, avenir next, avenir, helvetica neue,
  255. helvetica, Ubuntu, roboto, noto, segoe ui, arial. Modifies the \code{body}
  256. element. The value of this variable is also stored as a CSS variable that
  257. can be referenced with \code{var(--text-font-family-fallback)} in any argument
  258. of a style function or in custom CSS.}
  259. \item{text_font_base}{Body Text Base Font (Total Failure Fallback). Defaults
  260. to sans-serif. Modifies the \code{body} element. The value of this variable is
  261. also stored as a CSS variable that can be referenced with
  262. \code{var(--text-font-base)} in any argument of a style function or in custom
  263. CSS.}
  264. \item{header_font_google}{Use \code{google_font()} to specify header font.
  265. Defaults to \code{NULL}. Modifies the \code{body} element.}
  266. \item{header_font_family}{Header Font Family (xaringan default is
  267. \code{'Yanone Kaffeesatz'}). Defaults to Cabin. Modifies the \verb{h1, h2, h3}
  268. elements. The value of this variable is also stored as a CSS variable that
  269. can be referenced with \code{var(--header-font-family)} in any argument of a
  270. style function or in custom CSS.}
  271. \item{header_font_weight}{Header Font Weight. Defaults to 600. Modifies the
  272. \verb{h1, h2, h3} elements.}
  273. \item{header_font_url}{Header Font URL. Defaults to
  274. https://fonts.googleapis.com/css?family=Cabin:600,600i&display=swap.
  275. Modifies the \verb{@import url} elements.}
  276. \item{code_font_google}{Use \code{google_font()} to specify code font. Defaults
  277. to \code{NULL}. Modifies the \code{body} element.}
  278. \item{code_font_family}{Code Font Family. Defaults to Source Code Pro.
  279. Modifies the \verb{.remark-code, .remark-inline-code} classes. The value of
  280. this variable is also stored as a CSS variable that can be referenced with
  281. \code{var(--code-font-family)} in any argument of a style function or in custom
  282. CSS.}
  283. \item{code_font_size}{Code Text Font Size. Defaults to 0.9rem. Modifies the
  284. \code{.remark-inline} class. The value of this variable is also stored as a CSS
  285. variable that can be referenced with \code{var(--code-font-size)} in any
  286. argument of a style function or in custom CSS.}
  287. \item{code_font_url}{Code Font URL. Defaults to
  288. https://fonts.googleapis.com/css?family=Source+Code+Pro:400,700&display=swap.
  289. Modifies the \verb{@import url} elements.}
  290. \item{code_font_family_fallback}{Code Font Fallback. Defaults to Menlo,
  291. Consolas, Monaco, Liberation Mono, Lucida Console. Modifies the
  292. \verb{.remark-code, .remark-inline-code} classes.}
  293. \item{colors}{A named vector of custom colors. The names of the colors
  294. become CSS variables and classes that can be used within your slides.
  295. For example, \code{colors = c(blue = "#bad4ed")} adds a CSS variable
  296. \code{--blue}, a \code{.blue} CSS class that applies the color to the text or
  297. foreground color, and a \code{.bg-blue} CSS class that applies the color
  298. to the background.}
  299. \item{extra_css}{A named list of CSS definitions each containing a named list
  300. of CSS property-value pairs, i.e.
  301. \code{list(".class-id" = list("css-property" = "value"))}.}
  302. \item{extra_fonts}{A list of additional fonts to import, each list element
  303. can be either a URL as a character string or a call to
  304. \code{\link{google_font}()}. To use a font imported in \code{extra_fonts}, you
  305. will need to write custom CSS rules that apply the font to an element or
  306. class with the \code{font-family} property. See the \strong{Fonts} section of
  307. \code{vignette("xaringanthemer")} for an example.}
  308. \item{outfile}{Customized xaringan CSS output file name, default is "xaringan-themer.css"}
  309. }
  310. \description{
  311. The default xaringan theme with a single color used for color
  312. accents on select elements (headers, bold text, etc.).
  313. }
  314. \section{Usage}{
  315. To use the styles created by this theme function, make sure
  316. that you use \code{xaringan-themer.css} as your CSS file in your slides' YAML
  317. header. If you change the name of the output file using the \code{outfile}
  318. argument, use that name instead of the default file name.\if{html}{\out{<div class="yaml">}}\preformatted{output:
  319. xaringan::moon_reader:
  320. css: xaringan-themer.css`
  321. }\if{html}{\out{</div>}}
  322. }
  323. \examples{
  324. # Create a xaringan style in a temporary file
  325. xaringan_themer_css <- tempfile("xaringan-themer-", fileext = ".css")
  326. style_mono_accent(
  327. base_color = "#43418A",
  328. outfile = xaringan_themer_css # omit in your slides to write the
  329. # styles to xaringan-themer.css
  330. )
  331. # View the CSS:
  332. # file.edit(xaringan_themer_css)
  333. }
  334. \seealso{
  335. Other themes:
  336. \code{\link{style_duo_accent_inverse}()},
  337. \code{\link{style_duo_accent}()},
  338. \code{\link{style_duo}()},
  339. \code{\link{style_mono_accent_inverse}()},
  340. \code{\link{style_mono_dark}()},
  341. \code{\link{style_mono_light}()},
  342. \code{\link{style_solarized_dark}()},
  343. \code{\link{style_solarized_light}()},
  344. \code{\link{style_xaringan}()}
  345. Other Monotone themes:
  346. \code{\link{style_mono_accent_inverse}()},
  347. \code{\link{style_mono_dark}()},
  348. \code{\link{style_mono_light}()}
  349. }
  350. \concept{Monotone themes}
  351. \concept{themes}