NewsTicker

NewsTicker

new NewsTicker(element, options)

Source:
Parameters:
NameTypeDescription
elementHTMLElement

DOM element for component instantiation and scope

optionsObject
Properties
NameTypeDescription
toggleSelectorString

Selector for toggling element

prevSelectorString

Selector for prev element

nextSelectorString

Selector for next element

contentClassString

Selector for the content container

slidesClassString

Selector for the slides container

slideClassString

Selector for the slide items

currentSlideClassString

Selector for the counter current slide number

Classes

NewsTicker

Methods

checkIndex()

Description:
  • Action to update slides index and position.

Source:

destroy()

Description:
  • Destroy component.

Source:

handleAutoPlay()

Description:
  • Toggles play/pause slides.

Source:

handleFocus(e)

Description:
  • Trigger events on focus.

Source:
Parameters:
NameTypeDescription
eEvent

handleMouseOut()

Description:
  • Trigger events on mouseout.

Source:

handleMouseOver()

Description:
  • Trigger events on mouseover.

Source:

handleResize()

Description:
  • Trigger events on resize.

Source:

init()

Description:
  • Initialise component.

Source:

moveSlides(transition)

Description:
  • Transition for the slides.

Source:
Parameters:
NameTypeDescription
transitionBoolean

shiftSlide(dir, stopAutoPlay)

Description:
  • Action to shift next or previous slide.

Source:
Parameters:
NameTypeDescription
dirint
stopAutoPlayBoolean

(static) autoInit(root) → {NewsTicker}

Source:
Parameters:
NameTypeDescription
rootHTMLElement

DOM element for component instantiation and scope

Returns:

An instance of News ticker.

Type
NewsTicker