😎 Give your xaringan slides some style
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

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