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

399 lines
18KB

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