spider-banner
v1.6.1
Published
![SpiderbannerImg](Public/spider.jpg)
Downloads
749
Maintainers
Readme
SpiderBanner React Package
SpiderBanner is a lightweight and customizable React component that adds interactive, mouse-responsive animations to your web applications. Perfect for creating modern and engaging banners with animated dots and dynamic connecting lines.
🎉 Features
- Customizable Design: Adjust the number, size, and colors of dots to match your theme.
- Interactive Animations: Dots connect with dynamic lines based on mouse movement.
- Responsive: Adapts seamlessly to different screen sizes.
- Lightweight and Fast: Minimal performance impact.
- Easy Integration: Works with any React project out of the box.
🔗 Links
📦 Installation
Install the package via npm or yarn:
npm install spider-banner-react
# OR
yarn add spider-banner-react
💡 Usage
Here’s an example of how to use the SpiderBanner component in your React project:
import React from 'react';
import SpiderBanner from 'spider-banner-react';
const App = () => {
return (
<SpiderBanner noOfDots={50} colors={['#FF5733', '#33CFFF']} lineLenght={80}>
<h1>Welcome to My Website!</h1>
</SpiderBanner>
);
};
export default App;
Props
| Prop | Type | Default | Description |
|--------------|-----------------|-------------------|----------------------------------------------|
| noOfDots
| number
| 50
| The total number of animated dots. |
| colors
| Array<string>
| ['white', 'black']
| An array of colors for the dots. |
| lineLenght
| number
| 10
| The maximum length of the lines. |
| children
| ReactNode
| null
| Content to display inside the banner. |
📐 Customization
Example with Custom Dots and Colors:
<SpiderBanner
noOfDots={100}
colors={['#FF0000', '#00FF00', '#0000FF']}
lineLenght={100}>
<div>
<h2>Custom Banner</h2>
<p>With colorful, interactive effects!</p>
</div>
</SpiderBanner>
🛠 Development
Run and Test Locally
Fork the repository.
Clone the repository:
git clone https://github.com/{your_username}/spider-banner.git
- Change directory and Install dependencies:
cd spider-banner
npm install
- Build the package:
npm run build
- Link the package Locally
npm link
- Check the linked package locally
npm link spider-banner
- Genrate a pull request
📄 License
This package is licensed under the MIT License. Feel free to use it in personal or commercial projects.
🤝 Contributing
We welcome contributions! If you have ideas or find bugs, feel free to submit issues or pull requests.
🌟 Support
If you find this package helpful, consider giving it a ⭐ on GitHub. Your support means a lot!