Skip to content
tanglatPublic

Latest commit

 

History

7 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 

Repository files navigation

SplitFX

JavaScript text animation plugin that splits text into characters and words and animates them.

Links

Overview

SplitFX is a JavaScript text animation plugin that splits the text of HTML elements into individual units (characters and words) and animates them.

Features

  • Animate Text by Chars or Words
    You can choose to animate text by chars or words.

  • Multiple Trigger Options
    Animate HTML elements' text in and out on scroll, window load, hover, or click.

  • Full Animation Control
    Full control over animation timing, stagger, stagger direction, and easing.

  • A Variety of Built-in Text Animations
    Choose from a variety of built-in text animations such as fade, typeWriter, and more.

  • Use Your Custom Text Animations
    Build and use your own animations to create text animations tailored to your needs.

  • Different Stagger Directions
    Control the animation flow with stagger directions such as forward, backward, centerOut, random, and more.

  • Sequential Text Animations
    Run text animations step by step in a defined sequence, just like the hero of this page.

  • Supports Nested Elements
    Split and animate the text of HTML elements even when they contain nested elements.

  • Easy to Use
    A set of convenience methods that make SplitFX easier to use.

  • No Dependencies
    Built specifically for text animations with zero external dependencies.

Resources

  • SplitFX Demos
    Get inspired by ready-made text animation demos built with SplitFX.

  • SplitFX Documentation
    Find everything you need to create text animations with SplitFX.

  • SplitFX Studio
    Create, customize, and preview text animations with SplitFX Studio.

Quick Start

Include the script:

<script src="https://cdn.jsdelivr.net/npm/@tanglat/splitfx@1/dist/umd/splitfx.min.js"></script>

Example Usage:

// Select the HTML element you want to animate
const heading = document.querySelector(".heading");

// Create a new SplitFX instance with your configuration options
const textAnimator = new SplitFX({
    in: {
        mode: "chars",
        includeSpaces: true,
        animation: "fadeRight",
        duration: 500,
        easing: "ease",
        stagger: 50,
        staggerDir: "forward",
        delay: 0
    },
    out: {
        mode: "words",
        duration: 0,
        stagger: 0
    },
    tagName: "span"
});

// Animate the text of the given element every time it enters the viewport during scrolling
textAnimator.animateOnScroll(heading);

For complete documentation, more demos, visit our Website.