😎 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.

446 lines
20KB

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