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

436 lines
19KB

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