Skip to main content

.vars

.vars : Object

[read-only] The vars configuration object used to create the SplitText instance

Details​

[read-only] The vars configuration object used to create the SplitText instance.

Example​

let splitText = SplitText.create({
  type: "chars,words",
  wordsClass: "word++",
});

console.log(splitText.vars); // {type: "chars,words",wordsClass: "word++",}

You can store arbitrary data in the vars object if you want; SplitText will just ignore the properties it doesn't recognize. So, for example, you could add a "group" property so that you could group your Splits and then later to kill() all the SplitText instances from a particular group, you could do:

// helper function (reusable):
let getGroup = (group) =>
  SplitText.getAll().filter((t) => t.vars.group === group);

// then, to kill() anything with a group of "my-group":
getGroup("my-group").forEach((t) => t.kill());

Contents