Code Monkey home page Code Monkey logo

scrms's Introduction

SCRMS: Easy-to-Use text scramble animation

SCRMS is a lightweight JavaScript library for implementing a scramble text animation in your web applications. With SCRMS, you can easily integrate this animation into your projects.

Installation

You can install SCRMS via npm:

npm install scrms 

to import SCRMS:

import Scramble from "scrms";

USAGE:

basic example on a single HTML element:

const animation = new Scramble("#cssSelector");

you can also use a variable instead of a CSS selector

usage with settings:

const animation = new Scramble(ele, {
  duration: 1,
  onAnimating: () => {
    seekSlider.value = parseFloat(animation.progress).toFixed(2) * 100;
  },

  onAnimationEnd: () => {
    seekSlider.value = 0;
  },
});

object methods avaiable to use:

obj.play()

obj.pause()

obj.stop()

obj.restart()

settings avaiable to change:

keep calling a function as long as the animation is happening: onAnimating: () => {}

call a function as soon as the animation ends: onAnimationEnd: () => {}}

the duration of how long should the animation take to finish: duration: number

a delay to add before the animation fires: delay: number

if you want the animation to start from somewhere in the middle: progress: number from 0 to 1

scrms's People

Contributors

sibaiper avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.