init: Initialise

Description Usage Arguments Details Animations

Description

Initialise a waypoint

Usage

1
2
3
4
5
6
7
8
9
.init(
  self,
  dom_id,
  animate = FALSE,
  animation = "bounce",
  offset = NULL,
  horizontal = FALSE,
  id = NULL
)

Arguments

self

A waypoint object.

dom_id

Id of element to attach waypoint to.

animate

Whether to animate the anchor when the waypoint is triggered.

animation

Animation to use, note that this can be overriden in the animate method.

offset

Vertical offset, an integer (pixels) or a percentage passed as a string e.g. "10".

horizontal

Whether to apply waypoints of horizontal offset.

id

Id of waypoint, see details.

Details

If you do not provide an id then you will have to rely on the get_* family of of methods to get the callbacks. If you do, you can still rely on the latter but also may access the callbacks the traditional way with 'input$idName_direction', 'input$idName_next', and 'input$idName_previous'.

Animations


RinteRface/waypointer documentation built on Feb. 2, 2020, 7:46 p.m.