Util
You can get self object from DOM node on Xtend UI components with Xt.get.
let self = Xt.get({ name: 'xt-slider', el: document.querySelector('.my-container') })
You can set default options for all components of the same type, with Xt.options.
Xt.options['xt-slider'] = {
debug: true,
}
Listen
Listen to events, for listeners use this guideline.
| Syntax | DOM Element | Description | |
|---|---|---|---|
| Event | on.xt.slider | elements targets | Activation event (event e.detail is original event) |
| Event | off.xt.slider | elements targets | Deactivation event (event e.detail is original event) |
| Event | ondone.xt.slider | elements targets | Activation event after delay and duration |
| Event | offdone.xt.slider | elements targets | Deactivation event after delay and duration |
| Event | medialoaded.xt.slider | elements targets | Images loaded event, only when setting options.mediaLoaded: true |
| Event | autostart.xt.slider | container | Auto start event |
| Event | autostop.xt.slider | container | Auto stop event |
| Event | autoheight.xt.slider | targets | Autoheight event |
| Event | init.xt.slider | container | Init or reinit event |
| Event | status.xt.slider | container | Status event (enabled or disabled) |
| Event | restart.xt.slider | container | Restart event |
| Event | destroy.xt.slider | container | Destroy event |
Trigger
Trigger events on DOM node.
document.querySelector('#my-element-or-target').dispatchEvent(new CustomEvent('on.trigger.xt.slider'))
| Syntax | DOM Element | Description | |
|---|---|---|---|
| Event | on.trigger.xt.slider | elements targets | Activation event |
| Event | off.trigger.xt.slider | elements targets | Deactivation event |
| Event | autostart.trigger.xt.slider | container | Auto start event |
| Event | autostop.trigger.xt.slider | container | Auto stop event |
You can pass e.detail to the trigger event.
With on and off event e.detail.force = true will force the activation/deactivation skipping checks.
document.querySelector('#my-element-or-target').dispatchEvent(new CustomEvent('on.trigger.xt.slider', { detail: { force: true } }))
Properties
Access properties by getting self object.
let self = Xt.get({ name: 'xt-slider', el: document.querySelector('.my-container') })
const container = self.container
| Syntax | Description | |
|---|---|---|
| Property | componentName:String | Component name (used in Xt.get) |
| Property | options:Object | Final options |
| Property | initial:Boolean | If initial or reset activation |
| Property | index:Number | Current index of activation |
| Property | disabled:Boolean | If component disabled |
| Property | container:Node | Container node |
| Property | elements:Array | Elements nodes |
| Property | targets:Array | Targets nodes |
| Property | pags:Array | Pagination nodes |
| Property | wrap:Boolean | If wrap activation |
| Property | direction:Number | Direction 1 or -1 |
| Property | autoblock:Boolean | Block all auto logic |
| Property | dragger:Node | Dragger node |
| Property | drag.size:Number | Dragger size |
| Property | drag.sizeContent:Number | Content size |
Methods
Call methods by getting self object.
const self = Xt.get({ name: 'xt-slider', el: document.querySelector('.my-container') })
self.destroy()
self = null
| Syntax | Description | |
|---|---|---|
| Method | self.getElements(el:Node, same:Boolean = false) | Get all elements from element or target, also with same drag activation, returns Array |
| Method | self.getTargets(el:Node, same:Boolean = false) | Get all targets from element or target, also with same drag activation, returns Array |
| Method | self.getElementsGroups() | Get elements (one per group), returns Array |
| Method | self.hasCurrent({ el:Node, same:Boolean = false }) | Check if element or target is activated, returns Boolean |
| Method | self.getIndex({ el:Node }) | Get activation index of from element or target, returns Number |
| Method | self.reinit({ save:Boolean = true }) | Reinit component and save currents as initial (default: true) |
| Method | self.restart() | Restart component to initial |
| Method | self.disable() | Disable component |
| Method | self.enable() | Enable component |
| Method | self.destroy({ weak:Boolean = false }) | Destroy component |
You can get activated elements or targets with hasCurrent.
self.elements.filter(x => self.hasCurrent({ el: x }))
self.targets.filter(x => self.hasCurrent({ el: x }))
Index methods, they all consider options.loop.
| Syntax | Description | |
|---|---|---|
| Method | self.getNextIndex({ index:Number|false = false, amount:Number = 1, loop:Boolean|null = null }) | Get next activation index, returns Number|null |
| Method | self.getNext({ amount:Number = 1, loop:Boolean|null = null }) | Get next element, returns Node|null |
| Method | self.goToNext({ amount:Number = 1, force:Boolean = false, loop:Boolean|null = null }) | Activate next element, returns Node|null |
| Method | self.getPrevIndex({ index:Number|false = false, amount:Number = 1, loop:Boolean|null = null }) | Get prev activation index, returns Number|null |
| Method | self.getPrev({ amount:Number = 1, loop:Boolean|null = null }) | Get previous element, returns Node|null |
| Method | self.goToPrev({ amount:Number = 1, force:Boolean = false, loop:Boolean|null = null }) | Activate previous element, returns Node|null |
| Method | self.getNumIndex({ index:Number, loop:Boolean|null = null } | Get index from number, return Number|null |
| Method | self.getNum({ index:Number = 1, loop:Boolean|null = null }) | Get element from index, returns Node|null |
| Method | self.goToNum({ index:Number, force:Boolean = false, loop:Boolean|null = null }) | Activate index, returns Node|null |