Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

veams-component-slide-fox

Veams5MIT5.1.1

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

veams

readme

npm version Gitter Chat

Slide Fox

Description

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


Requirements

  • Veams >= v5.0.0 - Veams Framework.

Installation

Installation with Veams

veams install vc slide-fox


Fields

slide-fox.hbs

The partial is a wrapWith partial.

Settings

  • 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:

  • visibleClass {String} ['is-visible'] - Class to be set when Slide Fox becomes visible.

changelog

v5.1.1

  • Update readme

v5.1.0

v5.0.0

  • Update folder structure to be in sync with latest generator output
  • Remove import snippets from INSERTPOINTS.md

v4.0.0

  • Update insertpoints paths for new folder structure (used in generator-veams v9.x)
  • Unify components folder structure

v3.0.1

  • Add version to js

v3.0.0

  • Update source code to support Veams 5 framework

v2.1.2

  • Update insertpoints

v2.1.1

  • Update insertpoints
  • Update comment in sass file

v2.1.0

  • Refactor data structure
  • Add all important notes to readme
  • Exclude Insertpoints into own file
  • Add self-contained option
  • Create module based variables in global context

v2.0.0

  • make module compatible with VeamsQuery

v1.0.4

  • pass element instead of jQuery object to Helpers.isInViewport

v1.0.3

  • added global module registry

v1.0.2

  • changed id to tag

v1.0.1

  • fixed @ref tags

v1.0.0

  • initial version