react-hamburger-menu-component

1.0.3 • Public • Published

React Hamburger Menu Component

A lightweight, customizable React hamburger menu component with sidebar functionality.

Installation

npm install react-hamburger-menu-component

Usage

import HamburgerMenu from 'react-hamburger-menu-component';
import 'react-hamburger-menu-component/dist/index.css';

function App() {
  return (
    <HamburgerMenu
      greeting="Hi User!"
      onToggle={(isOpen) => console.log('Menu is', isOpen ? 'open' : 'closed')}
    >
      <a href="#home">Home</a>
      <a href="#about">About</a>
      <a href="#contact">Contact</a>
    </HamburgerMenu>
  );
}

Props

  • children: React nodes to display in the sidebar
  • greeting: Text/component to display next to the hamburger button
  • onToggle: Callback function called when menu opens/closes
  • className: Additional CSS class for the wrapper
  • hamburgerClassName: Additional CSS class for the hamburger button
  • sidebarClassName: Additional CSS class for the sidebar
  • position: 'left' or 'right' (default: 'left')

Package Sidebar

Install

npm i react-hamburger-menu-component

Weekly Downloads

0

Version

1.0.3

License

MIT

Unpacked Size

18.7 kB

Total Files

8

Last publish

Collaborators

  • kavyathimmegowda