1.0.8 • Published 6 months ago
react-effectz v1.0.8
react-effectz
💭 react effects npm package including some effects in form as components
📋 Requirements
- React 18.2.0 or later
- Node.js 18.0.0 or later
- (for Next.js) Next.js 13.0.0 or later
📦 Installation
npm install react-effectz
# or
yarn add react-effectz
# or
pnpm add react-effectz
# or
bun add react-effectz
📚 Usage
import { GlitchText, FadeInText, BounceText } from "react-effectz";
const App = () => {
return (
<>
<GlitchText text="Hello, World!" className="text-xl" playOnLoop={false} />
<FadeInText text="Welcome to React!" className="text-xl" playOnLoop={true} />
<BounceText text="Let's bounce!" className="text-xl" playOnLoop={true} />
</>
);
};
📖 Documentation
- GlitchText
- FadeInText
- BounceText
Rest will be available soon
GlitchText
import { GlitchText } from "react-effectz";
const App = () => {
return (
<GlitchText text="Hello, World!" className="text-xl" playOnLoop={true} />
);
};
Props
text
(string): Text to apply glitch effect onclassName
(string): Classname to apply on the textplayOnLoop
(boolean): Play the glitch effect on loopduration
(number): Duration of the glitch effect <(soon)>
FadeInText
import { FadeInText } from "react-effectz";
const App = () => {
return (
<FadeInText text="Welcome to React!" className="text-xl" playOnLoop={true} />
);
};
Props
text
(string): Text to apply fade-in effect onclassName
(string): Classname to apply on the textplayOnLoop
(boolean): Play the fade-in effect on loopstyle
(object): Inline styles to apply to the text
BounceText
import { BounceText } from "react-effectz";
const App = () => {
return (
<BounceText text="Let's bounce!" className="text-xl" playOnLoop={true} />
);
};
Props
text
(string): Text to apply bounce effect onclassName
(string): Classname to apply on the textplayOnLoop
(boolean): Play the bounce effect on loopstyle
(object): Inline styles to apply to the text
📚 Examples
You can find examples on how to use the (currently only GlitchText) in the examples
📜 License
Apache-2.0 License © Jonas Franke <@binary-blazer>