v0.6.0 (#164)

.Rbuildignore

@@ -13,3 +13,5 @@
 ^\.ccache$
 ^\.github$
 ^tic\.R$
+^cran-comments\.md$
+^CRAN-SUBMISSION$

CRAN-SUBMISSION

@@ -0,0 +1,3 @@
+Version: 0.6.0
+Date: 2022-06-05 18:14:23 UTC
+SHA: 0d1b5293498ccbb95c04f4e3b750604ff16d633f

DESCRIPTION

@@ -1,76 +1,51 @@
 Package: xaringanExtra
-Title: Extras And Extensions for Xaringan Slides
-Version: 0.5.5
-Authors@R: 
-    c(person(given = "Garrick",
-             family = "Aden-Buie",
-             role = c("aut", "cre"),
-             email = "[email protected]",
-             comment = c(ORCID = "0000-0002-7111-0077")),
-      person(given = "Matthew T.",
-             family = "Warkentin",
-             role = "aut",
-             email = "[email protected]",
-             comment = c("Contributed scribble", ORCID = "0000-0001-8730-3511")),
-      person(given = "Yotam",
-             family = "Mann",
-             role = "cph",
-             comment = "tone.js"),
-      person(given = "Daniel",
-             family = "Eden",
-             role = "cph",
-             comment = "animate.css"),
-      person(family = "Tachyons authors",
-             role = "cph"),
-      person(family = "Klaus Hartl, Fagner Brack, GitHub Contributors",
-             role = "cph",
-             comment = "js-cookie"),
-      person(family = "Chris Andrejewski",
-             role = "cph",
-             comment = "himalaya"),
-      person(given = "Eric",
-             family = "Londaits",
-             role = "cph",
-             comment = "text-poster.js"),
-      person(given = "Zeno",
-             family = "Rocha",
-             role = "cph",
-             comment = "clipboard.js"),
-      person(given = "Nikita",
-             family = "Karamov",
-             role = "cph",
-             comment = "shareon.js"),
-      person(given = "Ross",
-             family = "Zurowski",
-             role = "cph",
-             comment = "fitvids.js"),
-      person(family = "Michelle Bu and Eric Zhang",
-             role = "cph",
-             comment = "peerjs"),
-      person(given = "Kiril",
-             family = "Vatev",
-             role = "cph",
-             comment = "tiny.toast"),
-      person(given = "André",
-             family = "Restive",
-             role = "cph",
-             comment = "remark.search"),
-      person(family = "Printio (Juriy Zaytsev, Maxim Chernyak)",
-             role = "cph",
-             comment = "fabric.js"),
-      person(given = "Christpher",
-             family = "Antonellis",
-             role = "cph",
-             comment = "freezeframe.js"))
-Description: Extras and extensions for xaringan slides. Nagivate
-    your slides with tile view. Make your slides editable, live! Announce
-    slide changes with subtle tones. Animate slide transitions with
-    animate.css. Add tabbed panels to slides with panelset. Include
-    yourself in your slides with webcam. Scribble on your slides. Add a
-    "copy" button to your code chunk with clipboard. Use the Tachyons CSS
-    utility toolkit. Fit your slides to fill the browser window.
+Title: Extras and Extensions for 'xaringan' Slides
+Version: 0.6.0
+Authors@R: c(
+    person("Garrick", "Aden-Buie", , "[email protected]", role = c("aut", "cre"),
+           comment = c(ORCID = "0000-0002-7111-0077")),
+    person("Matthew T.", "Warkentin", , "[email protected]", role = "aut",
+           comment = c("Contributed scribble", ORCID = "0000-0001-8730-3511")),
+    person("Yotam", "Mann", role = "cph",
+           comment = "tone.js"),
+    person("Daniel", "Eden", role = "cph",
+           comment = "animate.css"),
+    person(, "Tachyons authors", role = "cph"),
+    person(, "Klaus Hartl, Fagner Brack, GitHub Contributors", role = "cph",
+           comment = "js-cookie"),
+    person(, "Chris Andrejewski", role = "cph",
+           comment = "himalaya"),
+    person("Eric", "Londaits", role = "cph",
+           comment = "text-poster.js"),
+    person("Zeno", "Rocha", role = "cph",
+           comment = "clipboard.js"),
+    person("Nikita", "Karamov", role = "cph",
+           comment = "shareon.js"),
+    person("Ross", "Zurowski", role = "cph",
+           comment = "fitvids.js"),
+    person(, "Michelle Bu and Eric Zhang", role = "cph",
+           comment = "peerjs"),
+    person("Kiril", "Vatev", role = "cph",
+           comment = "tiny.toast"),
+    person("André", "Restive", role = "cph",
+           comment = "remark.search"),
+    person(, "Printio (Juriy Zaytsev, Maxim Chernyak)", role = "cph",
+           comment = "fabric.js"),
+    person("Christpher", "Antonellis", role = "cph",
+           comment = "freezeframe.js")
+  )
+Description: Extras and extensions for 'xaringan' slides. Navigate your
+    slides with tile view. Make your slides editable, live! Announce slide
+    changes with subtle tones. Animate slide transitions with
+    'animate.css'. Add tabbed panels to slides with 'panelset'. Use the
+    'Tachyons CSS' utility toolkit for rapid slide development. Scribble
+    on your slides. Add a copy button to your code chunks with
+    'clipboard'. Add a logo or top or bottom banner to every slide.
+    Broadcast slides to stay in sync with remote viewers. Include yourself
+    in your slides with 'webcam'.  Plus a whole lot more!
 License: MIT + file LICENSE
-URL: https://github.com/gadenbuie/xaringanExtra
+URL: https://pkg.garrickadenbuie.com/xaringanExtra/,
+    https://github.com/gadenbuie/xaringanExtra
 BugReports: https://github.com/gadenbuie/xaringanExtra/issues
 Imports: 
     htmltools,
@@ -85,7 +60,6 @@ Suggests:
     xaringan
 Config/testthat/edition: 3
 Encoding: UTF-8
-LazyData: true
 Roxygen: list(markdown = TRUE)
 RoxygenNote: 7.2.0
 Collate: 
@@ -104,7 +78,6 @@ Collate:
     'styles.R'
     'search.R'
     'tachyons.R'
-    'text-poster.R'
     'tile-view.R'
     'use_logo.R'
     'utils.R'

LICENSE

@@ -1,2 +1,2 @@
-YEAR: 2019
+YEAR: 2022
 COPYRIGHT HOLDER: Garrick Aden-Buie

NAMESPACE

@@ -16,15 +16,13 @@ export(html_dependency_scribble)
 export(html_dependency_search)
 export(html_dependency_slide_tone)
 export(html_dependency_tachyons)
-export(html_dependency_text_poster)
 export(html_dependency_tile_view)
 export(html_dependency_webcam)
 export(style_banner)
 export(style_panelset)
 export(style_panelset_tabs)
 export(style_search)
 export(style_share_again)
-export(text_poster)
 export(use_animate_all)
 export(use_animate_css)
 export(use_banner)
@@ -42,7 +40,6 @@ export(use_search)
 export(use_share_again)
 export(use_slide_tone)
 export(use_tachyons)
-export(use_text_poster)
 export(use_tile_view)
 export(use_webcam)
 export(use_xaringan_extra)

NEWS.md

@@ -1,26 +1,37 @@
-# xaringanExtra (development version)
+# xaringanExtra 0.6.0 (2022-06-07)
 
+* First release available on CRAN! Read about it at [garrickadenbuie.com/blog/xaringanextra-v0.6.0/](https://www.garrickadenbuie.com/blog/xaringanextra-v0.6.0/).
+
+## New extras
+
+* Add banners to your slides with `use_banner()`. Banners are text (or other
+  HTML) that appear on every slide, for example the title of your talk or a link
+  to your slides online. (thanks @mattwarkentin and @dataning, #161)
+
+## Improved extras
+
 * Sideways panelsets collapse to standard panelsets with tabs above the content
   on small devices (max-width 480px). (#122)
 
 * Keep sideways panelset tabs on screen with long-scrolling content. (#123)
 
+* The `panelset=TRUE` chunk option now automatically sets `results="hold"`
+  unless over-ridden by a local chunk option.
+
+## Fixed extras
+
 * _share again_ no longer shows when viewing slides in the RStudio viewer pane. (#128)
 
 * `use_xaringan_extras("panelset")` is now equivalent to `use_panelset()`.
   Previously the first would not install the knitr chunk hooks.
 
-* The `panelset=TRUE` chunk option now automatically sets `results="hold"`
-  unless over-ridden by a local chunk option.
-
 * panelset now uses the xaringan knitr source hooks, restoring line highlighting
   in the source panel of panelset chunks. (#138)
 
 * Hide scribble controls when printing slides (thanks @yyzeng, #136).
 
-* Add banners to your slides with `use_banner()`. Banners are text (or other
-  HTML) that appear on every slide, for example the title of your talk or a link
-  to your slides online. (thanks @mattwarkentin and @dataning, #161)
+* `text_poster()` has been removed.
+
 
 # xaringanExtra 0.5.0 (2021-06-13)
 

R/animate.R

@@ -5,8 +5,6 @@
 #' projects. Great for emphasis, home pages, sliders, and general
 #' just-add-water-awesomeness."
 #'
-#' @return An `htmltools::tagList()` with the tile view dependencies, or an
-#'   [htmltools::htmlDependency()].
 #' @section Usage: To add animate.css to your xaringan presentation, add the
 #'   following code chunk to your slides' R Markdown file.
 #'
@@ -35,7 +33,11 @@
 #'   ```
 #'   ````
 #'
-#' @references See [animate.css](http://daneden.github.io/animate.css) for a
+#' @examples
+#' use_animate_css()
+#' html_dependency_animate_css()
+#'
+#' @references See [animate.css](https://daneden.github.io/animate.css/) for a
 #'   full list of animations.
 #'
 #' @param minified Should the minified or full CSS source be used?
@@ -44,6 +46,10 @@
 #'   presentations with many animated slides may have poor performance,
 #'   especially on page load. Set to `FALSE` to use animate.css in other
 #'   HTML-based documents.
+#'
+#' @return An `htmltools::tagList()` with the tile view dependencies, or an
+#'   [htmltools::htmlDependency()].
+#'
 #' @name animate_css
 NULL
 

R/broadcast.R

@@ -1,13 +1,16 @@
 #' Broadcast Your Slides
 #'
-#' [Experimental](https://www.tidyverse.org/lifecycle/#experimental)!
+#' [Experimental](https://lifecycle.r-lib.org/articles/stages.html)!
 #' **Broadcast** lets others follow along, in real time! Built with
 #' [PeerJS](https://peerjs.com), **broadcast** give you a unique URL to share
 #' with your viewers. Then, when they load your slides, their slides will
 #' automatically follow you as you present!
 #'
 #' @includeRmd man/fragments/broadcast-details.Rmd
 #'
+#' @examples
+#' use_broadcast()
+#'
 #' @return An `htmltools::tagList()` with the HTML dependencies required for
 #'   **broadcast**.
 #'

R/clipboard.R

@@ -4,6 +4,9 @@
 #'
 #' @includeRmd man/fragments/clipboard-details.Rmd details
 #'
+#' @examples
+#' use_clipboard()
+#'
 #' @rdname clipboard
 #' @name clipboard
 NULL
@@ -23,6 +26,10 @@ NULL
 #'   identified by the selector, minus the copy button text, is copied to the
 #'   clipboard.
 #' @param minified Should the minified clipboardjs dependency be used?
+#'
+#' @return An `htmltools::tagList()` with the HTML dependencies required for
+#'   **clipboard**.
+#'
 #' @export
 use_clipboard <- function(
   button_text = "Copy Code",

R/editable.R

@@ -7,6 +7,9 @@
 #' element a `.key-<NAME>` class, where `<NAME>` is a unique identifier (and
 #' valid CSS class).
 #'
+#' @examples
+#' use_editable()
+#'
 #' @return An `htmltools::tagList()` with the editable dependencies, or an
 #'   [htmltools::htmlDependency].
 #' @section Usage: To make your xaringan presentations _editable_, add the

R/fit-screen.R

@@ -7,6 +7,9 @@
 #' another window. To enable fit-to-screen, press **Alt**/**Option** + **F** during the
 #' slideshow. To disable, reload the slides.
 #'
+#' @examples
+#' use_fit_screen()
+#'
 #' @return An`htmltools::tagList()` with the fit-to-screen dependency, or an
 #'   [htmltools::htmlDependency()].
 #'

R/freezeframe.R

@@ -15,6 +15,8 @@
 #'   xaringanExtra::use_freezeframe()
 #'   ```
 #'   ````
+#' @examples
+#' use_freezeframe()
 #'
 #' @param selector The selector used to search for `.gifs` to freeze.
 #' @param trigger The trigger event to start animation for non-touch devices.

R/panelset.R

@@ -35,6 +35,9 @@
 #'
 #' @includeRmd man/fragments/panelset_chunks.Rmd
 #'
+#' @examples
+#' use_panelset()
+#'
 #' @name panelset
 NULL
 

R/progress-bar.R

@@ -6,6 +6,9 @@
 #' @param location One of `"top"` or `"bottom"`.
 #' @param height A valid CSS unit specifying the height of the progress bar.
 #'
+#' @return An `htmltools::tagList()` with the HTML dependencies required for
+#'   **progress bar**.
+#'
 #' @examples
 #' xaringanExtra::use_progress_bar("red", "top", "0.25em")
 #'

R/scribble.R

@@ -20,6 +20,9 @@
 #'   ```
 #'   ````
 #'
+#' @examples
+#' use_scribble()
+#'
 #' @param pen_color Initial pen color (default is `"#FF0000` (red)). Must be a
 #'   hexadecimal color, e.g. `#000` or `#4232ea`.
 #' @param pen_size Pen size (default is 3).

R/search.R

@@ -13,6 +13,9 @@
 #'   ```
 #'   ````
 #'
+#' @examples
+#' use_search()
+#'
 #' @references <https://github.com/arestivo/remark.search>
 #' @author Original implementation by André Restivo
 #' @name search