substituteteacher.js
is a JavaScript library that lets you substitute
sentences for each other, swapping only the words necessary.
Install
Get Subbing
API
Sub(sentences, [options])
The Sub
constructor create a new instance of substitution. 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:
Options
Option | Description | Default |
---|---|---|
containerId |
Id of the injection point for HTML | "sub" |
namespace |
Namespace to prepend to classes used internally | "sub" |
interval |
Number of milliseconds between each change | 5000 |
speed |
Number of milliseconds that each step of the animation should take | 200 |
mobileWidth |
If defined, the minimum screen size at which to enable the library | null |
verbose |
True to enable console logging | false |
random |
True if the first sentence to appear should be random | false |
best |
True if the sentences should be ordered to minimize the number of changes performed | true |
clearOriginalContent |
True to empty out container and fade in the substitute teacher, false to seemlessly transition from the original content to the first item. This only works if random is false |
true |
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.