sliderTV.md

SliderTV : object

SliderTV is an easy-to-use jQuery slider plugin optimized for Smart TV apps. Use jQuery SliderTV for controlling any HTML based content in horizontal or vertical order in a carousel-like fashion.

Kind: global namespace
See

• README.md for further information.
• Examples folder for working examples and common settings.

Version: 1.0
Author: GibboK
License: The MIT License (MIT)

• SliderTV : object
  • .defaults : object
  • .SliderTV()
  • .init()
  • ._getId()
  • ._listen()
  • ._calculateMidPoint()
  • ._getItemDoms()
  • ._setItemPositions()
  • ._setFocus()
  • ._removeFocus()
  • ._createBullets()
  • ._getBullets()
  • ._updateBullets()
  • ._deactiveBullets()
  • ._getNavigation()
  • ._showHidePrevNext()
  • ._isItemExists()
  • ._moveTo()

SliderTV.defaults : object

Plugin's defaults are available using $.fn.sliderTV.defaults;. Example: $.fn.sliderTV.defaults.animation.easing = 'swing';.

Kind: static namespace of SliderTV
Properties

Name	Type	Description
animation	object	The default values for the animation.
animation.duration	number	A number determining how long the animation will run.
animation.easing	string	A string indicating which easing function to use for the transition; jQuery easing values are accepted.
animation.isVertical	string	A boolean indicating if the direction of the animation is vertical or horizontal.
bullets	object	The default values for bullets.
bullets.canShow	boolean	A boolean indicating if bullets will be rendered or not.

SliderTV.SliderTV()

Kind: static method of SliderTV
Properties

Name	Type	Description
_id	string	A string indicating the slider id.
_midPoints	number	Values for slider dimensions midpoints.
_midPoints.x	number	A number indicating the horizontal center point for the slider.
_midPoints.y	number	A number indicating the vertical center point for the slider.
_itemDoms	array	DOMs references of slidable items.
_focus	number	A number indicating the index value of the focused slidable item.
_prevDom	object	A DOM reference to 'Previous' navigation element.
_nextDom	object	A DOM reference to 'Next' navigation element.
_canCheckMovePrevNext	boolean	A boolean value determining the executing of rendering navigation.
_isAnimationOn	boolean	A boolean value indicating when an animation is on going. If true interaction on Slider are allowed, otherwise not.

SliderTV.init()

Initialize and start sequence.

Kind: static method of SliderTV

SliderTV._getId()

Get the id for slider instance.

Kind: static method of SliderTV

SliderTV._listen()

Listening to events triggered on the slider.

Kind: static method of SliderTV

SliderTV._calculateMidPoint()

Calculate mid points for slider container.

Kind: static method of SliderTV

SliderTV._getItemDoms()

Get DOMs for slidable items.

Kind: static method of SliderTV

SliderTV._setItemPositions()

Set CSS position for slidable items.

Kind: static method of SliderTV

SliderTV._setFocus()

Set focus on slidable item.

Kind: static method of SliderTV

SliderTV._removeFocus()

Remove focus from slidable item in focus.

Kind: static method of SliderTV

SliderTV._createBullets()

Create a bullet list based on the number and status of slidable items.

Kind: static method of SliderTV

SliderTV._getBullets()

Get dom for bullets container.

Kind: static method of SliderTV

SliderTV._updateBullets()

Update bullets and set active one.

Kind: static method of SliderTV

SliderTV._deactiveBullets()

Deactivate bullets.

Kind: static method of SliderTV

SliderTV._getNavigation()

Get dom for navigational elements.

Kind: static method of SliderTV

SliderTV._showHidePrevNext()

Show or hide navigational elements.

Kind: static method of SliderTV

SliderTV._isItemExists()

Check if slidable item at a specific index exists.

Kind: static method of SliderTV

SliderTV._moveTo()

Move slidable items in order to focus target.

Kind: static method of SliderTV

Type	Description
string | number	Index target to move and focus to. Only possible values: [to=move:next] [to=move:prev] [to=number]