Class

Marquee

Marquee(el, optionsopt)

Constructor

# new Marquee(el, optionsopt)

Parameters:
Name Type Attributes Default Description
el jQuery | HTMLElement jQuery object or HTMLElement instance of the marquee wrapper
options Marquee#MarqueeOptions <optional>
{} Options for the marquee

View Source src/Marquee.js, line 31

Example
const marquee = new Marquee($(".marquee"), {});
// or
const marquee = new Marquee(document.querySelector(".marquee")), {});

Methods

# kill()

Kill the marquee

View Source src/Marquee.js, line 141

Example
const marquee = new Marquee($(".marquee"), {});
marquee.kill();

# refresh()

Refresh the marquee

View Source src/Marquee.js, line 74

Example
const marquee = new Marquee($(".marquee"), {});
marquee.refresh();

Type Definitions

Object

# MarqueeOptions

Marquee options
Properties:
Name Type Description
speed number
direction 'left' | 'right'
pauseOnHover boolean

View Source src/Marquee.js, line 5