anurag87204 / animated-burger

🍔 Animated Tasty Burger Button

Animated Burger

Animated Burger is a lightweight JavaScript library for creating customizable animated burger menu icons. It provides developers with a simple yet powerful way to enhance the user experience by adding animated burger menus to their web applications.

Features

• Customizable: Easily customize the appearance and behavior of the burger menu icon to match your application's design.
• Responsive: Automatically adapts to different screen sizes and orientations, ensuring a consistent user experience across devices.
• Accessible: Built with accessibility in mind, making it easy for all users to interact with the burger menu.
• Easy to Use: Simple API and clear documentation make integration a breeze for developers of all skill levels.

Installation

You can install Animated Burger via npm:

npm install animated-burger Or include it directly in your HTML:

<script src="path/to/animated-burger.js"></script>

Usage

Using Animated Burger is as simple as adding a few lines of code to your HTML:

Then, initialize the burger menu in your JavaScript:

const burger = new AnimatedBurger('burger-icon', { size: 30, color: '#000', speed: 300, animation: 'collapse', });

Documentation

For detailed usage instructions and customization options, please refer to the documentation.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Contributing

Contributions are welcome! Please read the CONTRIBUTING.md file for guidelines.

---

Feel free to adjust the content as needed for your project's specifics!