Home Manual Reference Source Repository

Variable

Static Public Summary
public

Defaults for the presets.
public

Defaults for the presets.
Static Private Summary
private

Default classList for the plugin.

Static Public

public PLUGIN_DEFAULTS: object source 

import {PLUGIN_DEFAULTS} from 'paraglider/src/config.js'

Defaults for the presets.

Properties:

NameTypeAttributeDescription
classNames object
  • optional

Mapping of class names to be used by the plugin.
classNames.pluginLoaded string
  • optional
  • default: 'pluginLoaded'

Applied when the plugin has been loaded
classNames.init string
  • optional
  • default: 'init'

Applied when the plugin has been initialized. Removed on first interaction.
classNames.slides string
  • optional
  • default: 'slides'

This element will be used to track touches. This is the wrapper around the slides.
classNames.slide string
  • optional
  • default: 'slide'

Selector for each single slide.
classNames.current string
  • optional
  • default: 'current'

Applied to the currently visible slide
classNames.previous string
  • optional
  • default: 'previous'

Applied to the previous slide in the queue
classNames.next string
  • optional
  • default: 'next'

Applied to the next slide in the queue
addClasses object
  • optional

Map of class names to be added to slides.
addClasses.previous object
  • optional
  • default: true

Sets previous class name to slides.
addClasses.current object
  • optional
  • default: true

Sets current class name to slides.
addClasses.next object
  • optional
  • default: true

Sets next class name to slides.
addMultiClasses object
  • optional

Map of class names to be added to slides using a counter.
addMultiClasses.previous object
  • optional
  • default: undefined

Sets previous class name to slides using a counter.
addMultiClasses.current object
  • optional

Sets current class name to slides using a counter.
addMultiClasses.next object
  • optional
  • default: undefined

Sets next class name to slides using a counter.
enableTouch boolean
  • optional
  • default: true

Enable touch interaction.
enableSwipe boolean
  • optional
  • default: true

Enable mouse/drag/swipe interaction.
loop boolean
  • optional
  • default: false

Enable looping slides.
onInit onInit
  • optional
  • default: null
  • nullable: true

Callback when the slider has been created.
onDestroy onDestroy
  • optional
  • default: null
  • nullable: true

Callback when the slider has been destroyed.
onSlide onSlide
  • optional
  • default: null
  • nullable: true

Callback while the slider is moving.
onEnd onEnd
  • optional
  • default: null
  • nullable: true

Callback while the slider stopped moving.
speed number
  • optional
  • default: 250

Animation duration when using paging.
spring number
  • optional
  • default: 100

Animation duration when snapping.
snapBackAt number
  • optional
  • default: 0.25

Amount of distance needed to snap. [0, 1]
threshold number
  • optional
  • default: 10

Threshold of pixels until the sliding mechanisms is triggered.
initialSlide number
  • optional
  • default: 0

Initially visible slide
visibleSlides number
  • optional
  • default: 1

Amount of visible slides
slideBy number
  • optional
  • default: 1

Amount of slides to slide on interaction

public PRESET_DEFAULTS: object source 

import {PRESET_DEFAULTS} from 'paraglider/src/config.js'

Defaults for the presets.

Properties:

NameTypeAttributeDescription
classNames object
  • optional

Mapping of class names to be used by the plugin.
classNames.pluginLoaded string
  • optional
  • default: 'pluginLoaded'

Applied when the plugin has been loaded
classNames.init string
  • optional
  • default: 'init'

Applied when the plugin has been initialized. Removed on first interaction.
classNames.slides string
  • optional
  • default: 'slides'

This element will be used to track touches. This is the wrapper around the slides.
classNames.slide string
  • optional
  • default: 'slide'

Selector for each single slide.
classNames.current string
  • optional
  • default: 'current'

Applied to the currently visible slide
classNames.previous string
  • optional
  • default: 'previous'

Applied to the previous slide in the queue
classNames.next string
  • optional
  • default: 'next'

Applied to the next slide in the queue
classNames.dot string
  • optional
  • default: 'dot'

Selector for pager dots.
classNames.active string
  • optional
  • default: 'active'

Active class for pager dots.
classNames.nextButton string
  • optional
  • default: 'nextButton'

Selector for the navigation to the next slide.
classNames.prevButton string
  • optional
  • default: 'prevButton'

Selector for the navigation to the previous slide.
addClasses object
  • optional

Map of class names to be added to slides.
addClasses.previous object
  • optional
  • default: true

Sets previous class name to slides.
addClasses.current object
  • optional
  • default: true

Sets current class name to slides.
addClasses.next object
  • optional
  • default: true

Sets next class name to slides.
addMultiClasses object
  • optional

Map of class names to be added to slides using a counter.
addMultiClasses.previous object
  • optional
  • default: undefined

Sets previous class name to slides using a counter.
addMultiClasses.current object
  • optional

Sets current class name to slides using a counter.
addMultiClasses.next object
  • optional
  • default: undefined

Sets next class name to slides using a counter.
enableTouch boolean
  • optional
  • default: true

Enable touch interaction.
enableSwipe boolean
  • optional
  • default: true

Enable mouse/drag/swipe interaction.
loop boolean
  • optional
  • default: false

Enable looping slides.
onInit onInit
  • optional
  • default: null
  • nullable: true

Callback when the slider has been created.
onDestroy onDestroy
  • optional
  • default: null
  • nullable: true

Callback when the slider has been destroyed.
onSlide onSlide
  • optional
  • default: null
  • nullable: true

Callback while the slider is moving.
onEnd onEnd
  • optional
  • default: null
  • nullable: true

Callback while the slider stopped moving.
speed number
  • optional
  • default: 250

Animation duration when using paging.
spring number
  • optional
  • default: 100

Animation duration when snapping.
snapBackAt number
  • optional
  • default: 0.25

Amount of distance needed to snap. [0, 1]
threshold number
  • optional
  • default: 10

Threshold of pixels until the sliding mechanisms is triggered.
initialSlide number
  • optional
  • default: 0

Initially visible slide
visibleSlides number
  • optional
  • default: 1

Amount of visible slides
slideBy number
  • optional
  • default: 1

Amount of slides to slide on interaction

Static Private

private classNames: object source 

import {classNames} from 'paraglider/src/config.js'

Default classList for the plugin. This object can be replaced but not merged

Properties:

NameTypeAttributeDescription
pluginLoaded string

Applied when the plugin has been loaded
init string

Applied when the plugin has been initialized. Removed on first interaction.
slides string

This element will be used to track touches. This is the wrapper around the slides.
slide string

Selector for each single slide.
current string

Applied to the currently visible slide
previous string

Applied to the previous slide in the queue
next string

Applied to the next slide in the queue