1.4.0 • Published 6 months ago

react-glitch-image v1.4.0

Weekly downloads
-
License
MIT
Repository
github
Last release
6 months ago

React Glitch Image

Allows display images with a glitch effect

# NPM
npm install --save react-glitch-image
# YARN
yarn add react-glitch-image
    import { GlitchImage } from "react-glitch-image";
    <GlitchImage image="image.jpg"/>

Very simple!

npm.io

Parameters to get complicated (props)!

namedefaultdescription
width20If it is a number it will be used as rem, otherwise use string with unit type
splitSize8Number of divisions
animationInterval4000Time interval to repeat animation (measured in ms)
animationDuration400I really have to describe this (measured in ms)
variations2, 3Intensity of the effect of each layer
insidefalseDefines if the effect is seen outside the container
activeFxOnIntervaltrueActivate the glitch effect in the animationInterval
activeFxOnHovertrueActivate the glitch effect on hover
position
layerColorsfalseAlternate colors in layer 2, better explained below
opacity0.3Layer 2 opacity
filtertrueActivate aleatory hue-rotate filter value and brightness in layer 2
brightness2Brightness filter intensity
customFilternullDeactivate the previous filter for a more personalized filter
onActiveFxnullThis function is executed when the glitch effect is triggered by the interval, and sends the animationDuration
baseImageStyleOnActiveFxnullApply css style on the base image when fx glitch is activated

width

- <GlitchImage image="image.jpg" width={18}/> // =18rem
- <GlitchImage image="image.jpg" width="50%"/> // =50%
- <GlitchImage image="image.jpg" width="300px"/> // =300px

customFilter

This property receives normal filters for css property, however, you can specify a random value for each filter. using $<number> you can indicate the maximum value that will be generated randomly.

Example 1:

  • customFilter="invert($20%)"
  • Generates a random value from 0 to 20

Example 2:

  • customFilter=invert($100%) saturate(100%) hue-rotate($200deg) brightness(2)
  • This generates random values from 0 to 100 for invert, and from 0 to 200 for hue-rotate

Note:

Every time the filter is activated using activeFxOnInterval, this again generates random values for the customFilter, each layer generate a different random

layerColors:

  • Receives an array of colors to alternate on each of the layers 2. Uses true, to set the default color array ["rgba(255,0,0,0.04)", "rgba(0,0,255,0.04)"]

  • This will create a sublayer of the color specified in layer 2, it is recommended to deactivate filter or use a customFilter to get a better and more personalized result.

  • EXAMPLE

    <GlitchImage
        image="image.jpg"
        customFilter="invert($20%) saturate($30%)"
        layerColors={["rgba(0,0,180,0.05)", "rgba(200,0,0,0.05)"]}
    />

npm.io

1.4.0

6 months ago

1.4.0-beta.2

6 months ago

1.4.0-beta.1

6 months ago

1.3.0

11 months ago

1.3.0-beta.0

11 months ago

1.2.3-beta.1

11 months ago

1.2.3-beta.0

2 years ago

1.2.2

2 years ago

1.2.1

2 years ago

1.2.1-beta.0

2 years ago

1.1.1

2 years ago

1.1.0

2 years ago

1.1.0-beta.3

2 years ago

1.1.0-beta.2

2 years ago

1.1.0-beta.1

2 years ago

1.1.0-beta.0

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