Skip to content

Veams/component-slide-fox

Repository files navigation

npm version Gitter Chat

Slide Fox

Description

Represents an element that slides into view when it's scrolled into the viewport.


Requirements


Installation

Installation with Veams

veams install component slide-fox
veams -i c slide-fox

Fields

slide-fox.hbs

The partial is a \{{#wrapWith}} helper. Documentation for wrapWith helper.

Settings

Parameter Type Value Description
settings.slideFoxContextClass String default Context class of component.
settings.slideFoxClasses String Modifier classes for component.
settings.slideFoxJsOptions Object JavaScript options which gets stringified.

JavaScript Options

The module gives you the possibility to override default options:

Option Type Default Description
visibleClass String 'is-visible' Class to be set when Slide Fox becomes visible.
repeatAnimation Boolean true The slide-fox animation will repeat each time it enters the viewport.