1.0.2 • Published 6 years ago
@veams/component-slide-fox v1.0.2
Slide Fox
Description
Represents an element that slides into view when it's scrolled into the viewport.
Requirements
- @veams/core - Veams Core Framework.
- @veams/query or
jquery- Veams Query or jQuery. - @veams/component - Veams Component.
- @veams/helpers - Veams Detection Helpers.
Installation
Installation with Veams
veams install component slide-foxveams -i c slide-foxFields
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. |