1.1.10 • Published 2 years ago

simply_wave v1.1.10

Weekly downloads
-
License
ISC
Repository
github
Last release
2 years ago

Logo

Simply wave

Version

License

Overview

A simple JavaScript package that allows you to add wave effects to your texts and titles in the easiest way possible

Installation

  npm install simply_wave

Demo

npm.io

See the demo and test simply wave

Features

  • wave effects
  • wave mirror effects

Usage ( Classic )

Basic

HTML

<p id="wave">This text wave<p>

JavaScript

import { wave } from "../node_modules/simply_wave/index.js"

const waveOptions = {
    target: "wave",
    animationDelay: 200,
    letterDelay: 20,
    easing: "linear"
}

wave(waveOptions)

React

HTML

<p id="wave">This text wave<p>

JavaScript

import { wave } from "simply_wave"

const waveOptions = {
    target: "wave",
    animationDelay: 200,
    letterDelay: 20,
    easing: "linear"
}

wave(waveOptions)

Vue

HTML

<p id="wave">This text wave<p>

JavaScript

import { wave } from "simply_wave"

export default {
  name: "MyComponent",

  mounted() {
    const waveOptions = {
      target: "wave",
      animationDelay: 200,
      letterDelay: 20,
      easing: "linear"
    }

    wave(waveOptions)
  }
}

Options

Required

ParameterTypeDescriptionUnits
targetstringYour targetHTML id

Optional

ParameterTypeDescriptionValue
transformstringvalue of the letter movementem, rem, px, %
durationnumberanimation duration for each lettersms
animationDelaynumbertime before animation startms
letterDelaynumberletter delay for each lettersms
easingstringlike timing function in CSSease-in / ease-out / ease-in-out / linear / cubic-bezier
iterationsnumber / stringnumber of animation repetitionsstring = Infinity / number = 0 - ∞
fillstringhow the animation finishboth / forwards / backwards / none
directionstringdirection of the animationreverse / alternate / alternate-reverse / normal
opacitybooleanif the letter comme with a fadeboolean
overflowbooleanif the letters appearboolean
mirrorbooleanadd mirror effectboolean
mirrorStylebooleanadd second effect to mirror animationboolean

Usage ( Mirror )

Information

We strongly recommande to use mirror effects with overflow set to false and opacity set to true for a better visual (like the gif).

Possibilities

classic

npm.io

const waveOptions = {
    target: "wave",
    transform: "100%",
    mirror: true,
    mirrorStyle: false
}

rotation

npm.io

const waveOptions = {
    target: "wave",
    transform: "-100%",
    mirror: true,
    mirrorStyle: false
}

overlap

npm.io

const waveOptions = {
    target: "wave",
    transform: "100%",
    mirror: true,
    mirrorStyle: true
}

reverse wave

npm.io

const waveOptions = {
    target: "wave",
    transform: "-100%",
    mirror: true,
    mirrorStyle: true
}

Used By

  • Neza agency - www.neza.fr

Author

Gabriel Voissiere

1.1.10

2 years ago

1.1.9

2 years ago

1.1.8

2 years ago

1.1.7

2 years ago

1.1.6

2 years ago

1.1.5

2 years ago

1.1.4

2 years ago

1.1.3

2 years ago

1.1.2

2 years ago

1.1.1

2 years ago

1.1.0

2 years ago

1.0.22

2 years ago

1.0.21

2 years ago

1.0.20

2 years ago

1.0.19

2 years ago

1.0.18

2 years ago

1.0.17

2 years ago

1.0.16

2 years ago

1.0.15

2 years ago

1.0.14

2 years ago

1.0.13

2 years ago

1.0.12

2 years ago

1.0.11

2 years ago

1.0.10

2 years ago

1.0.9

2 years ago

1.0.8

2 years ago

1.0.7

2 years ago

1.0.6

2 years ago

1.0.5

2 years ago

1.0.4

2 years ago

1.0.3

2 years ago

1.0.2

2 years ago

1.0.1

2 years ago

1.0.0

2 years ago