shiny-text
v1.0.1
Published
A component to make your text shine
Downloads
37
Maintainers
Readme
Shining Text
A NPM package to display text that shines
The Shining Text component is a React component that adds a dynamic, animated shine effect to text elements. This effect can enhance the visual appeal of text in your application, making it stand out with a glowing, shifting gradient.
Features
- Dynamic Animation: Customizable shine animation with adjustable duration.
- Customizable Styling: Allows you to set text color, animation duration, and apply additional CSS classes.
- Responsive Design: Adapts to different text sizes and adjusts the shine effect accordingly.
| Prop | Type | Description | Default |
| ----------- | -------- | --------------------------------------------- | ---------------------------- |
| duration
| string
| Duration of the shine animation. | "2s"
|
| textColor
| string
| Color of the text. Supports gradient colors. | "rgba(100, 220, 255, 0.3)"
|
| className
| string
| Custom CSS class name for additional styling. | ""
|
Installation
To use the Shining Text component in your React application, follow these steps:
Install the Component
If published on npm, you can install the component using npm or yarn:
npm install shiny-text # or yarn add shiny-text
Add to Project
Example
<ShiningText duration="3s" textColor="rgba(0, 55, 255,0.6)" className="text-xl">
Shiny Text
</ShiningText>
Support
If you find this project useful and want to support my work, please consider buying me a coffee. Your support is greatly appreciated!