autoplay

Defines the play mode of a timer.

The autoplay parameter has no effect when the timer is added to a timeline, and will be overridden to false.

Accepts

Boolean | onScroll()

If set to true the timer plays automatically
If set to false the timer has to be manually played
If set to onScroll() the timer will starts when the scroll thresholds conditions are met

Default

true

To change the default value globally, update the engine.defaults object.

import { engine } from 'animejs';
engine.defaults.autoplay = false;

autoplay code example

const [ $time ] = utils.$('.time');
const [ $playButton ] = utils.$('.play');

const timer = createTimer({
  autoplay: false,
  onUpdate: self => $time.innerHTML = self.currentTime
});


const playTimer = () => timer.play();

$playButton.addEventListener('click', playTimer);

<div class="large centered row">
  <div class="half col">
    <pre class="large log row">
      <span class="label">current time</span>
      <span class="time value lcd">0</span>
    </pre>
  </div>
</div>
<div class="medium row">
  <fieldset class="controls">
    <button class="play">Play</button>
  </fieldset>
</div>

Previous Next