substituteteacher.js (demo)

substituteteacher.js will rotate through a series of sentences, transitioning between each one.

Quick Start

substituteteacher.js is easy to use. Add the script to your page, provide a target container and call run().

Step 0: Install

Download the latest release or install from npm:

npm install substitute-teacher --save-dev

Step 1: Add the substituteteacher.min.js file

<script src="substituteteacher.min.js"></script>

Step 2: Create your container element

<div id="sub">Fallback Text</div>

Step 3: Init substituteteacher.js

var sub = new Sub([
    "A daring JavaScript library for subsitute teachers",
    "A hilarious JavaScript library for awesome taglines",
    "A svelte JavaScript library for sweet taglines",
    "A super fun and wholesome JavaScript library for sliding fun",
    "A JavaScript library for word substitution"
]).run();

API

Sub(sentences, [options])

The Sub constructor create a new instance of sub. The sentences parameter should be a list of sentence strings. Customize the instance by passing the options parameter. The example below uses all options and their defaults:

var opts = {
  containerId: "sub",
  namespace: "sub",
  interval: 5000,
  speed: 200,
  mobileWidth: null,
  verbose: false,
  random: false,
  best: true,
  clearOriginalContent: true,
};
var sub = new Sub([
    "A daring JavaScript library for subsitute teachers",
    "A hilarious JavaScript library for awesome taglines",
    "A svelte JavaScript library for sweet taglines",
    "A badass JavaScript library for sliding fun",
    "A JavaScript library for word substitution"
], opts).run();

Options

run()

Starts the rotation between sentences, and attaches resize handlers (for disabling the library on small screens if mobileWidth is defined).

stop()

Stops the rotation between sentences, and remove resize handlers.