xaringanExtra

xaringanExtra is a playground of enhancements and extensions for xaringan slides.

• Add an overview of your presentation with tile view
• Make your slides editable
• Share your slides in style with share again
• Broadcast your slides in real time to viewers with broadcast
• Scribble on your slides during your presentation with scribble
• Announce slide changes with a subtle tone
• Animate slide transitions with animate.css
• Add tabbed panels to slides with panelset
• Add a logo to all of your slides with logo
• Add a top or bottom banner to all of your slides with banner
• Add a search box to search through your slides with search
• Use the Tachyons CSS utility toolkit
• Add a live video feed of your webcam
• Add one-click code copying with clipboard
• Always play gifs from the start with freezeframe
• Fit your slides to fill the browser window
• Add extra CSS styles

Each item can be enabled separately, or load everything at once with a single call.

```{r xaringanExtra, echo=FALSE}
xaringanExtra::use_xaringan_extra(c("tile_view", "animate_css", "tachyons"))

## Installation

You can install the released version of xaringanExtra from CRAN:

``` r
install.packages("xaringanExtra")

You can install the latest development version from GitHub:

# install.packages("remotes")
remotes::install_github("gadenbuie/xaringanExtra")

or from gadenbuie.r-universe.dev:

options(repos = c(
  gadenbuie = 'https://gadenbuie.r-universe.dev',
  CRAN = 'https://cloud.r-project.org'
))

install.packages('xaringanExtra')

🗺 Tile View

📺 Tile View Demo

Tile view gives you a way to quickly jump between slides. Just press O (the letter O for Overview) at any point in your slideshow and the tile view appears. Click on a slide to jump to the slide, or press O to exit tile view.

To add tile view to your xaringan presentation, add the following code chunk to your slides’ R Markdown file.

```{r xaringan-tile-view, echo=FALSE}
xaringanExtra::use_tile_view()

Tile view is heavily inspired by (and is essentially a port to Vanilla
JavaScript of) [a jQuery remarkjs
hook](https://github.com/StephenHesperus/remark-hook/) by the same name
by [Stephen Hesperus](https://github.com/StephenHesperus).

## 📝 Editable

#### 📺 [Editable Demo](https://pkg.garrickadenbuie.com/xaringanExtra/editable/)

Editable gives you a way to write directly inside your slides, updating
your content live. Make any element of your slides editable by using the
`.can-edit[...]` class.

![](man/figures/editable.gif)

Make your slides editable with the following code chunk.

```` markdown
```{r xaringan-editable, echo=FALSE}
xaringanExtra::use_editable(expires = 1)

Then, to make a component of your slides editable, use the `.can-edit[]`
class.

``` markdown
## .can-edit[You can edit this slide title]

Editable fields that only have the .can-edit class are reset whenever the slides are re-loaded in your browser. If you want to store the edited values and have them persist across browser sessions, give each editable field a .key-<NAME> class. Be sure to make each key unique and note that the key name must be a valid CSS class, i.e. it cannot contain spaces.

## .can-edit.key-firstSlideTitle[Change this title and then reload the page]

For more complicated HTML elements, it’s best to make only spans of text editable, such as

Hello, .can-edit[world], and welcome to my talk!

or to use placeholder text.

## A few of my favorite things

.can-edit.key-likes[
- thing one
- thing two
]

📼 Share Again

📺 Share Again

Share your slides in style with share again! It adds a share bar to your slides that only shows up when they’re embedded in another page. The bar adds easy slide navigation, quick access to full screen views, and a share menu for one-click (or tap!) sharing on social media sites.

Add share again to your slides in three easy steps.

1. Add use_share_again() to your slides

   ```{r share-again, echo=FALSE}
   xaringanExtra::use_share_again()

