Create a glitch text effect in React
View Demo
·
Report Bug
·
Request Feature
Table of Contents
React Glitch Text is a custom styled component meant to allow developers to easily create a "glitch" effect with any text, easily. It is simply a custom CSS wrapper for a text element.
Utilizing React Glitch Text is incredibly simple. Simply install the package and you can begin using the renderer in any of your components
-
npm
npm install npm@latest -g
-
styled-components
npm install styled-components
- Install the package
npm install @johnn-e/React-Glitch-Text
- In the jsx/tsx file you wish to include the wrapper:
import GlitchText from '@johnn-e/react-glitch-text';
Once the component is imported, you can use it anywhere you'd like like so
function App() {
return (
<>
<GlitchText $text='Glitchy' style={{ color: '#000' }} $colorA="#ffbe0b" $colorB="#123abc" />
</>
);
}
You can use any props that would be available on a HTML Span element. This includes the style
, className
and id
attributes, which allows you to customize the text itself
text
(required) - The text you wish to display
colorA
- The first color of the glitch effect (defaults to magenta)
colorB
- The second color of the glitch effect (defaults to blue)
See the open issues for a full list of proposed features (and known issues).
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.
If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature
) - Commit your Changes (
git commit -m 'Add some AmazingFeature'
) - Push to the Branch (
git push origin feature/AmazingFeature
) - Open a Pull Request
Distributed under the MIT License. See LICENSE.txt
for more information.
Johnny Leek - LinkedIn
Project Link: https://github.com/JohnnyLeek1/React-Glitch-Text