Package 'scrollytell'

Title: Scrollytelling for RMarkdown and Shiny
Description: Uses the scrollama library to provide scrolly telling functionality for R.
Authors: Pearce Adam [aut] (Original javascript author of graph-scroll.js), Roelof Waaijman Waaijman [aut, cre], Edwin de Jonge [aut]
Maintainer: Roelof Waaijman Waaijman <[email protected]>
License: GPL-3 + file LICENSE
Version: 0.1.0.9000
Built: 2024-06-13 02:14:06 UTC
Source: https://github.com/statistiekcbs/scrollytell

Help Index


Container for scrollytelling

Description

Container element that contains a 'scroll_graph' and

Usage

scrolly_container(outputId, ..., width = "100%", height = NULL)

Sticky graph

Description

'scrolly_graph' should be used within a 'scrolly_container' This will be the "sticky" part that remains in view until the user scrolls beyond the end of the container

Usage

scrolly_graph(..., width = "60%", class = "scrolly-graph")

Arguments

...

elements that will be part of the sticky graph

width

Width of the graph in the 'scrolly_container'

class

The css class of the container element (do not remove)


Section element

Description

section element of the scrolly container. When the section element is selected, the value of the container is equal to the section id.

Usage

scrolly_section(id, ..., class = "scrolly-section")

Arguments

id

ID of scrolly_section.

...

elements that are part of the section

css

class, do not remove


container for scrolly_sections.

Description

The non-sticky part of a 'scrolly_container'. Contains the text 'section's that will scroll when a user scrolls the 'scrolly_container'.

Usage

scrolly_sections(..., width = "40%", class = "scrolly-sections")

Arguments

...

section elements

width

Width of the non-sticky part

class

css class used


scrollytell

Description

scrollytell

Usage

scrollytell(container_id = NULL, width = NULL, height = 0)