😎 Give your xaringan slides some style
Du kannst nicht mehr als 25 Themen auswählen Themen müssen entweder mit einem Buchstaben oder einer Ziffer beginnen. Sie können Bindestriche („-“) enthalten und bis zu 35 Zeichen lang sein.

444 Zeilen
20KB

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