@pluginjs/animate-text

0.8.12 • Public • Published

AnimateText

npm package

A flexible modern animate-text js plugin.

Samples

Introduction

Installation

Yarn

yarn add @pluginjs/animate-text

NPM

npm i @pluginjs/animate-text

Getting Started

CDN:

Development:

<script src="https://unpkg.com/@pluginjs/animate-text/dist/animate-text.js"></script>
<link rel="stylesheet" href="https://unpkg.com/@pluginjs/animate-text/dist/animate-text.css">

Production:

<script src="https://unpkg.com/@pluginjs/animate-text/dist/animate-text.min.js"></script>
<link rel="stylesheet" href="https://unpkg.com/@pluginjs/animate-text/dist/animate-text.min.css">

Initialize

HTML:

<div class="element"></div>

ECMAScript Module:

import AnimateText from "@pluginjs/animate-text"
import "@pluginjs/animate-text/dist/animate-text.css"

AnimateText.of(document.querySelector('.element'), options)

CommonJS:

require("@pluginjs/animate-text/dist/animate-text.css")
const AnimateText = require("@pluginjs/animate-text")

AnimateText.of(document.querySelector('.element'), options)

Browser:

<link rel="stylesheet" href="https://unpkg.com/@pluginjs/animate-text/dist/animate-text.css">
<script src="https://unpkg.com/@pluginjs/animate-text/dist/animate-text.js"></script>
<script>
  Pj.animateText('.element', options)
</script>

API

Options

Options are called on animateText instances through the animateText options itself. You can also save the instances to variable for further use.

Name Description Default
"mode" Set mode options fadeDown
"loop" Set loop options true
"delay" Set delay options 0
"duration" Set duretion 1000

Events

Events are called on animateText instances through the animateText events itself. You can also save the instances to variable for further use.

Name Description
"ready" Gets fired when plugin has ready
"enable" Gets fired when plugin has enabled
"disable" Gets fired when plugin has disabled
"destroy" Gets fired when plugin has destroy

Methods

Methods are called on animateText instances through the animateText method itself. You can also save the instances to variable for further use.

Name Description
"value" Get value
"enable" Enabled plugin if plugin is disabled
"disable" Disable plugin
"destroy" Destroy plugin
"set" Set value by key

Classes

Name | Description | Default --|| "NAMESPACE" | Declare plugin namespace | as-animateText "CONTAINER" | Declare plugin range | {namespace}-multiple

Browser support

Tested on all major browsers.

IE / EdgeIE / Edge FirefoxFirefox ChromeChrome SafariSafari OperaOpera
IE11, Edge last 2 versions last 2 versions last 2 versions last 2 versions

License

@pluginjs/animate-text is Licensed under the GPL-v3 license.

If you want to use @pluginjs/animate-text project to develop commercial sites, themes, projects, and applications, the Commercial license is the appropriate license. With this option, your source code is kept proprietary.

For purchase an Commercial License, contact us purchase@thecreation.co.

Copyright

Copyright (C) 2022 Creation Studio Limited.

Versions

Current Tags

  • Version
    Downloads (Last 7 Days)
    • Tag
  • 0.8.12
    1
    • latest

Version History

Package Sidebar

Install

npm i @pluginjs/animate-text

Homepage

pluginjs.com

Weekly Downloads

2

Version

0.8.12

License

GPL-3.0

Unpacked Size

201 kB

Total Files

38

Last publish

Collaborators

  • thecreation
  • kaptinlin