2. Style your share bar and choose social media sites

   ```{r style-share-again, echo=FALSE}
   xaringanExtra::style_share_again(
     share_buttons = c("twitter", "linkedin", "pocket")
   )

3. Embed your slides in blogdown or R Markdown websites

   ```{r embed-xaringan, echo=FALSE}
   xaringanExtra::embed_xaringan(url = "share-again.html", ratio = "4:3")

   
   
   `embed_xaringan()` works with
   <span style="text-decoration: underline">any</span> xaringan
   presentation, *share again* not required!
   
   Here’s what your [slides will look
   like](https://pkg.garrickadenbuie.com/xaringanExtra/share-again/) in
   an R Markdown HTML document.

📡 Broadcast

📺 Broadcast Demo

Broadcast lets others follow along, in real time! Built with PeerJS, 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!

To equip your slides with broadcast capabilities, add the following chunk to your slides’ .Rmd file.

```{r broadcast, echo=FALSE}
xaringanExtra::use_broadcast()

Then, host your slides online, either on a personal webpage, or through
[Netlify](https://www.netlify.com/), [GitHub
Pages](https://pages.github.com/), [GitLab
Pages](https://docs.gitlab.com/ee/user/project/pages/), or another
service.

When you want to present, open the version of your slides hosted online
in a modern browser. Then press <kbd>P</kbd> to enter the presenter
view. Click on the **Broadcast** button to start broadcasting.

![](man/figures/broadcast.png)

After a short moment, if everything works, the broadcast button will
turn into a broadcast link. Share this link with your audience. When
they open the link, their browser will connect with yours and from then
on, whenever you advance or change slides, your viewer’s slides will
move to the current slide.

Note that the broadcast link is unique and, as the presenter, is
remembered for 4 hours. After 4 hours of inactivity, a new link will be
generated. In general, create and share the broadcast link just before
or as your event starts and certainly not more than an hour before the
presentation.

### How It Works

PeerJS creates a direct, peer-to-peer connection between your browser
and your viewer’s browsers. A third party PeerJS server is used to
initially facilitate the connection using the broadcast ID to connect
with the presenter’s browser.

After the connection is made, data is sent directly between browsers and
the PeerJS server is no longer involved. Furthermore, at no time is any
information about your presentation transmitted over the network. When
you move to a slide, say for example slide 11, **broadcast** announces
“Slide 11” to any connected viewers and JavaScript in their browser
moves their presentation to slide 11.

This has two consequences:

1.  Viewers can move around and look at slides other than the one
    currently active in the presenter’s browser. When the presenter
    changes slides, however, all viewers’ slides will move to the new
    slide.

2.  If your slides involve interactivity, such as
    [htmlwidgets](https://www.htmlwidgets.org/) or \[panelset\], changes
    made in the presenter’s view aren’t replicated for viewers. Viewers
    will be taken to the same slide as the presenter, but they will need
    to click on their own to follow interactively.

### Extra Details

It’s worth mentioning a few details. First of all, the broadcaster needs
to be connected first before viewers connect. If a viewer connects
before the broadcaster starts (or restarts), they should reload the link
to reconnect.

Similarly, if the broadcaster reloads their slides, viewers will also
need to reload to reconnect. But once everyone is connected, a message
will appear for the viewer to prompt them to reconnect.

If you are the presenter and you load the broadcast link, the broadcast
will automatically reconnect and start broadcasting. If you want to view
your slides without broadcasting, just load the plain URL for the slides
without the `?broadcast=...` portion. From this view, you can restart
the broadcast from the presenter view and if the broadcast ID is still
valid that ID will be used. To reset the broadcast ID without waiting 4
hours, load your slides with `?broadcast=1` and new broadcast link will
be created at the next broadcast.

## 👩‍🎨 Scribble

#### 📺 [Scribble Demo](https://pkg.garrickadenbuie.com/xaringanExtra/scribble/)

Scribble lets you draw on your
[xaringan](https://slides.yihui.org/xaringan) slides. Click the *pencil*
icon or press <kbd>S</kbd> to begin drawing. Pressing <kbd>S</kbd> or
starting the drawing mode toggles the scribble toolbox. There, you’ll
find the *eraser* button, which helps you remove lines from your
drawing. Or click the *trash* button to clear the drawings on the
current slide.

```` markdown
```{r xaringan-scribble, echo=FALSE}
xaringanExtra::use_scribble()

Your drawings stay with each slide when you change slides. Note that you
won’t be able to change slides while you’re in drawing mode. In fact,
you can use the <kbd>←</kbd> and <kbd>→</kbd> keys to **undo** or
**redo** your drawings.

Remember that if you use slide continuations to partially reveal slide
contents, each partial slide is technically a *brand-new* slide as far
as xaringan is concerned. This means that each partial slide will have
it’s own drawing layer and your drawings on one slide won’t carry over
to the next. (But they’ll still be there when you switch back!)

To save a copy of the slide with your drawings, your best option is to
print your presentation from the browser.

## 🔊 Slide Tone

#### 📺 [Slide Tone Demo](https://pkg.garrickadenbuie.com/xaringanExtra/slide-tone/)

Slide tone plays a subtle sound when you change slides. It was
[requested by a blind R
user](https://github.com/yihui/xaringan/issues/214) and enables users to
hear an auditory signal of their progress through the slides.

The tones increase in pitch for each slide from a low C to a high C
note. The tone pitch stays the same for incremental slides.

Visit the [slide tone demo
slides](https://pkg.garrickadenbuie.com/xaringanExtra/slide-tone/) to
experience it yourself. Or include slide tone in your next xaringan
presentation by adding the following code chunk to your slides’ R
Markdown.

```` markdown
```{r xaringan-slide-tone, echo=FALSE}
xaringanExtra::use_slide_tone()

## 📽 Animate.css

#### 📺 [Animate.css Demo](https://pkg.garrickadenbuie.com/xaringanExtra/animate-css/)

[Animate.css](https://daneden.github.io/animate.css/) is a popular
collection of CSS animations. It contains

> a bunch of cool, fun, and cross-browser animations for you to use in
> your projects. Great for emphasis, home pages, sliders, and general
> just-add-water-awesomeness.

Use `use_animate_css()` to include the animate.css stylesheets in your
slides. This function automatically modifies the CSS selector that
enables the animation so that only the slides that are visible are
animated. This drastically improves performance on large slide decks
with many animations. For use in other HTML documents, set
`xaringan = FALSE` to load the default `animate.css` file without this
performance tweak.

To use animate.css in your slides, add the following code chunk to your
slides’ R Markdown.

```` markdown
```{r xaringan-animate-css, echo=FALSE}
xaringanExtra::use_animate_css()

Then add the `animated` class and the [desired animation
class](https://daneden.github.io/animate.css/) to the slides you want to
animate. `Out` animations are only applied to slides on exit.

``` markdown
---
class: animated slideInRight fadeOutLeft

## This slide...

- slides in from the right
- and fades out to the left on exit

If you want to use the same slide transitions for all slides, you can use use_animate_all(). This function sets a default in and out animation for all slides. Animations can be disabled for individual slides by adding the class no-animation to the slide.

```{r xaringan-animate-all, echo=FALSE}
xaringanExtra::use_animate_all("slide_left")

Note: because `use_animate_all()` only imports the CSS required for the
slide in and slide out animations, you need to also include
`use_animate_css()` (see above) if you want to use other animations from
`animate.css` in your slides.

## 🗂 Panelset

#### 📺 [Panelset Demo](https://pkg.garrickadenbuie.com/xaringanExtra/panelset/)

Panelset adds accessible tabbed panels — just like R Markdown’s
`.tabset` panels — to your xaringan slides. You can activate a panel by
clicking on the tab, or you can use the keyboard. When you reach a slide
with a panelset, the left and right arrows will step through the panels.

To use panelset, add the following chunk to your slides.

```` markdown
```{r xaringan-panelset, echo=FALSE}
xaringanExtra::use_panelset()

![](man/figures/panelset.gif)

Then, create a `.panelset[...]` that contains `.panel[]`s. Each
`.panel[]` should have a `.panel-name[]` and content (everything that
isn’t the panel’s name).

``` markdown
.panel[.panel-name[NAME]
...content...
]

Here’s the example used in the demo slides.

.panelset[
.panel[.panel-name[R Code]

```{r panel-chunk, fig.show='hide'}
# ... r code ...

]

.panel[.panel-name[Plot]

] ]

### Sideways Panelsets

As an alternative to the “tabs above content” view, you can also use
*sideways* panelsets where the tabs appear beside the tabbed content.

To choose this effect, add the `.sideways` class to `.panelset` in your
slides or R Markdown text.

```` markdown
.panelset.sideways[
.panel[.panel-name[ui.R]
```r
# shiny ui code here...

]

.panel[.panel-name[server.R]

function(input, output, session) {
  # shiny server code here...
}

] ]

By default in sideways-mode, the tabs will appear on the left side. You
can choose to place the tabs on the right side by including both
`.sideways` and `.right` with `.panelset`.

```` markdown
.panelset.sideways.right[
.panel[.panel-name[ui.R]
```r
# shiny ui code here...

]

.panel[.panel-name[server.R]

function(input, output, session) {
  # shiny server code here...
}

] ]

### Use in R Markdown

[Example R Markdown output with
panelset](https://pkg.garrickadenbuie.com/xaringanExtra/panelset//rmarkdown.html)

Panelset works in all R Markdown HTML outputs like HTML reports and
[blogdown](https://bookdown.org/yihui/blogdown/) webpages!

Panelset works in the same way as `rmarkdown`’s
[tabset](https://bookdown.org/yihui/rmarkdown-cookbook/html-tabs.html)
feature, albeit with fewer style options, but the trade-off is that it
works in a wider range of document types. Generally, as long as the
output is HTML, panelset should work.

Another advantage of panelset is that it enables deeplinking: the
currently shown tab is encoded in the URL automatically, allowing users
to link to open tabs. Users can also right click on a panel’s tab and
select *Copy Link* to link directly to a specific panel’s tab, which
will appear in view when visiting the copied link.

With standard R Markdown,
i.e. [rmarkdown::html_document()](https://rmarkdown.rstudio.com/docs/reference/html_document.html),
you can use the following template.

``` markdown
# Panelset In R Markdown! {.panelset}

## Tab One

Amet enim aptent molestie vulputate pharetra
vulputate primis et vivamus semper.

## Tab Two

### Sub heading one

Sit etiam malesuada arcu fusce ullamcorper
interdum proin tincidunt curabitur felis?

## Tab Three

Adipiscing mauris egestas vitae pretium 
ad dignissim dictumst platea!

# Another section

This content won't appear in a panel.

In other, less-standard R Markdown HTML formats, you can use pandoc’s fenced divs.

::::: {.panelset}

::: {.panel}
[First Tab]{.panel-name}

Lorem sed non habitasse nulla donec egestas magna
enim posuere fames ante diam!
:::

::: {.panel}
[Second Tab]{.panel-name}

Consectetur ligula taciti neque scelerisque gravida
class pharetra netus lobortis quisque mollis iaculis.
:::

:::::

Alternatively, you can also use raw HTML.

<div class="panelset">
  <div class="panel">
    <div class="panel-name">First Tab</div>
    <!-- Panel content -->
    <p>Lorem ipsum, etc, etc</p>
  </div>
  <div class="panel">
    <div class="panel-name">Second Tab</div>
    <!-- Panel content -->
    <p>Lorem ipsum, etc, etc</p>
  </div>
</div>

Customize Panelset Appearance

To customize the appearance of your panels, you can use style_panelset_tabs() called directly in an R chunk in your slides.

```{r echo=FALSE}
style_panelset_tabs(foreground = "honeydew", background = "seagreen")

The panelset uses opacity to soften the in-active tabs to increase the
chances that the tabs will work with your slide theme. If you decide to
change your tab colors or to use solid colored tabs, you’ll likely want
to set `inactive_opacity = 1` in `style_panelset()` (or the
corresponding `--panel-tab-inactive-opacity` CSS variable).

Behind the scenes, `style_panelset_tabs()` updates the values of [custom
CSS properties](https://developer.mozilla.org/en-US/docs/Web/CSS/--*)
that define the panelset appearance. If you’d rather work with CSS, the
default values of these properties are shown in the CSS code below. You
can copy the whole CSS block to your slides and modify the values to
customize the style to fit your presentation.

```` markdown
```{css echo=FALSE}
.panelset {
   --panel-tab-foreground: currentColor;
   --panel-tab-background: unset;
   --panel-tab-active-foreground: currentColor;
   --panel-tab-active-background: unset;
   --panel-tab-active-border-color: currentColor;
   --panel-tab-hover-foreground: currentColor;
   --panel-tab-hover-background: unset;
   --panel-tab-hover-border-color: currentColor;
   --panel-tab-inactive-opacity: 0.5;
   --panel-tabs-border-bottom: #ddd;
   --panel-tab-font-family: Menlo, Consolas, Monaco, Liberation Mono, Lucida Console, monospace;
}

### Panelset knitr Chunks

A common use-case for **panelset** is to show the code and its output in
separate tabs. For example, you might want to first show the code to
create a plot in the first tab, with the plot itself in a second tab. On
slides where space is constrained, this approach can be useful.

To help facilitate this process, **panelset** provides a `panelset`
chunk option. When set to `TRUE`, the code is included in a panel tab
named *Code* and the output is included in a panel tab named *Output*.
Note that you still need to wrap this chunk in a panelset-creating
container.

```` markdown
.panelset[
```{r panelset = TRUE}
list(
  normal = rnorm(10),
  uniform = runif(10),
  cauchy = rcauchy(10)
)

]

You can also set the `panelset` chunk option to a named vector, where
the `source` item is the tab name for the source code and the `output`
item is the tab name for the code output.

```` markdown
```{r panelset = c(source = "ggplot2", output = "Plot")}
ggplot(Orange) +
  aes(x = age, y = circumference, colour = Tree) +
  geom_point() +
  geom_line() +
  guides(colour = FALSE) +
  theme_bw()

When your code contains multiple expressions and outputs, you may also
want to set the `results = "hold"` chunk option. Currently, knitr uses
`results = "markup"` as the default, in which case each code expression
and output pair will generate a pair of tabs.

```` markdown
```{r panelset = TRUE, results="hold"}
print("Oak is strong and also gives shade.")
print("The lake sparkled in the red hot sun.")

Finally, panelset chunks also work in R Markdown documents, but they
must be encapsulated in `<div class="panelset">` and `</div>`

```` markdown
<div class="panelset">

```{r panelset = TRUE}
print("Oak is strong and also gives shade.")